WhatsApp Channel

WhatsApp Deployment

Connecting WhatsApp Channel

  1. Select "Channels" at the top menu bar.
  2. Click "+New Channel".
  3. Name your new channel and click "Save".

Create new WhatsApp channel
  1. Select WhatsApp as your deployment platform.

Select WhatsApp
  1. A configuration section will appear once you have selected WhatsApp as the platform.

WhatsApp configuration
  1. Fill in the details of the WhatsApp Server Info.

WhatsApp Server Info
PropertyDescription
WhatsApp Server InfoIf you setup the WhatsApp Business API Client by yourself, find the Admin User Name, Admin Password and API Path. If the WhatsApp Business API Client is set by Sanuker, you should be able to find the credentials on the Google sheet we provide.
API PathYour WhatsApp Business API path is usually in the form of "https://x.x.x.x:9090", make sure you do not put a slash "/" after the end of API Path.
  1. Click "Generate Auth Token" to generate admin access token for further WhatsApp Business API call.

Generate Auth Token

Phone Number & Verification Code

  1. Press "Connect" and a registration window will pop up.

WhatsApp number registration

  1. In step 1, select the correct integrations and phone number that you'd like to connect to the WhatsApp Business API Client.

  2. Select the method to receive verification code:

  • Send code via SMS, or
  • Send code via Phone Call

  1. Fill in the Two step verification Pin if you registered and setup two-step pin before; otherwise leave this part empty.

  2. Wait for the verification code and enter the code in step 2: "Enter Verification Code".

Enter verification code
  1. Click "Send" after you have entered the verification code. If everything works well, a success message will be shown in step 3: "Finish".

Successful registration
  1. Click "Finish" to close the registration window. You should be able to see the registered phone number info under section "Connect" now.

Connected to WhatsApp (Sanuker demo screenshot)

Webhook Setup Tool

  1. Click "Set Webhook" if you use Stella to build your chatbots.

Set Webhook

  1. If you are going to use your own Webhook, skip step 15 and set up your own Webhook on WhatsApp Web Business Tool with the following steps 17 to 19.

  2. Go to your WhatsApp Web Business Tool. Click "Application Settings".

  3. Enter you own Webhook URL in "Webhooks URL", scroll down to the bottom and click "Save".

Application settings
  1. A success message will pop up to confirm your changes are saved.

Webhook set successfully

Health Check Tool

  1. Click "Check Health Status" to check the server status. It should show "Connected" if things are properly set.

Health check tool

Adding Trees & Global Nodes

Add trees and global nodes in the channel
  1. Add the specific trees and global nodes that you would like to include in the WhatsApp channel. You can add multiple trees and global nodes into one channel.

Templated Message Submission

In order to send Templated Messages on WhatsApp, you must first submit the message content to WhatsApp team for approval. You can only send approved templates.

  1. Click "Message Template" in your WhatsApp channel.

The Message Template section

  1. You will see the overview of message templates under your WABA. Select the correct WABA integration.

  2. Click "Create" to create a new message template. A new window will pop up.

Create message templates pop-up

  1. Fill in the necessary details of this message template. You may see more about Message Templates on WhatsApp documentation.

  2. Click "Submit" to submit your message template. Once submitted, a new row will be created.

Submitted template

Template Details

PropertyDescription
NameCan only contain lowercase alphanumeric characters and underscores ( _ ); No other characters or white space are allowed
CategorySelect the correct category of your template; See list of supported categories
LanguageSelect the correct language of your template; The template name will be the same for all translations; You will specify the language field when sending out the template; See list of supported languages
ContentThe content of your message template

Remarks:

  • You can fill in parameter placeholders in the format of {{1}}.
  • You should create all translations of the same content under the same message template.
  • You may click "+ New Language" to add multiple translations under the same template content.

Example Template

Creating an order confirmation message where the message template name is order_confirmation and the message is:

Your order {{1}} for a total of {{2}} is confirmed. The expected delivery is {{3}}.

Submission Status

The submission result generally will be ready within 1 day. Here are the submission status:

  • Yellow: Pending from approval
  • Red: Rejected
  • Green: Approved
  • Light Grey: Pending to delete
  • Dark Grey: Deleted

The status circle will automatically turn into Green once the message template is approved.

← Web ChatWeChat →