> ## Documentation Index
> Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect a Voiceflow agent to Viber

> Connect Viber to a Voiceflow text agent. Configure the platform, host the relay, test replies and prepare release.

## Overview

Answer private messages to a Rakuten Viber bot with a Voiceflow agent. This walkthrough uses the Bot API, a commercially provisioned bot and your own signed-webhook relay.

<a id="before-you-begin"></a>

## Before you begin

Collect the agent, account and host access.

| Requirement | Obtain before installation |
| --- | --- |
| Voiceflow owner | An existing agent with a known support answer, a private project API key, project ID and reviewed Environment alias. [Build the agent](/docs/documentation/build/overview) first, then [publish the intended release](/docs/documentation/deploy/environments/publishing). |
| Commercial bot | An active bot provisioned under Rakuten Viber’s commercial terms; new bot creation requires an application and commercial agreement. |
| Administrator | A bot administrator with the app key and bot ID; this is separate from Viber Business Messages sender provisioning. |
| Relay operator | A Node.js host, public HTTPS hostname, private secrets and persistent disk; an operator who can investigate paused conversations. |

The example provides public-policy text support. Keep private Voiceflow and platform credentials on the host; a customer’s messaging identity does not authorize access to orders or account records. Have the agent return text only and provide a support route in its instructions. Buttons, audio and Handoff traces need additional adapters; see [Adapt agent replies](/docs/guides/channels/messaging/adapt-agent-replies).

<a id="create-platform-app"></a>

## Prepare the platform account

Create the exact app or account this relay will use.

### 1. Apply for and provision the bot

