> ## 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 through WeChat

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

## Overview

Answer messages to a verified WeChat Service Account with a Voiceflow agent through Sinch Conversation API. Sinch owns the WeChat callback and encryption; your relay receives signed Sinch callbacks and sends the agent’s text replies through the same account.

<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). |
| WeChat account | A verified Service Account with full API access and administrator access to its Official Accounts Platform. |
| Sinch account | A funded Conversation API project, an app in `CONVERSATION` processing mode, its region and project API credentials. |
| Eligibility | Confirm Sinch can onboard your legal entity and region before building. Its current setup documentation specifies a Chinese legal business entity for the verified-account route. |
| 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. Prepare the Service Account

In [WeChat Official Accounts Platform](https://mp.weixin.qq.com/), confirm that **Type** is Service Account and its verification is complete. Subscription accounts, Work/WeCom accounts and an ordinary personal account are not this setup. Obtain administrator approval for the API connection.

### 2. Configure Sinch and WeChat together

Create a Conversation API app in [Sinch Build Dashboard](https://dashboard.sinch.com/) and set its processing mode explicitly to **CONVERSATION** so callbacks have contact and conversation IDs. Open **Set up channels → WeChat**.

In WeChat’s **Basic configuration**, copy **Developer ID (AppID)** and **Developer Password (AppSecret)** into Sinch’s matching fields. Open **Change Configuration** and generate a Token and EncodingAESKey if needed. Enter the same Token and AES key in Sinch. Save the Sinch channel, then copy the callback URL it displays into WeChat’s **URL** field. Select **Security Mode**, submit the WeChat configuration and enable it.

Sinch, rather than this relay, verifies/decrypts the WeChat-side callback and owns its prompt acknowledgment. Do not paste your relay URL into WeChat: it accepts signed Sinch JSON, not WeChat XML. See [Sinch’s account and configuration requirements](https://developers.sinch.com/docs/conversation/channel-support/wechat/set-up).

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

## Run the relay

Configure and host the supplied executable example.

Use the [configuration file](/docs/examples/messaging/wechat.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=wechat
SINCH_PROJECT_ID=YOUR_SINCH_PROJECT_ID
SINCH_APP_ID=YOUR_CONVERSATION_APP_ID
SINCH_REGION=us
SINCH_KEY_ID=YOUR_SINCH_KEY_ID
SINCH_KEY_SECRET=YOUR_SINCH_KEY_SECRET
SINCH_WEBHOOK_SECRET=YOUR_RANDOM_WEBHOOK_SECRET
```

### 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.

### 1. Register the Sinch webhook

In the Sinch app, add a Conversation API webhook targeting `https://YOUR_HOST/webhook`. Select **MESSAGE_INBOUND** and **MESSAGE_DELIVERY**, set a secret matching `SINCH_WEBHOOK_SECRET`, and save it. Keep the WeChat callback URL configured to Sinch’s adapter. These are two separate webhook registrations.

### 2. Check the callback contract

The relay checks the timestamp and verifies the base64 HMAC-SHA256 of `raw-body.nonce.timestamp` using Sinch’s `x-sinch-webhook-signature-*` headers. It requires the configured project and app IDs. A webhook without the secret cannot pass validation. Sinch retries temporary connection, `5xx` and `429` failures; ordinary `4xx` rejections are not generally retried. See [Sinch callbacks](https://developers.sinch.com/docs/conversation/callbacks).

Save a test callback privately and confirm `direction: TO_APP`, `channel_identity.channel: WECHAT`, nonempty `contact_id` and `conversation_id`. Empty IDs usually mean the app is still in Dispatch mode.

<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 | Sinch app + conversation ID + contact ID. WeChat identities are app-scoped; do not merge them by nickname. |
| Incoming text | `message.contact_message.text_message.text` on a verified `TO_APP` WeChat callback. |
| Visible reply | POST `https://YOUR_REGION.conversation.api.sinch.com/v1/projects/{project-id}/messages:send` with app ID, contact ID, text and `channel_priority_order: [WECHAT]`. |
| Duplicate and status | Deduplicate `message.id`; keep delivery reports separate from customer turns. |

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.

Sinch documents a 48-hour window after the customer’s last message and a limit of 20 ordinary messages to that person during the window. This sample answers immediately, uses 500-character chunks, and has no template-message route. Keep replies brief and check the provider’s remaining allowance; the sample does not maintain a distributed account-wide quota counter. See [WeChat message support](https://developers.sinch.com/docs/conversation/channel-support/wechat/message-support).

Sinch’s send response confirms acceptance, not handset delivery. Inspect delivery callbacks for rejection, account eligibility or expired-window errors. Other WeChat products and direct XML/API integrations have different setup and are not implemented here.

**Note:** 

**Direct WeChat integration:** A direct developer connection would need its own verification, XML/AES handling, access-token lifecycle and reply strategy. That alternative is not supplied by this walkthrough. [Chat agents](/docs/api-reference/agent-runtime/chat) documents the Voiceflow side only.

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

## Test a customer conversation

Verify the reply in the destination you installed.

### 1. Send a real platform message

Scan the Service Account’s QR code in WeChat, follow the account and send your prepared text question. Expect an agent reply from that Service Account.

### 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

Check a real inbound message, rather than only the follow/opt-in callback. Confirm the contact and conversation IDs survive a follow-up and that a duplicate signed Sinch fixture does not run the agent twice.

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.

Compare the WeChat AppID, secret, Token, AES key and Security Mode with the saved Sinch channel. Check that WeChat points to Sinch, while Sinch points to your relay. Confirm Conversation mode, channel eligibility and the ordinary-message allowance.

### 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

Have the account administrator confirm verification and regional eligibility with Sinch. Use the production app and credentials, verify both callback registrations and test on an authorized WeChat device. Any provider review or commercial activation remains a prerequisite.

### 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.
