The wa.sendpk.com API enables businesses to communicate with customers through WhatsApp, offering features such as automated messaging, template-based notifications, and integration with CRM systems. It supports sending and receiving text, images, and media, while ensuring data security and compliance with WhatsApp's guidelines. The API facilitates efficient customer interactions, automation, and analytics to enhance engagement and support.
\nEasy. Only two steps actually:
\nIn order to use our API, you will need api_token. This can be obtained by creating an account and then by logging in to the customer portal.
api_tokenapi_token can be obtained on the profile page. Here is the page profile link:
Profile Page
StartFragment
Note: This API supports both GET & POST methods (POST method recommended).
StartFragment
https://wa.sendpk.com/api/send.php
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Template Message API Documentation","slug":"template-message-api-documentation"}],"owner":"9576087","collectionId":"5e639ecb-50f7-411b-b038-2a80dbcc0cac","publishedId":"2sAXjDdv62","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-08-22T06:04:04.000Z"},"item":[{"name":"Simple Template API (Fixed Content)","id":"2e891ec9-b273-4357-bdac-d5a27c699998","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"template_id","value":"{{approved_tempate_id}}","type":"text"},{"key":"template_data","value":"[{\"mobile\":\"{{Recipient_Number}}\"}]","type":"text"}]},"url":"https://wa.sendpk.com/api/send.php","description":"To Send A Template Message First Of All We Need To Approve An Template From Whatsapp.
\nFor Example, We Have Approved The Following Template Message
\n“Thank you for your order! We have received your order and are currently processing it. You will receive updates as your order moves forward. If you have any questions, feel free to contact us”
\nPlease note that this message has no variable (meaning you can't change anything in the message content, it is fixed). If you have variables like {{}}, you can change the text as per your need, which will be discussed in the next chapter.
\nTo Send This Message, Simply We Need The Following Parameters in Our URL:
\n\n","urlObject":{"protocol":"https","path":["api","send.php"],"host":["wa","sendpk","com"],"query":[],"variable":[]}},"response":[{"id":"7c8f1022-f1ad-4cda-88de-a3b9daf0fb15","name":"Simple Template API (Fixed Content)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"template_id","value":"{{approved_tempate_id}}","type":"text"},{"key":"template_data","value":"[{\"mobile\":\"{{Recipient_Number}}\"}]","type":"text"}]},"url":"https://wa.sendpk.com/api/send.php"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"true\",\n \"method\": \"API\",\n \"message_type\": \"TEMPLATE\",\n \"total_price\": \"0\",\n \"total_gsm\": \"1\",\n \"remaining_credit\": \"906\",\n \"results\": [\n {\n \"status\": \"OK\",\n \"id\": \"58e95d15-323e-4ed8-9a10-388f39849974\",\n \"mobile\": \"923134126153\"\n }\n ]\n}"}],"_postman_id":"2e891ec9-b273-4357-bdac-d5a27c699998"},{"name":"Dynamic Template API","id":"569eb541-ad63-41af-99f2-bb6f1f5c1793","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"template_id","value":"{{template_id}}","type":"text"},{"key":"template_data","value":"[{\"mobile\":\"{{recipient_number}}\",\"body\":[{\"type\":\"text\",\"text\":\"{{Variable_1}}\"},{\"type\":\"text\",\"text\":\"{{variable_2}}\"}]}]","type":"text"}]},"url":"https://wa.sendpk.com/api/send.php","description":"With this API, we can dynamically modify the message header and body content, which can include text, images, or media files. This flexibility enables you to tailor messages to fit various needs and contexts, providing a more personalized and engaging experience for recipients.
\nTo Send A Template Message First Of All We Need To Approve An Template From Whatsapp
\nFor Example, We Have Approved The Following Template Message:
\n\n\n
“Hi {{1}},
Your order has been successfully placed!
The total amount is {{2}}
Thank you for choosing us!”
\n Please Note, In the Dynamic Template API, placeholders such as {{1}} & {{2}} are used to represent dynamic variables within the message template. These placeholders can be replaced with specific values as needed to customize the message for each recipient.
{{1}} This placeholder corresponds to the first dynamic variable in the message template.
{{2}} This placeholder corresponds to the second dynamic variable in the message template.
To send a Dynamic Template message with these placeholders, use the following URL
\nParameter template_data Sample: [{\"mobile\":\"923134126153\",\"body\":[{\"type\":\"text\",\"text\":\"Abdul Basit\"},{\"type\":\"text\",\"text\":\"1500\"}]}]
The Media API supports sending media files such as images and documents.
\nTo send a media message, you must have an approved template from WhatsApp. For example, we have an approved template featuring an image with dynamic text content.
\n“Hi {{1}},
This is to confirm your order of the {{2}} watch.
The total price is {{3}}.
Thank you for your purchase ”
\nPlease Note, In this Template, placeholders such as {{1}} , {{2}} & {{3}} are used to represent dynamic variables within the message template. These placeholders can be replaced with specific values as needed to customize the message for each recipient.
{{1}} This placeholder corresponds to the first dynamic variable in the message template.
{{2}} This placeholder corresponds to the second dynamic variable in the message template.
{{3}} This placeholder corresponds to the third dynamic variable in the message template.
template_data Paramter Will be
[{\"mobile\":\"923134126153\",\"header\":{\"type\":\"image\",\"url\":\"[https://wa.sendpk.com/assets-front-end/images/api_docs/watch.jpg\"},\"body\":[{\"type\":\"text\",\"text\":\"Abdul](https://wa.sendpk.com/assets-front-end/images/api_docs/watch.jpg) Hadi\"},{\"type\":\"text\",\"text\":\"Apple Watch Ultra 2\"},{\"type\":\"text\",\"text\":\"$ 800\"}]}]
\nAs you can see in the JSON, the \"header\" contains:
\"type\": \"image\"
header should be the
\nimage, document, video, text
\nIf you skip the \"header\" in the JSON, the default media will be attached during WhatsApp's template approval time.
You can provide your own media URL to include dynamic content such as images, documents, or any other media files. This allows you to personalize the media in your messages, making it adaptable to different contexts and purposes.
\nSample URL For This Template:
\n\nSuccess Response:
{\"success\":\"true\",\"method\":\"API\",\"message_type\":\"TEMPLATE\",\"total_price\":\"1\",\"total_gsm\":\"1\",\"remaining_credit\":\"906\",\"results\":[{\"status\":\"OK\",\"id\":\"8ed138a8-d9dd-41c8-833d-d314c269493e\",\"mobile\":\"9231341XXXX\"}]}
A WhatsApp template can consist of 3 key elements: Header, Body, and Footer. The Body is mandatory, while the Header and Footer are optional. The Header allows for a maximum of 60 characters and can include 1 dynamic variable if it consists of text. In contrast, the Body supports up to 1024 characters and can accommodate over 50 dynamic variables, making it the most flexible section. The Footer, like the Header, is limited to 60 characters but does not support any dynamic variables.
\nPlease ensure that these specifications are adhered to in order to create a valid template.
\nIn this template, we will send a message that consists of three main elements: a header, a body, and a footer.
\nTo Send A Template Message First Of All We Need To Approve An Template From Whatsapp
\nFor Example, We Have Approved The Following Template Message:
\n\"Thank you for scheduling your payment of {{1}} for your {{2}} account on {{3}}
\nvisit your account if you would like to make any changes.\"
\nPlease Note, In this Template, placeholders such as {{1}} in header & {{1}}, {{2}} variable are used in body to represent dynamic values within the message template. These placeholders can be replaced with specific values as needed to customize the message for each recipient.
To send a Dynamic Template message with these placeholders, use the following URL:
\n\nStartFragmentarameter template_data Sample:
\n[{\"mobile\":\"RECIPIENT_NUMBER\",\"header\":{\"type\":\"text\",\"text\":\"Luqman Rasul\"},\"body\":[{\"type\":\"text\",\"text\":\"$ 180\"},{\"type\":\"text\",\"text\":\"CS Mutual Debit Plus\"},{\"type\":\"text\",\"text\":\"Jan 1, 2024\"}]}]
Successful Response
\n{\"success\":\"true\",\"method\":\"API\",\"message_type\":\"TEMPLATE\",\"total_price\":\"1\",\"total_gsm\":\"1\",\"remaining_credit\":\"906\",\"results\":[{\"status\":\"OK\",\"id\":\"8ed138a8-d9dd-41c8-833d-d314c269493e\",\"mobile\":\"9231341XXXX\"}]}
\nA WhatsApp template can consist of 4 key elements: Header, Body, Footer & Button. The Body is mandatory, while the Header , Footer & Button are optional. The Header allows for a maximum of 60 characters and can include 1 dynamic variable if it consists of text. In contrast, the Body supports up to 1024 characters and can accommodate over 50 dynamic variables, making it the most flexible section. The Footer, like the Header, is limited to 60 characters but does not support any dynamic variables. Up to 13, buttons including 2 website buttons, 1 call button, & 10 quick reply buttons.
Please ensure that these specifications are adhered to in order to create a valid template.
In this template, we will send a message that consists of three main elements: a header, a body, and a footer.
\nTo Send A Template Message First Of All We Need To Approve An Template From Whatsapp
\nFor Example, We Have Approved The Following Template Message:
\n{{1}}, your order has shipped!
Your tracking number is {{2}}.
Estimated delivery is {{3}}.
We will continue to provide updates on this shipment.
\nPlease Note, In this Template, placeholders such as {{1}} in header & {{1}}, {{2}} & {{3}} variable are used in body to represent dynamic values within the message template. These placeholders can be replaced with specific values as needed to customize the message for each recipient
To send a Dynamic Template message with these placeholders & buttons, use the following URL:
\n[https://wa.sendpk.com/api/send.php?api_key=API_KEY&template_id=TEMPLATE_ID&template_data=[{\"mobile\":\"RECIPIENT_NUMBER\",\"header\":{\"type\":\"text\",\"text\":\"66457\"},\"body\":[{\"type\":\"text\",\"text\":\"Mubashar Shahzad\"},{\"type\":\"text\",\"text\":\"3434656-43434-33\"},{\"type\":\"text\",\"text\":\"22 December 2024\"}],\"button\":[{\"type\":\"url\",\"text\":\"/url-trackering-address/\"}]}]
](https://wa.sendpk.com/api/send.php?api_key=API_KEY&template_id=TEMPLATE_ID&template_data=%5B%7B%22mobile%22:%22RECIPIENT_NUMBER%22,%22header%22:%7B%22type%22:%22text%22,%22text%22:%2266457%22%7D,%22body%22:%5B%7B%22type%22:%22text%22,%22text%22:%22Mubashar%20Shahzad%22%7D,%7B%22type%22:%22text%22,%22text%22:%223434656-43434-33%22%7D,%7B%22type%22:%22text%22,%22text%22:%2222%20December%202024%22%7D%5D,%22button%22:%5B%7B%22type%22:%22url%22,%22text%22:%22/url-trackering-address/%22%7D%5D%7D%5D)Parameter template_data Sample: [{\"mobile\":\"RECIPIENT_NUMBER\",\"header\":{\"type\":\"text\",\"text\":\"66457\"},\"body\":[{\"type\":\"text\",\"text\":\"Mubashar Shahzad\"},{\"type\":\"text\",\"text\":\"3434656-43434-33\"},{\"type\":\"text\",\"text\":\"22 December 2024\"}],\"button\":[{\"type\":\"url\",\"text\":\"/url-trackering-address/\"}]}]
**Successful Response
**{ \"success\": \"true\", \"method\": \"API\", \"message_type\": \"TEMPLATE\", \"total_price\": \"1\", \"total_gsm\": \"1\", \"remaining_credit\": \"906\", \"results\": [ { \"status\": \"OK\", \"id\": \"8ed138a8-d9dd-41c8-833d-d314c269493e\", \"mobile\": \"9231341XXXX\" } ] }
Please Note! When creating templates, it's important to understand that not all buttons need to be defined in the JSON under the button variable. Specifically, only the buttons that include dynamic website URLs should be mentioned there. Static buttons or buttons that do not change based on the content do not need to be included in the button variable. For example, if you have a static button in your template that links to a fixed URL, you don't need to mention it in the JSON. However, if the button's URL is dynamic and changes based on the content you're sending, then it should be included in the JSON. Let's say your main domain is 'https://example.com/', and you have a dynamic URL path that varies depending on the report you send. In such cases, you would specify this dynamic path in the JSON as follows
\n\"button\": [
{
\"type\": \"url\",
\"text\": \"/url-tracking-address/\"
}
]
Here, '/url-tracking-address/' is a dynamic part that will be added to the main domain, resulting in a complete URL like 'https://example.com/url-tracking-address/' This method allows you to customize URLs easily without hardcoding every possible button link directly into the template, giving you more flexibility in your messaging.
](\"https://wa.sendpk.com/assets-front-end/images/api_docs/watch.jpg%22%7D,%22body%22:%5B%7B%22type%22:%22text%22,%22text%22:%22Abdul%5D(https://wa.sendpk.com/assets-front-end/images/api_docs/watch.jpg)\"){kind=link}
![https://wa.sendpk.com/api/send.php?api_key=API_KEY&template_id=TEMPLATE_ID&template_data=[{\"mobile\":\"923134126153\",\"header\":{\"type\":\"image\",\"url\":\"https://wa.sendpk.com/assets-front-end/images/api_docs/watch.jpg\"},\"body\":[{\"type\":\"text\",\"text\":\"Abdul%20Hadi\"},{\"type\":\"text\",\"text\":\"Apple%20Watch%20Ultra%202\"},{\"type\":\"text\",\"text\":\"$%20800\"}]}]](https://wa.sendpk.com/api/send.php?api_key=API_KEY&template_id=TEMPLATE_ID&template_data=%5B%7B%22mobile%22:%22923134126153%22,%22header%22:%7B%22type%22:%22image%22,%22url%22:%22https://wa.sendpk.com/assets-front-end/images/api_docs/watch.jpg%22%7D,%22body%22:%5B%7B%22type%22:%22text%22,%22text%22:%22Abdul%20Hadi%22%7D,%7B%22type%22:%22text%22,%22text%22:%22Apple%20Watch%20Ultra%202%22%7D,%7B%22type%22:%22text%22,%22text%22:%22$%20800%22%7D%5D%7D%5D)](\"https://wa.sendpk.com/api/send.php?api_key=API_KEY&template_id=TEMPLATE_ID&template_data=%5B%7B%22mobile%22:%22923134126153%22,%22header%22:%7B%22type%22:%22image%22,%22url%22:%22https://wa.sendpk.com/assets-front-end/images/api_docs/watch.jpg%22%7D,%22body%22:%5B%7B%22type%22:%22text%22,%22text%22:%22Abdul%20Hadi%22%7D,%7B%22type%22:%22text%22,%22text%22:%22Apple%20Watch%20Ultra%202%22%7D,%7B%22type%22:%22text%22,%22text%22:%22$%20800%22%7D%5D%7D%5D%5D(https://wa.sendpk.com/api/send.php?api_key=API_KEY&template_id=TEMPLATE_ID&template_data=%5B%7B%22mobile%22:%22923134126153%22,%22header%22:%7B%22type%22:%22image%22,%22url%22:%22https://wa.sendpk.com/assets-front-end/images/api_docs/watch.jpg%22%7D,%22body%22:%5B%7B%22type%22:%22text%22,%22text%22:%22Abdul%20Hadi%22%7D,%7B%22type%22:%22text%22,%22text%22:%22Apple%20Watch%20Ultra%202%22%7D,%7B%22type%22:%22text%22,%22text%22:%22$%20800%22%7D%5D%7D%5D)\"){kind=link}