Post Request (Send bulk message)
{ "sender": "Kommify", "to": "91XXXXXXXXX1, 91XXXXXXXXXX2, 91XXXXXXXXXX3", "text": "this is test message", "type": "TRANS" }
OVERVIEW
Kommify Programmable SMS API helps you to add robust messaging capabilities to your application
Using Kommify SMS API, you can send
- Bulk SMS
- OTP SMS
- Flash SMS
- SMS With Unicode
- WhatsApp API
BASE URL
Parameters and Variables:
- Header
-
Name Type Description Content-Type String application/json apikey String API Key generated by portal.kommify.com, i.e : 7cP0XXXXXXb8rcQBCXXXXXXA2tHKRc - Request Body
-
Attribute Name Type Required Description Sample Value Sender String Yes Originator/Alphanumeric ID Senderid AZQINF to String Yes Recipient's MSISDN 91XXXXXXXXXX text String Yes Originator/Alphanu meric ID Senderid AZQINF type String Yes Route type TRANS templateId String Optional Unique ID of the template 120716XXXXXX XXXXXXX unicode Integer Optional To specify that the message to be sent is in unicode format 1
Post Request (Send single message)
{ "sender": "Kommify", "to": "8800852106", "text": "this is test message", "type": "TRANS" }
- Success Response
{ "id": "58d63c02-XXXX-XXXX-XXXX-XXXXbb39453", "data": [ { "recipient": "91XXXXXXXXXX", "messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:1" } ], "totalCount": 1, "message": "Message Sent Successfully!", "error": null }
- Failed Response
{ "error": true, "message": "Api Key not found" }
- Success Response
{ "id": "58d63c02-XXXX-XXXX-XXXX-XXXXbb39453", "data": [ { "recipient": "91XXXXXXXXX1", "messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:1" }, { "recipient": "91XXXXXXXXX2", "messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:2" }, { "recipient": "91XXXXXXXXX3", "messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:3" } ], "totalCount": 3, "message": "Message Sent Successfully!", "}
- Failed Response
{ "error": true, "message": "Api Key not found" }
Post Curl Request
curl --location 'https://api.kommify.com/v1/sms' \ --header 'apikey: 7cP0XXXXXXb8rcQBCXXXXXXA2tHKRc' \ --header 'Content-Type: application/json' \ --data '{ "sender": "AZQINF", "to": "91XXXXXXXXX1, 91XXXXXXXXX2, 91XXXXXXXXX3", "text": "this is test template", "type": "TRANS" }
GET Curl Request
curl --location 'https://api.kommify.com/v1/sms?sender=AZQINF&to=91XXXXXXXXXX&text=this%20is %20test%20message&type=TRANS' \ --header 'Content-Type: application/json' \ --header 'apikey: 7cP0XXXXXXb8rcQBCXXXXXXA2tHKRc'
Generate OTP
1) Generate OTP API Base URL
- Headers
-
Name Type Description Content-Type String application/json apikey String API Key generated by portal.kommify.com, i.e : 7cP0XXXXXXb8rcQBCXXXXXXA2tHKRc - Request Body
-
Attribute Name Type Required Description Sample Value configId String Yes ID of the
on which the OTP will be generated.
Read More
a73cd9ae-XXXX- XXXX-XXXX- 7f73XXXX4064 to String Yes Recipient's MSISDN 91XXXXXXXXXX - Request
-
"configId": "a73cd9ae-XXXX-XXXX-XXXX-7f73XXXX4064", "to": "91XXXXXXXXXX"
- Success Response
-
{ "messageId": "35c035fc-XXXX-XXXX-XXXX-fbbd31b85307", "verifyId": "40196bab-XXXX-XXXX-XXXX-39556a0ad8be", "to": "91XXXXXXXXXX", "configId": "a73cd9xe-XXXX-XXXX-XXXX-7f731bcf4y64", "message": "Message Sent Successfully!", "error": null }
- Failed Response
-
{ "error": true, "message": "Invalid API Key or Expired!" }
- Post Curl Request
curl --location 'https://api.kommify.com/v1/verify/' \ --header 'apikey: 77cP0XXXXXXb8rcQBCXXXXXXA2tHKRc'\ --header 'Content-Type: application/json' \ --data '{ "configId": " a73cd9xe-XXXX-XXXX-XXXX-7f731bcf4y64", "to": "91XXXXXXXXXX " }'
2) Verify and validate generated OTP
- Headers
-
Name Type Description Content-Type String application/json apikey String API Key generated by portal.kommify.com, i.e : 7cP0XXXXXXb8rcQBCXXXXXXA2tHKRc - Request Body
-
Attribute Name Type Required Description Sample Value verifyId String Yes The Verify ID
which was sent in the Generate OTP API response
Read More
a73cd9ae-XXXX- XXXX-XXXX- 7f73XXXX4064 otp String Yes One Time Pass
word which was sent to the users to validate them.
Read More
XXXX - Request
-
{ "verifyId": "33888968-XXXX-XXXX-XXXX-3010e0069668", "otp": "XXXXXX" }
- Success Response
-
{ "data": "33888968-XXXX-XXXX-XXXX-3010e0069668", "error": null, "message": "OTP Verified Successfully!" }
- Failed Response
-
{ "error": true, "message": "OTP has been Already Verified" }
- Post Curl Request
curl --location 'https://api.kommify.com/v1/verify/validate' \ --header 'apikey: 77cP0XXXXXXb8rcQBCXXXXXXA2tHKRc'\ --header 'Content-Type: application/json' \ --data '{ "verifyId": "33888968-XXXX-XXXX-XXXX-3010e0069668", "otp": "XXXXXX" }'
3) WhatsApp API
- Headers
-
Name Type Description Content-Type String application/json apikey String API Key generated by portal.kommify.com, i.e : 7cP0XXXXXXb8rcQBCXXXXXXA2tHKRc - Request Body
-
Attribute Name Type Required Description Sample Value from String Yes The number registered with WhatsApp business from which the message is to be sent. Ensure that the country code is prefixed to the number. For example, if the number is in the India, the format would be: +91XXXXXXXXXX +91XXXXXXXXXX to String Yes Recipient's MSISDN
91XXXXXXXXXX campaignName String Optional The WhatsApp campaign name refers to the specific name or title given to a campaign conducted through WhatsApp
Campaign Name type String Yes Template Type WhatsApp messages
template templateName String Yes This template name contains only lowercase alphanumeric characters and underscores
120716XXXXXXXXX XXXX type String Yes WhatsApp message templates type
template Object String Yes To build a message "components": { content object for "body":{ WhatsApp, you typically include various fields such as param, header type
"components": { "body":{ "params":["var1", "var2", "var3"] }, "header": { "type": " image", "image": { "link": "mediaUrl" } } }, } body object Yes Template body "body":{ "params":["var1", "var2", "var3"] } params String Yes(In the case of template haveing varaiables) If you have a registered template with placeholders and you need to submit parameter values in the same order as in the template, you can represent this as an array of values. Ensure that the values are not null, and if the template was registered without placeholders, you can submit an empty array. "params":["var1", "var2", "var3"] header Object Yes(In the case of template having header type) If your template includes header type text or media, you need to define the template header. "params":["var1", "var2", "var3"] Type(header type text) String Yes(In the case of template having header type text) Value of a placeholder in the text header. “text”: “text value” Type(header type image) Object Yes(In the case of template having header type image) To comply with the requirements, ensure that the URL provided for the image starts with either "https://" or "http://", and that the image is in one of the supported formats (JPG, JPEG, or PNG) with a maximum size of 5MB. "header": { "type": " image", "image": { "link": "mediaUrl" } } - Post Request for template message with header type none and template data without having parameter(variables)
-
{ "from": "91XXXXXXXXXX", "campaignName": "api-test", "to": "91XXXXXXXXXX", "templateName": "template_name", "type": "template" }
- Post Request for template message with header type none and template data having parameter(variables)
-
{ "from": "91XXXXXXXXXX ", "campaignName": "api-test", "to": "91XXXXXXXXXX", "templateName": "template_name", "components": { "body":{ "params":["var1", "var2", "var3"] } }, "type": "template" }
- Post Request for template message with header type image and template data having parameter(variables)
-
{ "from": "91XXXXXXXXXX ", "campaignName": "api-test", "to": "91XXXXXXXXXX", "templateName": "template_name", "components": { "body":{ "params":["var1", "var2", "var3"] }, "header": { "type": " image", "image": { "link": "mediaUrl" } } }, "type": "template" }
- Post Request for template message with header type text and template data having parameter(variables)
-
{ "from": "91XXXXXXXXXX", "campaignName": "api-test", "to": "91XXXXXXXXXX", "templateName": "template_name", "components": { "body": { "params": ["var1","var2","var3"] }, "header": { "type": "text", "text": "text value" } }, "type": "template" }
- Post Request for template message with header type video and template data having parameter(variables)
-
{ "from": "91XXXXXXXXXX ", "campaignName": "api-test", "to": "91XXXXXXXXXX", "templateName": "template_name", "components": { "body":{ "params":["var1", "var2", "var3"] }, "header": { "type": "video", "video": { "link": "mediaUrl" } } }, "type": "template" }
- Post Request for template message with header type document and template data having parameter(variables)
-
{ "from": "91XXXXXXXXXX ", "campaignName": "api-test", "to": "91XXXXXXXXXX", "templateName": "template_name", "components": { "body":{ "params":["var1", "var2", "var3"] }, "header": { "type": "document", " document": { "link": "url" } } }, "type": "template" }
- Post Request for template message with header type document and template data having parameter(variables)
-
{ "from": "91XXXXXXXXXX ", "campaignName": "api-test", "to": "91XXXXXXXXXX", "templateName": "template_name", "components": { "body":{ "params":["var1", "var2", "var3"] }, "header": { "type": "document", "document": { "link": "url" } } }, "type": "template" }
- Success Response
- Failed Response
{ "id": "58d63c02-XXXX-XXXX-XXXX-XXXXbb39453", "data": [ { "recipient": "91XXXXXXXXXX", "messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:1" } ], "totalCount": 1, "message": "Message Sent Successfully!", "error": null }
{ "error": true, "message": "Api Key not found" }