- WhatsApp Business Cloud
- Set Up WhatsApp Cloud API
- Create Permanent Access Token
- Add your own phone number to WhatsApp Business Cloud API
- Connect WhatsApp Business Cloud to Boost.space Integrator
- Message
- Media
- Phone Number
- Business Profile
- Setting up WhatsApp Business Cloud webhooks
- Add Recipient's Phone Number
- Troubleshooting the WhatsApp Business Cloud
| Active |
|---|
| This application does not need additional settings. So you can make connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). More only by using your login credentials or by following the instructions below . |
![[Important]](https://bs-docs2.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/important.png)
With WhatsApp Business Cloud modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More in Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. More IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. More, you can:
-
watch events, send a message, and templateTemplates are predefined scenarios that you can expand and customize to create new scenarios. You can then share these with friends and colleagues. More messages
-
upload and download media
-
enable two-step verification, register, verify, and deregister senders
-
retrieve and update business profiles
![[Caution]](https://bs-docs2.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/caution.png) |
Caution |
|---|---|
|
Please note that it is not possible to use the phone number registered in the WhatsApp Business app or your personal WhatsApp number, which you use for communicating with friends and family. You will need a separate dedicated phone number for the API. For more information, please refer to the Could API documentation. |
To get started with WhatsApp Business Cloud, you need:
-
A Facebook Developer account
-
A valid mobile phone number.
![[Note]](https://bs-docs2.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png)
Note Before you begin, understand the following information about the phone numbers:
-
The phone number should not be registered with your personal WhatsApp account which you use to communicate with your friends and family. If already registered, delete the existing account on your mobile to register with WhatsApp Business Cloud.
-
You cannot use the same phone number simultaneously on both on-premise and Cloud API at the same time. Only one platform is supported at a time with the phone number. See overview and phone numbers.
-
Do not infringe the WhatsApp Terms and Conditions: “If you use anything other than the official WhatsApp Business Platform or other official WhatsApp tools, We reserve the right to limit or remove your access to WhatsApp as this violates our policies. Please do not use any non-WhatsApp authorized third-party tools to communicate on WhatsApp. See Unauthorized use of automated or bulk messaging on WhatsApp for more information”.
-
To connect WhatsApp Cloud API to Boost.space Integrator involves the following steps:
To set up WhatsApp Cloud API:
-
Log in to your Facebook account.
-
Go to the Facebook Developer Site, click My Apps > Create App.
-
Select Business as the app type. Click Next.
-
Enter the display name and select the business account. Click Create app.
-
When prompted, re-enter the password of your Facebook account. Click Submit.
The app is created.
-
On the app’s Dashboard, scroll down to find the WhatsApp app, and click Set up.
-
Select the account type, and click Continue.
-
Copy the WhatsApp Business Account ID to a safe place.
To create a permanent access tokenThe API token is a multi-digit code that allows a user to authenticate with cloud applications. More for your WhatsApp Business Cloud account:
-
Log in to your Facebook Developer Account.
-
Click Apps Dashboard > Business Settings.
-
Go to System UsersCan use the system on a limited basis based on the rights assigned by the admin. More > Add. Enter the username, select the role as AdminAdmins in Boost.space have exclusive access to system settings. They manage the overall system setup, including appearance, language, currency, user settings, and the availability of individual modules to users and teams. More and clickCreate System UserCan use the system on a limited basis based on the rights assigned by the admin. More.
-
Go to Add Assets > Apps. Select the app you want to assign to the user, enable Full Control access, and click Save Changes.
-
Go to WhatsApp Accounts > Add People > Select the system user > Enable Full Control Access > Assign.
-
Go to System Users > Select the user > Generate Access Token.
-
Select the app, following permissions, and then click Generate Token.
-
whatsapp_business_messaging -
whatsapp_business_management
-
-
Copy the token to a safe place.
You can use this token as a permanent access token.
When you set up WhatsApp API, a test number is created for you. You can add your own number.
-
Log in to your Facebook developer account.
-
On the Getting Started page, click Add phone number.
-
Enter your business profile details and click Next.
-
Enter the business phone number that you want to connect to WhatsApp Business API.
Note Ensure that the phone number is not registered with WhatsApp before. If already registered, delete your WhatsApp account with the number before registering here.
-
Enter the verification code received on your phone number.
-
Enter your business details and click Save.
To connect WhatsApp Business Cloud with Boost.space Integrator you need to obtain the Permanent Token and WhatsApp Business Account ID values from your WhatsApp Business Cloud account.
-
In your Facebook developer account:
-
Log in to your Boost.space Integrator account, and add a moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More from the WhatsApp Business Cloud app into a Boost.space Integrator scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. More.
-
Click Add next to the Connection field.
-
In the Connection name field, enter a name for the connection.
-
In the Permanent Token field, enter the token created prior to the connection.
You can also use a temporary token which is only valid for 24 hours and available on the getting started screen.
Note Boost.space Integrator recommends using the temporary token for testing purposes as it is valid only for 24 hours and you will lose your data once the token expires.
-
In the WhatsApp Business Account ID field, enter the ID from your Facebook Developer account > WhatsApp > Getting Started section screen, and click Save.
You can watch events, and send messages using the following modules.
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a new message is received.
|
WebhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. name |
Enter a name for the webhook. |
|||
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
|||
|
Verify Token |
Enter the Temporary Access Token from the WhatsApp Getting Started section or the permanent token.
|
|||
|
Events |
Select or map the events which you do not wish to watch. |
See Setting up WhatsApp Business Cloud webhooks to add webhooks to your account.
Sends a message.
|
Note |
|---|---|
|
You can send a message using this module if you satisfy the below conditions:
|
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
|||
|
Sender ID |
Select or map the Sender ID from which you want to send the message. |
|||
|
Receiver |
Enter the receiver’s WhatsApp ID or phone number.
|
|||
|
Message Type |
Select the message type. For example, Based on the selection, dynamic fields auto-populate, and you need to enter the details to send the message. For more details on these dynamic fields, see WhatsApp Business Cloud Messages API documentation. |
For any errorsService is unavailable due to a failure, a service responds with unexpected data or the validation of input data fails. More, while sending the messages, see Troubleshooting the WhatsApp Business Cloud.
Sends a template message.
|
Note |
|---|---|
|
Your business phone number must be first approved by WhatsApp before you use it for sending messages. |
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
|||
|
Sender ID |
Select or map the Sender ID from which you want to send the template message. |
|||
|
Receiver |
Enter the receiver’s WhatsApp ID or phone number in any dialable format.
|
|||
|
Message Template |
Select or map the message template you want to send. |
You can upload and download media using the following modules.
Uploads a media and retrieves its ID.
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
||||
|
Sender ID |
Select or map the ID of a sender whose media you want to upload. |
||||
|
File |
Enter the file details:
|
Downloads a media by its ID.
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
|
Media ID |
Enter the Media ID you want to download. |
You can enable two-step verification, register, verify, and deregister senders using the following modules.
Activates the two-step verification for a sender number by its ID and a 6-digit pin.
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
|
Sender ID |
Select or map a Sender ID whose two-step verification you want to enable. |
|
PIN |
Enter (map) a 6-digit pin you wish to use for two-step authentication. To disable or reset two-step verification, see the WhatsApp Business Cloud documentation. |
Registers a sender by its ID and a 6-digit pin.
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
|
Sender ID |
Select or map a Sender ID whom you want to register. |
|
PIN |
Enter (map) a 6-digit pin you wish to use for registration. To disable or reset two-step verification, see the WhatsApp Business Cloud documentation. |
Verifies a sender by its ID.
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
|
Sender ID |
Select or map a Sender ID whom you want to verify. |
|
Action |
Select the action you want to perform to verify the sender:
|
|
By |
Select a method for receiving the code:
|
|
Code |
Enter (map) the code received to complete the verification. |
Deregisters a sender by its ID.
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
|
Sender ID |
Select or map a Sender ID of a sender to deregister. |
You can retrieve and update business profiles using the following modules.
Retrieves the details of the WhatsApp business profile by the sender ID.
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
|
Sender ID |
Select or map the Sender ID whose business profile you want to retrieve. |
Updates a WhatsApp business profile by the sender ID.
|
Connection |
Establish a connection to your WhatsApp Business Cloud account. |
||||
|
Sender ID |
Select or map the Sender ID whose business profile you want to update. |
||||
|
Address |
Enter the address of the business. |
||||
|
Description |
Enter the business details. |
||||
|
Vertical |
Select or map the industry of the business. For example, |
||||
|
|
Enter the contact email address of the business. |
||||
|
Websites |
Add the business website URL address. For example, a website, Facebook Page, or Instagram. You must include the |
||||
|
File |
Enter (map) the file details:
|
-
Log in to your Boost.space Integrator account.
Open the Watch Events module, enter a name for the webhook, click Save, and copy the URL address to your clipboard. Click OK and Save the triggerEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the....
-
Go to App Dashboard, click Webhooks > Subscribe to this object to enable the webhooks.
-
When prompted enter the Callback URL copied in step 1 and the Verify token.
The verify token is the Temporary access token or permanent access token but it has to be same in the Boost.space Integrator and WhatsApp account.
For more information on webhooks, see the WhatsApp Business Cloud documentation.
If you are using a testing number to send messages you must add the recipients to your WhatsApp account in the Facebook Developer account. You can add a maximum of five recipients’ numbers that are enabled with WhatsApp.
To add the recipient’s phone number:
Some of the errors that you might encounter when using WhatsApp Business Cloud.
The user gets an errorService is unavailable due to a failure, a service responds with unexpected data or the validation of input data fails. More 500 from the module and the DevTool > Response Body shows error code 131000.
|
Note |
|---|---|
|
You can only initiate new chats via Send a Template module. Only after sending a templated message to a specific customer and receiving a response from the customer, you can use this Send a Message module to send a non-templated message to the customer. |
If you’re using a testing number, you must first register up to five authorized recipient numbers in WhatsApp ManagerCan manage members and space managers, view and manage items. Can modify space settings. More before sending messages to them. See Add Recipient’s Phone Number.