Introduction - WhatsApp API Documentation
WhatsApp Business is a new way for businesses to better manage such conversations with their customers and also reach new customers who will also value the fast, convenient and private messaging experience.
With the WhatsApp Business API with Chatbot Ghana, you can reach more than 1.5 billion WhatsApp users.
This guide provides specifications of the our Messaging API for WhatsApp Business for the purpose of sending and receiving messages on WhatsApp via a simple REST API through HTTP/HTTPS modes.
Click here to login or sign up into your API Dashboard
Annexure
Here are some few concepts that you know before using the Chatbot Ghana WhatsApp API.
SandBox
A testing environment for our WhatsApp Business to test bots before going live.
Number Format
Chatbot Ghana WhatsApp API supports numbers in E.164 Format. To read more, visit here
API Key
Our Messaging API authenticates your account with your assigned and unique API Key.
CallBack URL or Webhook
HTTP callbacks invoked by specific events such as inbound messages from your customers and can be forwared directly to your applications.
Session Messaging
Session Messages are messages or conversations initiated by customers. Messages can be used to respond to queries or sent as private messages. WhatsApp allows businesses to reply to users within 24 hours of the user's last message with session messaging.
Template Messaging
Template Messages are messages or conversations initiated by businesses and can be sent to customers at any time. Messages can be used to send OTPs, delivery notifications, reminders, and other transactional notifications. WhatsApp allows businesses to send templates messages to only users who have opted in to receive notifications from the business.
Opt-In
WhatsApp mandates you get a voluntary consent from your users to send them template messages.
Opt-Out
WhatsApp mandates you provide mechanisms for your users to opt out anytime to stop receiving notifications from your business.
Inbound or Incoming Messages
These are messages received or forwarded to your callback url (webhook) when a customer sends you a message.
Outbound or Outgoing Messages
These are messages sent from your WhatsApp Business to your customers.
CallBack URL / Wehbhook
Wehbhooks handle incoming messages from your customers. Chatbot Ghana forwards any specific event that happens on your applicaton to your callback url provided. It is highly recommended to set a callback url for your application as it provides you with essential application logs.
To set callback for your application, send an email to support@chatbotsghana.com and include your application name and callback url in the content.
Inbound Messages & Events
Here are 3 types of events forwarded to your callback URL
1. User-Events
This events is received when a callback url is set on your application or user opts in to receive notifications from your business.
Payload Object
Key | Type | Description | Example |
---|---|---|---|
phone | string | Phone number of the customer who sent the message | 233x3x90x0 |
type | string | The types of user-events received are sandbox-start,opted-in,opted-out | Find Below |
Type | Description | Sample |
---|---|---|
sandbox-start | This event is received when your application is in sandbox mode with a callback url configured | {"app":"myApp","timestamp":***,"type":"user-event","payload":{"phone":"****","type":"sandbox-start"}} |
opted-in | This event is received when an end user opt-in to receive notification from a business | {"app":"myApp","timestamp":***,"type":"user-event","payload":{"phone":"****","type":"opted-in} |
opted-out | This event is received when an end user opt-out from receiving notification from a business | {"app":"myApp","timestamp":***,"type":"user-event","payload":{"phone":"****","type":"opt-out}} |
2. Message-Events
This events informs you about the status of the messages sent between you and your customers. The event forwards notifications to your callback on messages sent, delivered, read and failed.
Payload Object
Type | Description | Sample |
---|---|---|
enqueued | Message successfully sent to WhatsApp Business API Client | {"app":"myApp","timestamp":"**","type":"message-event""payload":{"id":"59f8db90***","type":"enqueued","destination":"233**","payload":{"whatsappMessageId":"gBEGkY**","type":"session"}}} |
failed | Message failed to send. Check Failure Code table for reasons. Reasons for failure may be included in the callback url as well. | {"app":"myApp","timestamp":"**","type":"message-event""payload":{"id":"59f8db90***","type":"failed","destination":"233**","payload":{"whatsappMessageId":"gBEGkY**","type":"session"}}} |
sent | Message deliverd to the end user. | {"app":"myApp","timestamp":"**","type":"message-event""payload":{"id":"59f8db90***","type":"sent","destination":"233**","payload":{"whatsappMessageId":"gBEGkY**","type":"session"}}} |
delivered | Message deliverd to the user's device | {"app":"myApp","timestamp":"**","type":"message-event""payload":{"id":"59f8db90***","type":"delivered","destination":"233**","payload":{"whatsappMessageId":"gBEGkY**","type":"session"}}} |
read | Message read by user. This option is only available for users that have read receipts enabled. | {"app":"myApp","timestamp":"**","type":"message-event""payload":{"id":"59f8db90***","type":"read","destination":"233**","payload":{"whatsappMessageId":"gBEGkY**","type":"session"}}} |
3. Inbound or Incoming Messages
This events is received on your callback when customers send a message to your WhatsApp Business Number.
Headers
Content-Type - application/json
Incoming Payload Body
Key | Type | Description | Example |
---|---|---|---|
app | string | The name of your application receiving the message | myApp |
timestamp | string | The time in unix timestamp when the message was sent by the customer and received by Chatbot Ghana | 1584898839530 |
version | string | Callback Payload Version | 2 |
type | string | Inbound events | message |
payload | object | Payload object contains the inbound message from the customer | See payload object documentation below |
sender | object | Sender object contains the inbound message sender details | See sender object documentation below |
context | object | Context object contains the original message WhatsApp and Chatbot Ghana id details | See context object documentation below |
Payload Object
Key | Type | Description | Example |
---|---|---|---|
id | string | Unique Chatbot Ghana message identifier for the inbound message | FHds888FVIDOWjflOOOW190GG |
source | string | Phone number of the customer who sent the message | 233XXXXXXX |
type | string | Type of message received from the customer. Type could be one of these: text ,image ,video ,location |
Hello There!! |
payload | object | The payload object contains the inbound message content sent by the customer | See message type documentation below for each. |
Sender Object
Key | Type | Description | Example |
---|---|---|---|
phone | string | Phone number of the customer who sent the message | 233XXXXXXX |
name | string | WhatsApp ame of the customer who sent the message | James Bond |
country_code | string | Sender's country code | 233 |
dial_code | string | Sender's dial code | 5011XXXXX |
Context Object
Key | Type | Description | Example |
---|---|---|---|
id | string | Unique WhatsApp message identifier for the inbound message | gBEGkYaYVSEEAgnPFrOLcjkFjL8 |
gsId | string | Unique Chatbot Ghana message identifier for the inbound message | FHds888FVIDOWjflOOOW190GG |
Message Payload
Sample Payload When Customer Sends a Text Message to your WhatsApp Business Number
{
"app": "myApp",
"timestamp": 1580227766370,
"version": 2,
"type": "message",
"payload": {
"id": "ABEGkYaYVSEEAhAL3SLAWwHKeKrt6s3FKB0c",
"source": "233XXXXXX44",
"type": "text",
"payload": {
"text": "Hi There !!"
},
"sender": {
"phone": "233XXXXXXX",
"name": "James Bond",
"country_code": "233",
"dial_code": "5011XXXXX"
}
}
}
Payload When Customer Sends an Image to your WhatsApp Business Number
{
"app": "myApp",
"timestamp": 1580227766370,
"version": 2,
"type": "message",
"payload": {
"id": "ABEGkYaYVSEEAhAE0dyndiP9cVlr4hC5xU64",
"source": "233XXXXXX44",
"type": "image",
"payload": {
"caption": "Sample image",
"url": "https://chatbotsghana.com/sm/api/media/546af999-825e-485b-bf54-4a3323824cca",
"urlExpiry": 1580832695997
},
"sender": {
"phone": "233XXXXXXX",
"name": "James Bond",
"country_code": "233",
"dial_code": "5011XXXXX"
}
}
}
Payload When Customer Sends an Audio to your WhatsApp Business Number
{
"app": "myApp",
"timestamp": 1580227766370,
"version": 2,
"type": "message",
"payload": {
"id": "ABEGkYaYVSEEAhAE0dyndiP9cVlr4hC5xU64",
"source": "233XXXXXX44",
"type": "audio",
"payload": {
"url": "https://chatbotsghana.com/sm/api/media/546af999-825e-485b-bf54-4a3323824cca",
"urlExpiry": 1580832695997
},
"sender": {
"phone": "233XXXXXXX",
"name": "James Bond",
"country_code": "233",
"dial_code": "5011XXXXX"
}
}
}
Payload When Customer Sends a video to your WhatsApp Business Number
{
"app": "myApp",
"timestamp": 1580227766370,
"version": 2,
"type": "message",
"payload": {
"id": "ABEGkYaYVSEEAhAE0dyndiP9cVlr4hC5xU64",
"source": "233XXXXXX44",
"type": "video",
"payload": {
"caption": "Tom and Jerry"
"url": "https://chatbotsghana.com/sm/api/media/546af999-825e-485b-bf54-4a3323824cca",
"urlExpiry": 1580832695997
},
"sender": {
"phone": "233XXXXXXX",
"name": "James Bond",
"country_code": "233",
"dial_code": "5011XXXXX"
}
}
}
Payload When Customer Sends a Document to your WhatsApp Business Number
{
"app": "myApp",
"timestamp": 1580227766370,
"version": 2,
"type": "message",
"payload": {
"id": "ABEGkYaYVSEEAhAE0dyndiP9cVlr4hC5xU64",
"source": "233XXXXXX44",
"type": "video",
"payload": {
"caption": "Users.pdf"
"url": "https://chatbotsghana.com/sm/api/media/546af999-825e-485b-bf54-4a3323824cca",
"urlExpiry": 1580832695997
},
"sender": {
"phone": "233XXXXXXX",
"name": "James Bond",
"country_code": "233",
"dial_code": "5011XXXXX"
}
}
}
Payload When Customer Sends a Location to your WhatsApp Business Number
{
"app": "myApp",
"timestamp": 1580227766370,
"version": 2,
"type": "message",
"payload": {
"id": "ABEGkYaYVSEEAhAE0dyndiP9cVlr4hC5xU64",
"source": "233XXXXXX44",
"type": "location",
"payload": {
"longitude": "72.8552172",
"latitude": "19.1453658"
},
"sender": {
"phone": "233XXXXXXX",
"name": "James Bond",
"country_code": "233",
"dial_code": "5011XXXXX"
}
}
}
Outbound or Outgoing Messages
These are messages sent from your application to the end user or your customers
Send Template Messages
A text message can be max of 4096 characters long.
To include a URL preview in the message and make sure the URL begins with http:// or https://.
A URL to be previewed: hostname is required, IP addresses will not be considered.
HTTP Request
POST https://api.chatbotsghana.com/api/send/text/msg/template
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
sender | Yes | string | Your WhatsApp Business Phone Number |
destination | Yes | string | The phone number of the recipient to whom message is being sent. |
botname | Yes | string | The name of your application or bot. |
message | Yes | string | Message content |
Send Text Messages (Session)
A text message can be max of 4096 characters long.
To include a URL preview in the message and make sure the URL begins with http:// or https://.
A URL to be previewed: hostname is required, IP addresses will not be considered.
HTTP Request
POST https://api.chatbotsghana.com/api/send/text/msg
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
sender | Yes | string | Your WhatsApp Business Phone Number |
destination | Yes | string | The phone number of the recipient to whom message is being sent. |
botname | Yes | string | The name of your application or bot. |
message | Yes | string | Message content |
Send Image Message
Supported Content-Types: image/jpeg, image/png
Maximum file size: 5 MB
HTTP Request
POST https://api.chatbotsghana.com/api/send/image/msg
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
sender | Yes | string | Your WhatsApp Business Phone Number |
destination | Yes | string | The phone number of the recipient to whom message is being sent. |
botname | Yes | string | The name of your application or bot. |
imageURL | Yes | string | The public URL of the hosted image eg. https://chatbotsghana.com/whatsapp/media/sample/jpg/logo.jpg |
caption | No | string | Attach caption to your image |
Send Document / File Message
Supported Content-Types: Any valid MIME-type
Maximum file size: 100 MB
HTTP Request
POST https://api.chatbotsghana.com/api/send/file/msg
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
sender | Yes | string | Your WhatsApp Business Phone Number |
destination | Yes | string | The phone number of the recipient to whom message is being sent. |
botname | Yes | string | The name of your application or bot. |
fileURL | Yes | string | Path to your file |
filename | Yes | string | Your file name |
Send Audio Message
Supported Content-Types: audio/aac, audio/mp4, audio/amr, audio/mpeg, audio/ogg; codecs=opus. Note: The base audio/ogg type is not supported.
Maximum file size: 16 MB
HTTP Request
POST https://api.chatbotsghana.com/api/send/audio/msg
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
sender | Yes | string | Your WhatsApp Business Phone Number |
destination | Yes | string | The phone number of the recipient to whom message is being sent. |
botname | Yes | string | The name of your application or bot. |
audioURL | Yes | string | Path to your audio file |
Send Video Message
Supported Content-Types: video/mp4, video/3gpp. Note: Only H.264 video codec and AAC audio codec is supported.
Maximum file size: 16 MB
HTTP Request
POST https://api.chabotsghana.com/api/send/video/msg
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
sender | Yes | string | Your WhatsApp Business Phone Number |
destination | Yes | string | The phone number of the recipient to whom message is being sent. |
botname | Yes | string | The name of your application or bot. |
videoURL | Yes | string | Path to your video file |
caption | No | string | Attach caption to your video file |
Send Location Message
HTTP Request
POST https://api.chatbotsghana.com/api/send/location/msg
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
sender | Yes | string | Your WhatsApp Business Phone Number |
destination | Yes | string | The phone number of the recipient to whom message is being sent. |
botname | Yes | string | The name of your application or bot. |
latitude | Yes | string | Latitude |
longitude | Yes | string | Longitude |
name | Yes | string | Name of the place |
address | Yes | string | Postal Address |
Send List Message
Messages including a menu of up to 10 options. This type of message offers a simpler and more consistent way for users to make a selection when interacting with a business. Below is a sample payload for sending list messages to your end-user.
HTTP Request
POST https://api.chatbotsghana.com/api/send/list/msg
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
sender | Yes | string | Your WhatsApp Business Phone Number |
destination | Yes | string | The phone number of the recipient to whom message is being sent. |
botname | Yes | string | The name of your application or bot. |
message | Yes | object | Find below message object Description |
Message Object Payload
Parameter | Required | Type | Description |
---|---|---|---|
type | Yes | string | This content should be list |
title | Yes | string | Text for the header. Maximum of 60 characters. Formatting allows emojis, but not markdown |
body | Yes | string | The body content of the message can be maximum of 1024 characters. Emojis and markdown are supported. Links are supported. |
msgid | No | string | Its a developer defined message id for a specific list message. This id will be received with the message-event when the customer replies to that specific list message. |
globalButtons | Yes | array | Although its an array, only 1 Global button can be added to the list. |
items | Yes | array | Element in this array are sections in the list. There is a minimum of 1 and maximum of 10 elements in the list |
Example of List Messaging Request
Sample Payload When Customer Sends a Text Message to your WhatsApp Business Number
{
$apiKey = 'your api_key',
$sender = 'your bot number'
$destination = XXXXXXXXX,
$botname = 'your bot name',
$message = {
"type": "list",
"title": "Data Networks",
"body": "Choose one of the below",
"msgid": "list1",
"globalButtons": [
{
"type": "text",
"title": "Main Menu"
}
],
"items": [
{
"title": "Choose From The Menu",
"subtitle": "Firs Subtitle",
"options": [
{
"type": "text",
"title": "Chatbot Ghana",
"postbackText": "1"
},
{
"type": "text",
"title": "Chatbot Africa",
"postbackText": "2"
},
]
}
]
};
}
globalButtons array description
Parameter | Required | Type | Description |
---|---|---|---|
type | Yes | string | Only text is supported |
title | Yes | string | The title of the global button. It cannot be an empty string and must be unique within the message. Maximum of 20 characters. Does not allow emojis or markdown. |
items array description
Parameter | Required | Type | Description |
---|---|---|---|
title | Yes | string | Only text is supported |
options | Yes | array |
type: text(It's the only type supported) title: section 1 row 1 - (It's the title of the item in the list. Maximum length: 24 characters) description: section 1 row 1 (Optional. It's the description of the item in the list. Maximum length: 72 characters) postbackText: section 1 row 1 postback payload (Optional. It's the custom payload that a developer can receive when a particular item in the list is submitted by the customer.) |
Send Quick Replies
This type of message offers a quicker way for users to make a selection from a menu when interacting with a business. Reply buttons have the same user experience as interactive templates with buttons. Below is a sample payload when sending Quick replies message to end-users on WhatsApp.
HTTP Request
POST https://api.chatbotsghana.com/api/send/quick_reply/msg
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
sender | Yes | string | Your WhatsApp Business Phone Number |
destination | Yes | string | The phone number of the recipient to whom message is being sent. |
botname | Yes | string | The name of your application or bot. |
message | Yes | object | Find below message object Description |
Message Object Payload
Parameter | Required | Type | Description |
---|---|---|---|
type | Yes | string | This content should be quick_reply |
msgid | No | string | Its a developer defined message id for a specific list message. This id will be received with the message-event when the customer replies to that specific list message. |
content | Yes | object | Quick replies message body supports - "text" | "image" | "video" | "document". The content object is used to define the Quick replies message body payload. |
Content Object Payload
Quick replies message body supports - "text" | "image" | "video" | "document". The content object is used to define the Quick replies message body payload
In addition to this we have caption property which is common in the content object and it indicates the footer. The header is an addition to Quick reply messages
- For type: text, The Header is optional, maximum characters allowed - 20.
- The parameter type, that represents the type of the message and the parameter text, that represents the body of the message are mandatory.
- The Caption which is the footer, is optional, maximum characters allowed - 60.
Parameter | Type | Example |
---|---|---|
type | text | {"type":"text", "header":"this is the header", "text":"this is the body", "caption":"this is the footer"} |
type | image | {"type":"image", "url":"https://chatbotsghana.com/image/africa.jpg", "text":"this is the body", "caption":"this is the footer"} |
type | document | {"type": "file", "url": "https://chatbotsghana.com/pdf/africa.pdf", "text":"this is the body", "filename": "Sample file", "caption":"this is the footer"} |
type | video | {"type": "video", "url":"https://chatbotsghana.com/video/africa.mp4", "text":"this is the body", "caption":"Sample Video File"} |
Quick Replies Option array description
Parameter | Required | Type | Description |
---|---|---|---|
type | Yes | string | Describes the button type. Current supported type is text postback |
Yes | string | Button title. It cannot be an empty string and it must be unique within the message. Maximum of 20 characters. Does not allow emojis or markdown. |
Example of Text Payload - Quick Replies Messaging Request
{
$apiKey = 'your api_key',
$sender = 'your bot number'
$destination = XXXXXXXXX,
$botname = 'your bot name',
$message = {
"type": "quick_reply",
"msgid": "qr1",
"content": {
"type": "text",
"header":"this is the header",
"text": "Yes",
"caption":"this is the footer"
},
"options": [
{
"type": "text",
"header":"this is the header",
"title": "No",
"caption":"this is the footer"
},
{
"type": "text",
"header":"this is the header",
"title": "Back",
"caption":"this is the footer"
}
]
};
}
Example of Media Payload - Quick Replies Messaging Request
{
$apiKey = 'your api_key',
$sender = 'your bot number'
$destination = XXXXXXXXX,
$botname = 'your bot name',
$message = {
"type": "quick_reply",
"msgid": "qr1",
"content": {
"type": "image",
"url":"https://chatbotsghana.com/image/africa.jpg",
"text": "Yes",
"caption":"this is the footer"
},
"options": [
{
"type": "text",
"header":"this is the header",
"title": "No",
"caption":"this is the footer"
},
{
"type": "text",
"header":"this is the header",
"title": "Back",
"caption":"this is the footer"
}
]
};
}
Opt-In User
HTTP Request
POST https://api.Chatbot Ghana.com/api/opt/in
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
destination | Yes | string | The phone number of the recipient to opt in. |
botname | Yes | string | The name of your application or bot. |
Opt-Out User
HTTP Request
POST https://api.chatbotsghana.com/api/opt/out
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
destination | Yes | string | The phone number of the recipient to opt out. |
botname | Yes | string | The name of your application or bot. |
List Of Users
This API will help you get a list of all the users interacted with your business phone number and their opt-in status
HTTP Request
POST https://api.chatbotsghana.com/api/opt/users
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
destination | Yes | string | The phone number of the recipient to opt out. |
botname | Yes | string | The name of your application or bot. |
API Dashboard
Click here to login or sign up into your API Dashboard
Template Messages
View the list of templates you can use while sending out template messages. These are approved by WhatsApp for your app.
You can register your templates messages here.
Status | Template | Example |
---|---|---|
Status Update | The status of {{1}} has been updated to {{2}}. | The status of [your delivery #230498] has been updated to [dispatched]. |
Feedback | Please provide feedback for {{1}} by clicking on {{2}}. | Please provide feedback for [your today's OLA trip with Mr. XXX] by clicking on [gs.im/123SKeS]. |
OTP | Your OTP for {{1}} is {{2}}. This is valid for {{3}}. | Your OTP for [adding Anil as a payee] is [1234]. This is valid for [15 minutes]. |
Transactions | {{1}} debited with {{2}} on {{3}} for {{4}}. | [Your Bank ac ending with 1245] debited with [Rs. 10000] on [11-Jan-2011] for [ATM cash withdrawal]. |
Points | Your {{1}} points will expire on {{2}}. | Your [100] points will expire on [31 Dec]. |
Service Update | {{1}} will be unavailable from {{2}} to {{3}} on account of {{4}}. | [Online banking] will be unavailable from [14:00] to [16:00 on 2 oct] on account of [planned maintenance]. |
Plain Text | I'm sorry that I wasn't able to respond to your concerns yesterday but I’m happy to assist you now. If you’d like to continue this discussion, please reply with ‘yes’ | |
Reminders | Your {{1}} is due by {{2}}. Please {{3}}. | Your [electrcity bill] is due by [12 Jan]. Please [click on gs.im/ask34RT to pay]. |
Transactions | Your bill for {{1}} with amount {{2}} has been generated. | Your bill for [mobile no 9xxxx xxxxx] with amount [240] has been generated. |
MISC | Your {{1}} is pending. Please {{2}} by clicking on {{3}}. | Your [Service feed] is pending. Please [complete it] by clicking on [gs.im/adlkf]. |
Get Template List
HTTP Request
POST https://api.chatbotsghana.com/api/template/list
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
botname | Yes | string | The name of your application or bot. |
Template Interactive Messaging
HTTP Request
POST https://api.chatbotsghana.com/api/template/interactive/msg
To register a template with interactive buttons, find an example here:
You can now view your Account Balance or Mini statement for Account ending with {{1}} simply by selecting one of the options below. | [View Account Balance] | [Print Account Balance]
URL Parameters
Parameter | Required | Type | Description |
---|---|---|---|
apikey | Yes | string | Your Chatbot Ghana api key |
sender | Yes | string | Your WhatsApp Business Phone Number |
destination | Yes | string | The phone number of the recipient to whom message is being sent. |
botname | Yes | string | The name of your application or bot. |
templateId | Yes | string | Id of your template created |
placeholder | Yes | string |
Eg. Your OTP code is {{1}}. Enter {{2}} to proceed. Placeholder should be an array. eg. ["1997", "balance"] Your OTP code is 1997. Enter balance to proceed |
Response Codes
Message Failure response codes and meaning:
Status Code | Meaning |
---|---|
1001 | Last Mapped Bot Details And Sender Details Mismatch |
1002 | Number Does Not Exists On WhatsApp |
1003 | Unable To Send Message | Check your wallet balance. |
1004 | Message sending failed as user is inactive for session message and template messaging is disabled |
1005 | Message sending failed as user is inactive for session message and template did not match |
1006 | Message sending failed as user is inactive for session message and not opted in for template message |
1007 | Message sending failed as user is inactive for session message, not opted in for template message and template did not match |
1008 | User is not Opted in and Inactive |
1010 | Invalid Media Url |
1011 | Invalid Media Size |