This knowledge base will soon be replaced with https://help.sangoma.com/.
To ensure continued access to our resources, update your bookmarks or links to https://help.sangoma.com/.



Sangoma CX Technical Note: Sangoma CX and WhatsApp Support

Edited: 11/28/2023
Access: Everyone
Supports: Business Voice, Business Voice+

Technical Note: Sangoma CX and WhatsApp Support

Index

Setup your WhatsApp channel with WhatsApp Cloud API

Prerequisites​

Sangoma CX Tier

Configure your Facebook Developer App​

Configure a system user for your Facebook Business Manager​

Setup WhatsApp Inbox in Sangoma CX

Enable the webhook​

Additional Inbox settings​

Supported media types​

FAQ​

Validating Whatsapp API Key​

 

Setup your WhatsApp channel with WhatsApp Cloud API

Sangoma CX supports the official WhatsApp Business API. You can connect the phone number and start managing your WhatsApp customer queries from the Sangoma CX Agent Panel. Follow the steps below to enable your WhatsApp inbox with WhatsApp Cloud API.

Prerequisites​

Sangoma CX Tier

This feature is part of the omnichannel capabilities only available in the Sangoma CX Premium Tier. You can review the tier enabled in your tenant by clicking the name associated with the logged user in the upper right corner on the Sangoma CX portal.

Missing image link-1

If you want to upgrade your current tier to enable this capability, please get in contact with your Sangoma Partner or a Sangoma Sales Representative.

Configure your Facebook Developer App​

First, you need to create your Facebook Developer app, with “WhatsApp Product enabled”. Go to the WhatsApp Cloud API Guide and follow the instructructions including Step 3.

Once you finish this step, you have at least a phone number in the “WhatsApp'' section of your Facebook developer app. If you completed the steps successfully, you should be able to obtain the “Phone Number ID” and “Whatsapp Business Account ID” as shown in the below screenshot. Sangoma CX will require these values for creating the WhatsApp Inbox.

Missing image link-2

Please note the phone numbers provided by Facebook at this time are for testing purposes only. To add a real business number you will need to follow the instructions in step 5 in the WhatsApp Cloud API Guide

Configure a system user for your Facebook Business Manager​

Create a system user in your Business Manager with access to the WhatsApp App. Generate an access token for the user, which will be required as the API key for setting up an inbox in Sangoma CX.

When generating the access token, make sure the “whatsapp_business_management”, and “whatsapp_business_messaging permissions” are selected.

  1. Create a system user in the System Users tab of Business Manager.
  1. Add the system user. Under the WhatsApp Accounts tab, select “Add People” and select the system user to grant access to the WhatsApp Business account.

Missing image link-3

  1. Generate the access token and request permissions.

Missing image link-4

Refer to this video for detailed steps.

Setup WhatsApp Inbox in Sangoma CX

  1. Login in the Sangoma CX portal with a user that has privileges to create inboxes and click in the menu: Contact Center > Management > Digital Channels > Inboxes. The following screen will be displayed.

Missing image link-5

  1. Click the “CREATE INBOX” button and select WhatsApp

Missing image link-6

  1. Fill in the appropriate details.

Values

Description

Name

Choose a name for your Inbox. Ex: Your Business Name

Phone Number

Fill in the phone number you have configured in Facebook Developer App

Phone Number ID

The phone number ID for the number as obtained in prerequisites

Business Account ID

The Business Account ID for the number as obtained in prerequisites

API Key

The Business Account User's access token for the number as obtained in prerequisites

This information is available in the WhatsApp > API Setup Screen App you previously created in https://developers.facebook.com/apps/.

Missing image link-7

  1. Click on the “CREATE” button. A window will pop-up providing the following information: “Webhook Verify Token” and “Whatsapp Webhook Callback URL”. Copy this information before closing this window. This information is required by Facebook Developer App to make this integration work.Missing image link-8

The WhatsApp Inbox won't be ready until configuring the “Webhook Verify Token” and “Whatsapp Webhook Callback URL” in Facebook Developer App is completed. Please review the section “Enable the webhook” that details how to configure the settings.

Enable the webhook​

To configure the webhook in Facebook Developer App follow these steps

  1. Head back to the “WhatsApp” section in the Facebook Developer App. Navigate to the “Configuration” subsection and click “Edit” button set up the “Callback URL” and “Verify Token”

Missing image link-9

  1. Paste the Callback URL and Verified token provided by Sangoma CX when creating the WhatsApp Inbox and click the “Verify and save” button.Missing image link-10
  1. The application must subscribe to message fields events under Webhooks Fields on your Facebook Developer App. To configure the setting, click the “Manage” button.Missing image link-11
  1. Scroll down and enable the subscribe checkbox for “Messages” and click the “Done” button.Missing image link-12
  1. Once you finish all the steps, the configuration screen should look like the following.Missing image link-13

Additional Inbox settings​

Your freshly configured WhatsApp inbox should now appear in your list of inboxes. The Inbox Contact Information column will display the WhatsApp Phone number.

The following changes can be done when editing this inbox:

  • Under the General tab:
  • Name: Inbox name
  • Greeting Message: First message provided to the customer when initiating a conversation with this inbox.
  • Under Agents tab:
  • Provides the ability to assign and unassign agents to the inbox. Alternatively Agents can be assigned or unassigned to queues and inboxes through the Agent editing screens.

Please note, editing the Inbox won’t allow changing the WhatsApp integration settings. If these need to change you will need to create a new WhatsApp inbox.

Supported media types​

Supported extensions

End User

Agent Panel

Audio

 

 

audio/aac

Supported

Supported

audio/mp4

Supported

Supported

audio/mpeg

Supported

Supported

audio/amr

Supported

Supported

audio/ogg

Supported

Supported

Document

 

 

text/plain

Supported

Supported

application/pdf

Supported

Supported

application/vnd.ms-powerpoint

Supported

Supported

application/msword

Supported

Supported

application/vnd.ms-excel

Supported

Supported

application/vnd.openxmlformats-officedocument.wordprocessingml.document

Supported

Supported

application/vnd.openxmlformats-officedocument.presentationml.presentation

Supported

Supported

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Supported

Supported

Image

 

 

image/jpeg

Supported

Supported

image/png

Supported

Supported

Video

 

 

video/mp4

Supported

Supported

video/3gp

Supported

Not Supported

Sticker

 

 

image/webp

Supported

Not

supported

FAQ​

Validating Whatsapp API Key​

Sangoma CX internally validates a WhatsApp key with the following GET API call:

GET https://graph.facebook.com/v14.0/business_account_id/message_templates?access_token=api_key

To test the key, make the above API call and check for any errors.

up
6 users have voted.

Technical Support

If you have any technical questions or need to get in touch with Tech Support, please email us at service@sangoma.com to open a ticket.

Customers With Disabilities

Sangoma values its customers with disabilities. If you are in need of assistance with a Sangoma service or feature, please email service@sangoma.com.

Website Suggestion

Do you have a suggestion about our Knowledge Base website, let us know?