Updated at January 7th, 2025
Cirrus facilitates activities in WABA for the clients. Our platform helps clients create new templates and manage existing ones.
Opt-in for WhatsApp
Before sending WhatsApp messages to someone, you must first receive opt-in permission confirming that they wish to receive future messages from you on WhatsApp. This can be done using any channel your business uses to communicate with people — your website, app, email, retail location, etc.
The opt-in must be an active opt-in, which means it must be triggered by a user action, such as entering a phone number or checking a box to indicate consent.
The opt-in must clearly state your business’ name.
Clear opt-in messaging so that the customers know what type(s) of messaging they are signing up for.
For more information, please visit: https://developers.facebook.com/docs/whatsapp/guides/opt-in/
POST: Send WhatsApp Templated Message V2
This API sends a generated WhatsApp template from the WhatsApp Business Account (WABA) to a single recipient or to multiple recipients (up to 20).
Key New Capabilities of V2 version
Marketing and Utility Templates may have a header with text or added media (attached document, image, or video), a footer, and a call for action or quick reply buttons.
The API can also create Cirrus object(s), support Subchannels, and enable scheduled publishing.
Send Templated Message + Object data
Sending any templated WhatsApp message with Object data also creates a conversation (Object) on the Cirrus platform.
The required and optional fields are described here: https://www.commbox.io/api/#operation/Create_Object
Send Templated Message with an Attached File
There are two ways to do so:
Sending a Templated Message with a link to the file. Example below: 'Send a template with an attachment (doc)'.
OR
Use the /whatsapp/uploadmedia/{ENCRYPTED_STREAM_ID} API endpoint to upload the file to WhatsApp servers and then fetch the uploaded file ID from the response for sending a templated message with the attachment ID. See the 'Send a template with an attachment ID (video)' example.
POST /whatsapp/sendtemplatedmessage/{ENCRYPTED_STREAM_ID}
path Parameters
|
ENCRYPTED_STREAM_ID required
|
string
Cirrus generated encryption for the channel |
Request Body schema: application/json
Schema not provided
Response Schema: application/json
| status | string
|
||||||||
| description | string
|
||||||||
| response_time | string
|
||||||||
Array of objects
|
|||||||||
Array
| |||||||||
POST: Recieve WhatsApp ID for an uploaded file
This API returns the name of an uploaded file (doc/image/video) and the generated ID for it. The ID can then be used in any requests to retrieve the media stored in the WhatsApp Business API client.
path Parameters
|
ENCRYPTED_STREAM_ID required
|
string
Cirrus generated encryption for the channel |
Request Body schema: multipart/form-data
| pic | string <binary> |
Response Schema: application/json
| status | string
|
||||
| description | string
|
||||
| response_time | string
|
||||
Array of objects
|
|||||
Array
| |||||
GET: Validate WhatsApp account
As a business, you must provide customers with the option to opt in and receive WhatsApp communications, as well as stating your business name in a clear opt-in flow process.
After the customer opts in, use the contacts node to validate the registered number.
For more information, visit: https://developers.facebook.com/docs/whatsapp/guides/opt-in/
Note: Checking too many phone numbers without sending them messages will lead to WA banning you.
Only verify phone numbers critical to your business that you have already received opt-in for.
https://api.commbox.io/whatsapp/validatecontact/{ENCRYPTED_STREAM_ID}/{PHONE_NUMBER}
path Parameters
|
ENCRYPTED_STREAM_ID required
|
string
Cirrus generated encryption for the channel |
|
PHONE_NUMBER required
|
integer <int64>
Valid PHONE_NUMBER |
Response Schema: application/json
| status | string
|
||
| description | string
|
||
| response_time | string
|
||
object
|
|||
| |||
