Table of Contents
Send notifications to users through API:
NOTE: In case of a new user (i.e. the user doesn’t exist on your contact list in AiSensy Platform) then a new contact will get created with the incoming details.
Prerequisites
You have verified WhatsApp Business API. How?
You have template messages approved.
You have already created an API Campaign. How to create API Campaign?
HTTP Request
Request Body
The request body contains data with the following structure:
JSON Representation
{
"apiKey": string,
"campaignName": string,
"destination": string,
"userName": string,
"source": string,
"media": {
"url": string,
"filename": string
},
"templateParams": [
string
],
"tags": [
string
],
"attributes": {
"attribute_name": string
}
}
Fields | Description |
apiKey | string |
campaignName | string |
destination | string |
userName | string |
source | string |
media | object |
templateParams[] | string |
tags[] | string |
attributes | object with key-value pairs. The only string is allowed as the key's value.
Optional. The object should contain keys already added as assistant attributes paired with values that you want to set as user's attributes. |
Example Postman Request
Step 1 - Setup request type to "POST"
Step 2 - Setup URL
Step 3 - Choose body type "raw"
Step 4 - Select "JSON" type
Step 5 - Set content of the request
You can find more examples here - Open in Postman
NOTES:
Optional fields are not necessary for the request payload
The medial URL provided in the media object should be publically accessible, otherwise, the request will be rejected
The length of the template params array should be equal to the number of params required in the campaign whose name is provided in campaignName field. Otherwise, the request will be rejected
Tags should be created in your project before using them. It can be done by anyone with manager level access
If a tag doesn't exist in your project, it will be ignored
Attributes should be added to the project before using them. It can be done by anyone with manager level access
If an attribute doesn't exist in your project, it will be ignored
Response Body
If successful, the response body will return a status of 200.