WhatsApp Connect API Documentation
Welcome! You can refer to this page for WhatsApp API To Connect with Billing Software documentation. With the same Connect APIs, you can send WhatsApp messages from your billing, CRM, EMR, HMS, or Any other 3rd party system.
The API messages sent are secured and mapped to the account code as well as the account-specific API KEY. The account owner can reset the API KEY from their dashboard anytime when they feel that the key is compromised or shared. Once the API KEY is reset, please make sure that the new key is updated in all your systems (billing, CRM, etc.) for sending WhatsApp messages.
Please reach out to our technical team if you are looking for some customization on APIs, messages, or templates.
Send a WhatsApp Message
Endpoint: https://portal.myconnect.one/api/campaign/schedule
Request Type: POST
| Parameter Name | Description | Mandatory/Optional |
|---|---|---|
| api_key(string) | Connect API Key allocated to a specific account | Mandatory |
| account_code(string) | Account Code of the Account | Mandatory |
| template_id(int) | Template id of template that is used for sending WhatsApp message | Mandatory |
| media_url(string) | WhatsApp Media URL examples https://picsum.photos/seed/picsum/HYPERLINK “https://picsum.photos/seed/picsum/200/300” | Mandatory if template has image, audio, video, or document otherwise optional |
| media_type(int) | WhatsApp Media Type ‘1’ = ‘image’ ‘2’ = ‘audio’ ‘3’ = ‘video’ ‘4’ = ‘document’ (doc, docx, xls, xlsx, pdf, txt) | Mandatory if the template has image, audio or video, document, otherwise optional |
| messages (array/list) | Array/List containing parameters required for sending Whatsapp message |
Message Parameters
| Parameter Name | Description | Mandatory/Optional |
|---|---|---|
| phone(string) | A valid WhatsApp phone number (10 characters) without the country code to which the WhatsApp message is to be sent eg; 1234567890 | Mandatory |
| country_code(string) | Country Code of the WhatsApp phone number (without + sign) eg; 1, 91, 92, 44 etc | Mandatory |
| parameters (array/list) | Array / List containing message parameters required for sending WhatsApp message Eg; ["Rahul Kumar","Pariimiti Pune","750/-","ABC35353","8007871718"] | Mandatory if template message has parameters in its content, otherwise Optional |
Request Example
{
“api_key”: “xxxxxxxxxxxxxxxxxxxxxxx”,
“template_id”: 1,
“media_url”: “https://picsum.photos/seed/picsum/ HYPERLINK
“messages”: [
{
“phone” : “1234567890”,
“country_code”:”91″,
“parameters”:[“Rajesh”,”Delhi”,”ABCB76425″,”22/Jan/2023″]},
{
“phone” : “1234567891”,
“country_code”:”1″,
“first_name”:”Donald”
}
]
}
Success Example
{
“response_code”: 200,
“success”: true,
“message”: “WhatsApp Campaign Scheduled For 2 numbers!
}