How do I configure a WeChat channel on the Conversation API?

To configure the WeChat social messaging channel, you need information from your WeChat Official Accounts Platform. Therefore, you will need to create a WeChat Official Account before you start. You also need to have created (but not yet configured) a WeChat channel on your Conversation API app.

Note: For more information on how to create a channel on your Conversation API app, refer to How to configure a new channel in your Conversation API App and complete steps 1 through 4. If you do not have the ability to create a WeChat channel, contact your Sinch account manager to request access.

Open both the WeChat channel Configuration page in the Sinch Customer Dashboard and the Basic configuration page in the WeChat Official Accounts Platform. Keep the windows side by side so that you can easily copy and paste between them.

1. On the Configuration page for the WeChat channel in the Sinch Customer Dashboard, copy the IP address listed and paste it in to the IP whitelist in the Basic configuration section of the WeChat Official Accounts Platform.

2. On the same Basic configuration page, you’ll find the Developer ID and Developer Password:

   Copy and paste these values into the appropriate fields on the Sinch Customer Dashboard WeChat channel Configuration page. Then, click Change Configuration on the WeChat Official Accounts Platform Basic configuration page.

   Note: You may have to click Reset to generate a new Developer Password.

3. The Fill in server configurations page is displayed:

   On this page, you’ll find the URL field, Token field, EncodingAESKey field, and Message Encryption Method options.

4. Populate and copy the Token and EncodingAESKey values and paste them into the appropriate fields on the Sinch Customer Dashboard WeChat channel Configuration page.

   Note: You may use the Random Generation button to generate a random AES key.

5. Set the Message Encryption Method to Security Mode.
6. On the WeChat channel Configuration page in the Sinch Customer Dashboard, click Save. Copy the Callback URL displayed on the Sinch Customer Dashboard and paste it into the URL field of the Fill in server configurations page.
7. Click Submit on the Fill in server configurations page.

Learn more

The Sinch Developer Documentation site contains comprehensive documentation and tutorials, which show you how we support WeChat through the Sinch Conversation API.