WeChat

WeChat is a Chinese multi-purpose messaging, social media and mobile payment app. With over 1 billion monthly active users, it’s the most popular chat app for Chinese-speaking people. WeChat’s social commerce platform enables users to transact with businesses for things like booking a taxi, a flight, or a doctor’s appointment. It’s like Facebook, Skype, Slack, Amazon, PayPal, and Apple Wallet all rolled up into one.

Capabilities

WeChat supports a wide variety of capabilities as seen in the channel capabilities grid. Below is a detailed view of each capability.

Content Types

  • Text

    Full SupportAPI
  • Image

    Full SupportAPI
  • File

    Partial SupportAPI
  • Emoji

    Full SupportAPI
  • GIF

    Partial SupportAPI
  • Location

    Partial SupportAPI

Action Types

  • Link

    Full SupportAPI
  • Extension

    Partial SupportAPI
  • Postback

    Partial SupportAPI
  • Reply

    Partial SupportAPI
  • Location Request

    Partial SupportAPI

Structured Messages

  • Compound Message

    Partial SupportAPI
  • Carousel

    Partial SupportAPI

Indicators

  • Typing

    Partial SupportAPI
  • Conversation Start

    Full SupportAPI

Delivery Events

Delivery events allow you to track deliveries of Sunshine Conversations messages to WeChat by subscribing to the conversation:message:delivery:channel webhook. Failures to deliver a message to WeChat can be detected by subscribing to the conversation:message:delivery:failure webhook.

Configuring WeChat

In order to configure WeChat, you’ll need a WeChat Official Account. WeChat supports both service and subscription accounts. We recommend selecting a “Service Account” to integrate with Sunshine Conversations. You can register here.

Once you’ve created your account, you must verify your account.

  1. Log in to the WeChat Official Accounts Platform
  2. Under the Set Up section, click “WeChat Certification | 微信认证”.
  3. Follow the instructions.

Reintegrating WeChat

If you already have WeChat integrated with Sunshine Conversations, you’ll need to delete your channel and re-integrate it. Your account must have Zendesk messaging or Agent Workspace with social messaging, or a standalone license through Sunshine Conversations directly, to do this.

To delete your channel and re-integrate it:

  1. In the Sunshine Conversations dashboard, click the app where WeChat is integrated.
  2. In the App window, click Configure next to the WeChat channel.
  3. Click Remove integration and then click Remove to confirm.
  4. Open the app where you want to integrate WeChat and click Connect Integrations.
  5. Click Customer Channels in the sidebar and then click WeChat.
  6. Click Connect.
  7. In the WeChat integration window, click Authenticate to WeChat. A QR code appears.
  8. Scan the QR code using WeChat on your Android or iPhone device. You must be logged in as the admin of your WeChat account on your mobile device.

    1. Open the WeChat app on your mobile phone.
    2. Tap the plus (+) sign located in the top navigation bar.
    3. Click the scan icon to scan the QR code.
    4. Point your mobile phone’s camera at the QR code. The QR code is valid for 10 minutes.
  9. You’ll see a WeChat confirmation page in your WeChat mobile app. Click the green button to let Sunshine Conversations manage your WeChat messages. After you confirm from your mobile device, your browser will automatically be redirected back to the Channels page.
  10. (optional) In the WeChat channel details window, enter a unique name for this channel. It may take a few seconds for the WeChat channel details window to reappear.
  11. Click Save changes.

Canceling authorization

If you delete and re-integrate WeChat, you must also unauthorize the Sunshine Conversations third-party platform in your WeChat account. Otherwise, Sunshine Conversations may still receive messages on behalf of your Official Account.

To unauthorize Sunshine Conversations:

  1. Log in to the WeChat Official Accounts Platform
  2. Under Setup and develop in the sidebar, click Official account settings, and then click the Authorization tab.
  3. Click View platform details next to the Sunshine Conversations platform name you want to unauthorize.
  4. Click Cancel authorization.

Persistent Menu

WeChat Persistent Menu

It’s possible to configure a menu on the WeChat UI by calling the Sunshine Conversations REST API. WeChat allows up to two levels of menu hierarchy and they can contain 1 to 3 menu items at its first level and 1 to 5 menu items for a submenu. Menus are configured per app or per integration, not per user. Menu items can be link, postback or submenu type actions.