WhatsApp Channel
WhatsApp Deployment
Connecting WhatsApp Channel
- Select "Channels" at the top menu bar.
- Click "+New Channel".
- Name your new channel and click "Save".
- Select WhatsApp as your deployment platform.
- A configuration section will appear once you have selected WhatsApp as the platform.
- Fill in the details of the WhatsApp Server Info.
| Property | Description |
|---|---|
| WhatsApp Server Info | If 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 Path | Your 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. |
- Click "Generate Auth Token" to generate admin access token for further WhatsApp Business API call.
Phone Number & Verification Code
- Press "Connect" and a registration window will pop up.
In step 1, select the correct integrations and phone number that you'd like to connect to the WhatsApp Business API Client.
Select the method to receive verification code:
- Send code via SMS, or
- Send code via Phone Call
Fill in the Two step verification Pin if you registered and setup two-step pin before; otherwise leave this part empty.
Wait for the verification code and enter the code in step 2: "Enter Verification Code".
- Click "Send" after you have entered the verification code. If everything works well, a success message will be shown in step 3: "Finish".
- Click "Finish" to close the registration window. You should be able to see the registered phone number info under section "Connect" now.
Webhook Setup Tool
- Click "Set Webhook" if you use Stella to build your chatbots.
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.
Go to your WhatsApp Web Business Tool. Click "Application Settings".
Enter you own Webhook URL in "Webhooks URL", scroll down to the bottom and click "Save".
- A success message will pop up to confirm your changes are saved.
Health Check Tool
- Click "Check Health Status" to check the server status. It should show "Connected" if things are properly set.
Adding Trees & Global Nodes
- 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.
WhatsApp Profile Setup
You can personalize your WhatsApp Business Profile via Stella. Follow the steps below to update your profile.
Profile Photo
- Click "Upload Profile Photo"
The photo will be scaled and cropped into a square with a max edge of 640px and max size of 5MB before uploading.
- If you have uploaded a profile photo before, please click "Select File" instead.
Profile: About
- Describe your business or WhatsApp Account in "About".
Character limit for Profile: About is 139 characters.
- Click "Update Your Profile About".
Business Profile Settings
- Complete the "Business Profile Settings" accordingly:
| Name | Description | Remarks |
|---|---|---|
| Business Description | Describe your business. | Character limit: 256, Optional |
| Contact Email | Provide your company email address. | Optional |
| Business Category | Choose the closest industry in the drop down list. | Optional |
| Website 1 | Provide your 1st company website url. | Optional |
| Website 2 | Provide your 2nd company website url. | Optional |
- Click "Update Your Profile".
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.
- Click "Message Template" in your WhatsApp channel.
You will see the overview of message templates under your WABA. Select the correct WABA integration.
Click "Create" to create a new message template. A new window will pop up.
Fill in the necessary details of this message template. You may check out the example template or theWhatsApp documentation. For any media or text with parameters
{{1}}, you are required to add sample as part of the review process.Click "Submit" to submit your message template. Once submitted, a new row will be created.
Template Details
| Property | Description | Required? |
|---|---|---|
| Name | Can only contain lowercase alphanumeric characters and underscores ( _ ); No other characters or white space are allowed | Y |
| Category | Select the correct category of your template; See list of supported categories | Y |
| Language | Select 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 | Y |
| Content | The content of your message template; Support parameter placeholders in the format of {{1}} | Y |
| Header | The header of your message template; It can be a text or media: "Image", "Video", "Document" | N |
| Body | The body of your message template | Y |
| Footer | The text footer of your message template | N |
| Buttons | The button(s) of your message template; Call-to-action or Quick Reply; 3 buttons max. | N |
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}}.
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.
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.