Apply through [Rakuten Viber’s bot program](https://developers.viber.com/docs/api/rest-bot-api/). Complete the commercial onboarding before implementing a public destination. You need an active Viber administrator account and an active bot; a personal Viber account alone does not expose this API.

### 2. Collect the app key and bot identity

As a bot administrator, copy the app key from **More → Settings → Bots → Edit Info → Your app key**, or the Viber Admin Panel where available. Save it as `VIBER_BOT_TOKEN`. Call `get_account_info` and retain the returned bot ID:

```js
// identity.mjs — node --env-file=.env identity.mjs
import { request } from './core.mjs';
const info = await request('https://chatapi.viber.com/pa/get_account_info', {
  headers: { 'X-Viber-Auth-Token': process.env.VIBER_BOT_TOKEN }, body: {}
});
console.log({ id: info.id, uri: info.uri });
```

Use `id` as `VIBER_BOT_ID` and retain the bot’s entry URI for testing. Check the name and identity against the commercial account you intended to provision.

<a id="run-relay"></a>

## Run the relay

Configure and host the supplied executable example.

Use the [configuration file](/docs/examples/messaging/viber.env.example) for this platform. Every name below is read by the supplied artifact; IDs identify the resources prepared above. `VF_ENVIRONMENT` is the Environment alias, not a version label pasted from another project.

```dotenv
VF_API_KEY=YOUR_PRIVATE_VOICEFLOW_PROJECT_KEY
VF_PROJECT_ID=YOUR_VOICEFLOW_PROJECT_ID
VF_ENVIRONMENT=YOUR_ENVIRONMENT_ALIAS
DATA_DIR=/var/lib/voiceflow-messaging
PORT=8080
PLATFORM=viber
VIBER_BOT_TOKEN=YOUR_VIBER_APP_KEY
VIBER_BOT_ID=YOUR_BOT_ACCOUNT_ID
VIBER_BOT_NAME=Support
```

### 1. Download and configure the relay

On a Linux host you administer, create `/opt/voiceflow-messaging` and extract the [relay archive](/docs/examples/messaging/messaging-relay.zip) there. Use Node.js 22.12 or later. Run `node --test fixtures.test.mjs` first: it generates signed synthetic events and mocks all remote calls, without credentials or live messages. Save the configuration above as `.env`, replacing every `YOUR_` value; restrict it to the service account with `chmod 600 .env`. Set `DATA_DIR` to a private persistent directory that this account can write.

The archive includes `core.mjs`, platform adapters, HTTP/Teams entry points, local fixture tests and a package manifest. Run `node --env-file=.env relay.mjs serve`. The HTTP relay uses only Node built-ins; it does not need `npm install`.

### 2. Expose the HTTPS endpoint

Point your own DNS hostname to the host. Terminate HTTPS with a valid public certificate and proxy to `127.0.0.1:8080`. For example, with [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) installed:

```sh
caddy reverse-proxy --from support.example.com --to 127.0.0.1:8080
```

Replace the example hostname, allow inbound 80/443 for certificate provisioning and keep the relay port private. Use a separate hostname and credentials for testing. Confirm `https://YOUR_HOST/health` returns `ok` before registering `/webhook`.

### 3. Keep one process running

After the foreground check, stop it and create a service using the unit below. Keep one process and one writable data directory per installation. Do not run this file store on ephemeral serverless storage or start multiple replicas.

```ini
# /etc/systemd/system/voiceflow-messaging.service
[Unit]
Description=Voiceflow messaging relay
After=network-online.target

[Service]
User=relay
WorkingDirectory=/opt/voiceflow-messaging
ExecStart=/usr/bin/node --env-file=.env relay.mjs serve
Restart=on-failure
UMask=0077

[Install]
WantedBy=multi-user.target
```

Create the non-login `relay` service user, give it read access to the application and `.env`, and ownership of `/var/lib/voiceflow-messaging`. Confirm `/usr/bin/node --version` is 22.12 or later, or substitute your actual Node path. Then run `sudo systemctl daemon-reload` and `sudo systemctl enable --now voiceflow-messaging`. Expect the service to stay active; keep the HTTPS proxy running through its own service.

The file store is a small single-process starting point. Back it up privately and monitor disk space, queue age and failures. Higher traffic needs a transactional inbox/outbox and per-conversation workers before adding replicas. Session keys and customer text are stored in the data directory; apply your retention and access policy there as well as in Voiceflow.

<a id="register-events"></a>

## Register incoming events

Connect the platform to your hosted endpoint.

After the relay is reachable, save `register.mjs`, add `PUBLIC_URL=https://YOUR_HOST` to `.env`, and run `node --env-file=.env register.mjs`:

```js
import { request } from './core.mjs';
const e = process.env;
console.log(await request('https://chatapi.viber.com/pa/set_webhook', {
  headers: { 'X-Viber-Auth-Token': e.VIBER_BOT_TOKEN }, body: {
    url: `${e.PUBLIC_URL}/webhook`,
    event_types: ['delivered', 'seen', 'failed', 'subscribed', 'unsubscribed'],
    send_name: false, send_photo: false
  }
}));
```

Viber calls the endpoint to check availability. Expect `status: 0`. The relay validates `X-Viber-Content-Signature` using the bot token as its HMAC-SHA256 key and acknowledges validation/control events without running Voiceflow. Use a public certificate; self-signed certificates are not supported. See the [Bot API webhook contract](https://developers.viber.com/docs/api/rest-bot-api/).

<a id="conversation-routing"></a>

## Route conversations and replies

Keep the customer, agent session and reply destination aligned.

| Stage | Mapping in the example |
| --- | --- |
| Customer identity | Bot account ID + incoming `sender.id`, used as `receiver` on the reply. |
| Incoming text | `event: message` and `message.type: text`; other message types receive a text notice. |
| Visible reply | POST `/pa/send_message` with `X-Viber-Auth-Token`, `receiver`, sender name and text. |
| Duplicate and status | Deduplicate `message_token` without converting its 64-bit value to a JavaScript number; delivery/seen/failed callbacks are receipts. |

The relay hashes platform, destination account, customer/thread, project and Environment into a bounded Voiceflow `userID`. It creates a session with the private project key, stores the returned `sessionKey`, launches once, then sends `{ action: { type: "text", payload: text } }` to `/v4/interact`. Text traces become platform replies. Follow-ups reuse the key; starting a session every message would reset the conversation.

This recipe responds to customer messages. It does not send a welcome message on `conversation_started` or initiate unsolicited contact. A subscription or permitted user interaction must support your messaging use; an unsubscribed user may be unreachable.

Non-200 callbacks can be redelivered, so keep the original message token across retries. Viber uses numeric status codes in otherwise successful HTTP responses; `status: 0` means API acceptance. Later `failed` callbacks must still be investigated. The sample uses smaller text chunks than the API’s text maximum and records accepted chunks before proceeding.

<a id="test-conversation"></a>

## Test a customer conversation

Verify the reply in the destination you installed.

### 1. Send a real platform message

Open the bot’s approved Viber entry link on a test device, subscribe/start the conversation and send your support question. Expect a reply from that bot in the same chat.

### 2. Check continuity and isolation

Ask a related follow-up, then test with a second authorized customer. Confirm the intended Voiceflow project and exchange in [Transcripts](/docs/documentation/measure/transcripts). Run `node --env-file=.env relay.mjs inspect` while the service is stopped to compare event IDs, conversation keys and completion states without printing session tokens.

### 3. Check this platform’s delivery behavior

Replay an authorized signed fixture whose `message_token` exceeds JavaScript’s safe integer range. The deduplication key must retain all digits and generate one turn.

A saved callback, accepted API request or successful Voiceflow Run does not prove this platform conversation. Keep local signed-fixture tests separate from this authenticated customer test.

<a id="troubleshooting" />

### The callback saves but no reply arrives

Check platform access as well as endpoint connectivity.

Check commercial activation, the app key, valid HTTPS certificate and bot entry URI. Inspect both the send response’s numeric status and later failed callbacks; HTTP 200 alone is insufficient.

### A conversation is paused or a reply is duplicated

Reconcile remote effects before resuming the saved job.

Inspect the event’s `phase`, `failedDuring`, saved traces and accepted chunks in the private data file. A runtime timeout can occur after a tool action; a send timeout can occur after the platform accepted the message. The sample pauses that conversation and does not retry either effect automatically. Follow [Recover failed messages](/docs/guides/channels/messaging/recover-failed-messages), then repeat the platform test.

<a id="go-live"></a>

## Release and maintain the connection

Promote the tested route and keep recovery available.

### 1. Approve the production destination

Confirm commercial activation and the approved customer entry link, deploy the reviewed bot credentials, then repeat the Viber test from an authorized subscriber. Honor unsubscribe and provider restrictions in any later outbound feature.

### 2. Release the reviewed agent

Have the Voiceflow owner publish the tested agent to the intended Environment. Deploy that alias and production credentials to the relay, restart its service and repeat the [customer test](#test-conversation) with a fresh customer/session. Existing session keys are not an automatic migration to a new release. Keep the previous deployment and state backup available for rollback.

### Rotate, update or disconnect

Maintain both the provider registration and the relay state.

Stop the service before changing `.env` or running maintenance commands. Rotate the platform credentials using its administrator controls, update the secret file and restart. If a webhook secret changes, update both sides and check a real event. For a release change, drain or reconcile pending jobs first; do not erase the state file to resolve a delivery problem.

To disconnect, disable/remove this callback or uninstall this app in the provider, stop the relay and revoke its unused credentials. Confirm no new events arrive and retain/delete customer state according to your policy. Keep the registration details needed to reconnect. See [Pause automated replies](/docs/guides/channels/messaging/pause-automated-replies) for a temporary conversation-specific pause.
