Whatsapp Template
Whatsapp Template
API Endpoint
https://eu.cpaas.bics.com/api/v2/
View Template
View all the Templates list.
GET
{endpoint}whatsapp/templates
Example Filter
{endpoint}whatsapp/templates?filter[name]=template_name
PARAMETERS
name |
optional |
value |
filter[id] |
Yes |
The id is template id |
filter[name] |
Yes |
The name is template name |
filter[type] |
Yes |
The type is template type EX: (text, template) |
filter[status] |
Yes |
(1 is Approved), (2 are Pending) and (3 is Rejected) |
Example Request
curl -X GET \
'{endpoint}whatsapp/templates' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer 5b02112fb7xxxxxxxxx'
Kindly replace the token with your respective access_token and other params.
Example Response
{
"status": "OK",
"code": 200,
"message": "Templates List",
"data": [
{
"id": "2cf9e59f-d4f1-47ba-81d3-a288f31ca164",
"name": "text_template",
"alias": "text-template",
"number": "91861xxxxxxx",
"type": "text",
"category": "marketing",
"language": "English",
"body": "Hi,This is WhatsApp text template message.",
"payload": "{\"type\":\"text\",\"payload\":{\"text\":\"Hi,This is WhatsApp text template message.\",\"language\":\"en\"}}",
"status": "Pending",
"created_at": "2023-02-08T10:41:30.000000Z",
"updated_at": "2023-02-08T10:41:30.000000Z"
}
],
"links": {
"first": "{endpoint}whatsapp/templates?page=1",
"last": "{endpoint}whatsapp/templates?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "{endpoint}whatsapp/templates?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "{endpoint}whatsapp/templates",
"per_page": 15,
"to": 1,
"total": 1
}
],
"links": {
"first": "{endpoint}whatsapp/templates?page=1",
"last": "{endpoint}whatsapp/templates?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "{endpoint}whatsapp/templates?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "{endpoint}whatsapp/templates",
"per_page": 15,
"to": 1,
"total": 1
}
}
Create Templates
POST
{endpoint}whatsapp/templates
PARAMETERS
name |
description |
Type |
Required |
type |
values are text , template , mediatemplate |
string |
Yes |
name |
name should be a alphanumeric |
string ,integer |
Yes |
category |
marketing , authentication or utility |
string |
Yes |
language |
Example : eu , en_US |
string |
Yes |
number |
business number Ex:(91861xxxxxxxx) |
string or integer |
Yes |
meta_approval |
Send to meta approval |
boolean |
Yes |
Text Type
Example Request
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "text",
"name": "new_text",
"category": "marketing",
"language": "en",
"number": "91861xxxxxxxx",
"meta_approval" : true,
"payload": {
"type": "text",
"payload": {
"text": "This is a simple text message from whatsapp channel"
}
}
}'
Example Response
{
"status": "OK",
"code": 200,
"message": "Template created successfully.",
"data": []
}
Template Type
Example Request
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "template",
"name": "new_template",
"category": "marketing",
"language": "en",
"number": "91861xxxxxxxx",
"meta_approval" : true,
"payload": {
"type": "template",
"payload": {
"text": "Hello {{#var#}}, This is a simple text message from whatsapp channel",
"body_params": ["user"]
}
}
}'
Example Response
{
"status": "OK",
"code": 200,
"message": "Template created successfully.",
"data": []
}
Json Type
In body content message should be json format.
Example Request
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "json",
"name": "new_json",
"category": "marketing",
"language": "en",
"number": "91861xxxxxxxx",
"meta_approval" : true,
"payload": {
"type": "json",
"payload" : {
"text" : {"name" : "hlo"}
}
}
}'
Example Response
{
"status": "OK",
"code": 200,
"message": "Template created successfully.",
"data": []
}
Media Template Type
PARAMETERS
name |
optional |
value |
category |
No |
marketing , utility or authentication if authentication |
language |
No |
prefer language ex: en, en_US, af |
payload.type |
No |
mediatemplate |
payload.payload.header |
No |
The header content, header contain only one variable |
payload.payload.body |
No |
The body content, body contains multiple variables (one variable is required if category utility) |
payload.payload.footer |
Yes |
The footer content |
choices |
Yes |
The choices buttons is optional |
choices.type |
No |
actions |
choices.actions |
No |
expect the object at least one |
choices.actions.type |
No |
phone_number , url |
choices.actions.phone_number_text |
No |
max 20 characters |
choices.actions.phone_number |
No |
country code prefix required Ex:(+91) |
choices.actions.website_url_type |
No |
value is Static |
choices.actions.website_button_text |
No |
max 20 characters |
choices.actions.website_url |
No |
should be url |
With Button
Example Request
Type Text
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "mediatemplate",
"name": "template_name",
"category": "Marketing",
"language": "en",
"meta_approval": true,
"number": "918736xxxxxx",
"payload": {
"type": "mediatemplate",
"payload": {
"name": "mediatemplate_with_buttons",
"language": "en",
"body_params": [],
"header_params": [],
"header": {
"type": "text",
"payload": {
"text": "Q&A"
}
},
"body": {
"type": "text",
"payload": {
"text": "Any doubts please contact us"
}
},
"footer": {
"type": "text",
"payload": {
"text": "Thank you!"
}
},
"choices": {
"type": "actions",
"actions": [
{
"type": "phone_number",
"phone_number_text": "Any queries call",
"phone_number": "+918783xxxxxx"
},
{
"type": "url",
"website_url_type" : "Static",
"website_button_text" : "More info visit",
"website_url" : "www.example.com"
}
]
}
}
}
}'
Type Image
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "mediatemplate",
"name": "template_name",
"category": "marketing",
"meta_approval": true,
"language": "en",
"number": "918736xxxxxx",
"payload": {
"type": "mediatemplate",
"payload": {
"name": "mediatemplate_with_buttons",
"language": "en",
"body_params": [
"body"
],
"header_params": [
"header"
],
"header": {
"type": "image",
"payload": {
"text": "Header text {{#var#}}",
"url": "https://www.pakainfo.com/wp-content/uploads/2021/09/image-url-for-testing.jpg"
}
},
"body": {
"type": "text",
"payload": {
"text": "Any doubts please contact us {{#var#}}"
}
},
"footer": {
"type": "text",
"payload": {
"text": "Thank you!"
}
},
"choices": {
"type": "actions",
"actions": [
{
"type": "phone_number",
"phone_number_text": "Any queries call",
"phone_number": "+918783xxxxxx"
},
{
"type": "url",
"website_url_type": "Static",
"website_button_text": "More info visit",
"website_url": "www.example.com"
}
]
}
}
}
}'
Type Video
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "mediatemplate",
"name": "template_name",
"category": "marketing",
"meta_approval": true,
"language": "en",
"number": "918736xxxxxx",
"payload": {
"type": "mediatemplate",
"payload": {
"name": "mediatemplate_with_button",
"language": "en",
"body_params": [
"body_params"
],
"header_params": [
"header_params"
],
"header": {
"type": "video",
"payload": {
"text": "Header text {{#var#}}",
"url": "https://www.example/sample/video/sample.mp4"
}
},
"body": {
"type": "text",
"payload": {
"text": "Any doubts please contact us {{#var#}}"
}
},
"footer": {
"type": "text",
"payload": {
"text": "Thank you!"
}
},
"choices": {
"type": "actions",
"actions": [
{
"type": "phone_number",
"phone_number_text": "Any queries call",
"phone_number": "+918783xxxxxx"
},
{
"type": "url",
"website_url_type": "Static",
"website_button_text": "More info visit",
"website_url": "www.example.com"
}
]
}
}
}
}'
Type Document
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "mediatemplate",
"name": "template_name",
"category": "marketing",
"meta_approval": true,
"language": "en",
"number": "918736xxxxxx",
"payload": {
"type": "mediatemplate",
"payload": {
"name": "mediatemplate_with_buttons",
"language": "en",
"body_params": [
"body"
],
"header_params": [
"header"
],
"header": {
"type": "document",
"payload": {
"text": "Header text {{#var#}}",
"url": "https://www.example.com/pdf-test.pdf"
}
},
"body": {
"type": "text",
"payload": {
"text": "Any doubts please contact us {{#var#}}"
}
},
"footer": {
"type": "text",
"payload": {
"text": "Thank you!"
}
},
"choices": {
"type": "actions",
"actions": [
{
"type": "phone_number",
"phone_number_text": "Any queries call",
"phone_number": "+918783xxxxxx"
},
{
"type": "url",
"website_url_type": "Static",
"website_button_text": "More info visit",
"website_url": "www.example.com"
}
]
}
}
}
}'
PARAMETERS
name |
optional |
value |
choices |
Yes |
The choices buttons is optional |
choices.type |
No |
reply |
choices.reply |
No |
object can not be empty |
choices.reply.type |
No |
quick_reply |
choices.reply.quick_reply1 |
No |
max 20 characters |
choices.reply.quick_reply2 |
No |
max 20 characters |
choices.reply.quick_reply3 |
Yes |
value is Static |
With Reply
Example Request
Type Text
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "mediatemplate",
"name": "template_name",
"category": "marketing",
"language": "en",
"meta_approval": true,
"number": "918736xxxxxx",
"payload": {
"type": "mediatemplate",
"payload": {
"name": "mediatemplate_with_reply",
"language": "en",
"body_params": [
"body"
],
"header_params": [
"header"
],
"header": {
"type": "text",
"payload": {
"text": "Header text {{#var#}}"
}
},
"body": {
"type": "text",
"payload": {
"text": "Any doubts please contact us {{#var#}}"
}
},
"footer": {
"type": "text",
"payload": {
"text": "Thank you!"
}
},
"choices": {
"type": "reply",
"reply": {
"type": "quick_reply",
"quick_reply1": "Yes",
"quick_reply2": "No"
}
}
}
}
}'
Type Image
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "mediatemplate",
"name": "template_name",
"category": "marketing",
"meta_approval": true,
"language": "en",
"number": "918736xxxxxx",
"payload": {
"type": "mediatemplate",
"payload": {
"name": "mediatemplate_with_buttons",
"language": "en",
"body_params": [
"body"
],
"header_params": [
"header"
],
"header": {
"type": "image",
"payload": {
"text": "Header text {{#var#}}",
"url": "https://www.pakainfo.com/wp-content/uploads/2021/09/image-url-for-testing.jpg"
}
},
"body": {
"type": "text",
"payload": {
"text": "Any doubts please contact us {{#var#}}"
}
},
"footer": {
"type": "text",
"payload": {
"text": "Thank you!"
}
},
"choices": {
"type": "reply",
"reply": {
"type": "quick_reply",
"quick_reply1": "Yes",
"quick_reply2": "No"
}
}
}
}
}'
Type Video
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "mediatemplate",
"name": "template_name",
"category": "marketing",
"meta_approval": true,
"language": "en",
"number": "918736xxxxxx",
"payload": {
"type": "mediatemplate",
"payload": {
"name": "mediatemplate_with_button",
"language": "en",
"body_params": [
"body_params"
],
"header_params": [
"header_params"
],
"header": {
"type": "video",
"payload": {
"text": "Header text {{#var#}}",
"url": "https://www.example/sample/video/sample.mp4"
}
},
"body": {
"type": "text",
"payload": {
"text": "Any doubts please contact us {{#var#}}"
}
},
"footer": {
"type": "text",
"payload": {
"text": "Thank you!"
}
},
"choices": {
"type": "reply",
"reply": {
"type": "quick_reply",
"quick_reply1": "Yes",
"quick_reply2": "No"
}
}
}
}
}'
Type Document
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "mediatemplate",
"name": "template_name",
"category": "marketing",
"meta_approval": true,
"language": "en",
"number": "918736xxxxxx",
"payload": {
"type": "mediatemplate",
"payload": {
"name": "mediatemplate_with_buttons",
"language": "en",
"body_params": [
"body"
],
"header_params": [
"header"
],
"header": {
"type": "document",
"payload": {
"text": "Header text {{#var#}}",
"url": "https://www.example.com/pdf-test.pdf"
}
},
"body": {
"type": "text",
"payload": {
"text": "Any doubts please contact us {{#var#}}"
}
},
"footer": {
"type": "text",
"payload": {
"text": "Thank you!"
}
},
"choices": {
"type": "reply",
"reply": {
"type": "quick_reply",
"quick_reply1": "Yes",
"quick_reply2": "No"
}
}
}
}
}'
Example Response
{
"status": "OK",
"code": 200,
"message": "Template created successfully.",
"data": []
}
Media Type
PARAMETERS
name |
optional |
value |
payload.type |
No |
image , audio , video or document |
Example Request
curl -X POST \
'{endpoint}whatsapp/templates' \
-H 'authorization: Bearer 5b02112fb7xxxxxxxxx' \
-H 'content-type: application/json' \
-d '{
"type": "media",
"name": "new_media",
"category": "marketing",
"language": "en",
"number": "91861xxxxxxxx",
"meta_approval" : true,
"payload": {
"type": "image",
"payload": {
"url": "https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg",
"filename": "filename",
"caption": "caption",
"language": "en"
}
}
}'
Example Response
{
"status": "OK",
"code": 200,
"message": "Template created successfully.",
"data": []
}
Delete Templates
DELETE
{endpoint}whatsapp/templates/{id}
Replace the {id} with the actual id of the template that you would like to delete.
Example Request
curl -X DELETE \
{endpoint}whatsapp/templates/7d77d0ef-63df-4ffb-83d6-xxxxxxxx \
-H 'Accept: application/json' \
-H 'Authorization: Bearer 5b02112fb7xxxxxxxxx'
Example Response
{
"status": "OK",
"code": 200,
"message": "Template Successfully Deleted",
"data": []
}