{"info":{"_postman_id":"330401eb-cd49-db01-64bd-91f042632f70","name":"Kaleyra SMS","description":"Kaleyra SMS API enables you a seamless configuration, set up and delivery of SMS across the globe. This section of API is divided in to 2 sub categories; Global SMS and Alerts(India). Get started Now!\n\n*Each API works in both GET and POST methods.*\n\n# SMS Documentation\n\nTo read more about getting started with SMS and troubleshooting, visit our docs [here](https://developers.kaleyra.com/docs/getting-started-with-sms)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Alerts","item":[{"name":"Send an SMS","event":[{"listen":"prerequest","script":{"id":"6bdac872-3af4-4fb6-9d06-8610e414ed33","exec":[""],"type":"text/javascript"}}],"id":"4ed2569f-4259-a845-a123-e957771bd89e","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms}}&message={{hello}}&to={{phone_number}}&sender={{sender_id}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}","description":"The API Key sent to your registered email ID"},{"key":"method","value":"{{sms}}","description":"Predefined method"},{"key":"message","value":"{{hello}}","description":"Message text which is URL encoded (1000 char for normal, 500 for Unicode)"},{"key":"to","value":"{{phone_number}}","description":"Phone number(s) to which you want to send the SMS"},{"key":"sender","value":"{{sender_id}}","description":"Sender ID assigned to your account"}]},"description":"This API enables you to send an SMS to a single number, group of numbers and a contact group. \n\n# What can you do with this API?\nSend SMS to a phone number or group of phone numbers through our API. HTTP API sends a text message using POST and form-encoded data. The URL you use to send a text message has a required field called api_key, which is unique and assigned to your account.\n\n**If you wish to send SMS globally, the Base URL is listed below.**\n\n>https://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\n# Prerequisites\n\n1. An API Key\n2. Sender ID\n3. 'To' Phone Number\n4. Message content\n\n# API Parameter Specifications\n\nThe API parameter specifications are described in the following sections. Mandatory parameters are must to send an SMS, while optional parameters are defined as per the user's requirement.\n\n## Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter           | Description     | \tExpected Value\t\t|\n|---------------------|-----------------|-----------------------|\n| dlrurl\t\t| The encoded URL to receive delivery reports. Spiffing custom in the DLR url is mandatory.\t\t| delivery reports URL \t|\n| custom\t| Custom message ID by customer, comma separated\t| Alphanumeric (max 40 char)\t|\n| time\t| Date and time for scheduling an SMS\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t|\n| unicode\t| To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.\t| 1 / 0 / auto\t|\n| flash\t\t| To specify that the message is to be sent in the flash format\t\t| To specify that the message is to be sent in the flash format\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n\n## Advanced Parameters(Optional)\nThe advanced parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t\t| XML/JSON/JSONP. Default response will be in JSON\t|\n| callback\t| Callback function for JSONP response format\t| String\t|\n| custom1 and custom2\t| Custom reference fields\t| Alphanumeric (max 40 char)\t|\n| port\t| Port number to which SMS has to be sent\t| Valid integer port number above 2000\t|\n\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"0362eb98-6b8c-43f1-8551-258c04608c17","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms}}&message={{hello}}&to={{phone_number}}&sender={{sender_id}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"message","value":"{{hello}}"},{"key":"to","value":"{{phone_number}}"},{"key":"sender","value":"{{sender_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n    <status>OK</status>\n    <data>\n        <sms>\n            <id>e6bf8207-d226-4429-a1f0-ba0506efa539:1</id>\n            <customid>1</customid>\n            <customid1>11</customid1>\n            <customid2>22</customid2>\n            <mobile>95XXXXXXXX</mobile>\n            <status>AWAITED-DLR</status>\n        </sms>\n        <sms>\n            <id>e6bf8207-d226-4429-a1f0-ba0506efa539:2</id>\n            <customid>2</customid>\n            <customid1>1</customid1>\n            <customid2>2</customid2>\n            <mobile>99XXXXXXXX</mobile>\n            <status>AWAITED-DLR</status>\n        </sms>\n    </data>\n    <message>Campaign of 2 numbers Submitted successfully.</message>\n</api>"},{"id":"39d479c2-3be3-4ef5-849e-e17af90d7a18","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms}}&message={{hello}}&to={{phone_number}}&sender={{sender_id}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"message","value":"{{hello}}"},{"key":"to","value":"{{phone_number}}"},{"key":"sender","value":"{{sender_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"OK\",\n    \"data\": [\n        {\n            \"id\": \"811436f5-0053-4ea6-8cac-b035880b8473:1\",\n            \"customid\": \"1\",\n            \"customid1\": \"11\",\n            \"customid2\": \"22\",\n            \"mobile\": \"95XXXXXXXXX\",\n            \"status\": \"AWAITED-DLR\"\n        },\n        {\n            \"id\": \"811436f5-0053-4ea6-8cac-b035880b8473:2\",\n            \"customid\": \"2\",\n            \"customid1\": \"1\",\n            \"customid2\": \"2\",\n            \"mobile\": \"97XXXXXXXX\",\n            \"status\": \"AWAITED-DLR\"\n        }\n    ],\n    \"message\": \"Campaign of 2 numbers Submitted successfully.\"\n}"}],"_postman_id":"4ed2569f-4259-a845-a123-e957771bd89e"},{"name":"Schedule an SMS","id":"a52059ed-57cb-a9d1-9206-d893d7bdd206","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms}}&message={{hello}}&to={{to}}&sender={{sender_id}}&time=YYYY-MM-DD HH:MM PM","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"message","value":"{{hello}}"},{"key":"to","value":"{{to}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"time","value":"YYYY-MM-DD HH:MM PM"}]},"description":"# What can you do with this API?\nYou can schedule the SMS to a specified time and trigger it to a phone number or a group.This API can let user schedule SMS to single as well as multiple recipients at anytime.\n\n**Message Schedule Time lapses**\n> SMS cannot be scheduled before 5 minutes and after 3 months from the date of scheduling the SMS.\n\n**If you wish to send SMS globally, the Base URL is listed below.**\n\n> https://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\n\n# Prerequisites\n\n1. An API Key\n2. Sender ID\n3. An active Internet connection\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections. Mandatory parameters are must to send an SMS, while optional parameters are defined as per the user's requirement.\n\n## Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t\t| Description\t| Expected Value\t|\n|---------------|---------------|-------------------|\n| dlrurl\t| The encoded URL to receive delivery reports. Spiffing custom in the DLR url is mandatory.\t| delivery reports URL\t|\n| custom\t| Custom message ID by customer, comma separated\t| Alphanumeric (max 40 char)\t| \n| time\t| Date and time for scheduling an SMS\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t|\n| unicode\t| To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.\t| 1 / 0 / auto\t|\n| flash\t\t| To specify that the message is to be sent in the flash format\t| To specify that the message is to be sent in the flash format\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n## Advanced Parameters (Optional)\nThe advanced parameters in the HTTP API are tabulated below:\n\n| Parameter\t\t| Description\t| Expected Value\t|\n|---------------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/JSON/JSONP. Default response will be in JSON\t|\n| callback\t| callback Callback function for JSONP response format\t| String\t|\n| custom1 and custom2\t| Custom reference fields\t| Alphanumeric (max 40 char)\t|\n| port\t| Port number to which SMS has to be sent\t| Valid integer port number above 2000\t|\n\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"9963ee30-405b-458d-93e2-811d51fff00a","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms}}&message={{hello}}&to={{phone_number}}&sender={{sender_id}}&time={{time}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"message","value":"{{hello}}"},{"key":"to","value":"{{phone_number}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"time","value":"{{time}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n    <status>OK</status>\n    <data>\n        <sms>\n            <id>8336457365:1</id>\n            <customid></customid>\n            <customid1></customid1>\n            <customid2></customid2>\n            <mobile>9711xxxxxx</mobile>\n            <status>AWAITED-DLR</status>\n        </sms>\n    </data>\n    <message>Campaign of 1 numbers Scheduled successfully.</message>\n</api>"},{"id":"c79e96aa-1803-4897-99ad-2f6dc6f4c50f","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms}}&message={{hello}}&to={{phone_number}}&sender={{sender_id}}&time={{time}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"message","value":"{{hello}}"},{"key":"to","value":"{{phone_number}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"time","value":"{{time}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"OK\",\n    \"data\": [\n        {\n            \"id\": \"8336615982:1\",\n            \"customid\": \"\",\n            \"customid1\": \"\",\n            \"customid2\": \"\",\n            \"mobile\": \"9711xxxxxx\",\n            \"status\": \"AWAITED-DLR\"\n        },\n        {\n            \"id\": \"8336615982:2\",\n            \"customid\": null,\n            \"customid1\": null,\n            \"customid2\": null,\n            \"mobile\": \"8826xxxxxx\",\n            \"status\": \"AWAITED-DLR\"\n        }\n    ],\n    \"message\": \"Campaign of 2 numbers Scheduled successfully.\"\n}"}],"_postman_id":"a52059ed-57cb-a9d1-9206-d893d7bdd206"},{"name":"Edit Scheduled SMS","id":"924c5921-0211-248a-6905-88cd43465068","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/index.php?api_key={{api_key}}&groupid={{groupid}}&time={{time}}&task=modify&method={{schedule}}","host":["{{base_url}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"groupid","value":"{{groupid}}"},{"key":"time","value":"{{time}}"},{"key":"task","value":"modify"},{"key":"method","value":"{{schedule}}"}]},"description":"# What can you do with this API?\nOnce you create an SMS and schedule it, you'll be able to edit the schedule of the SMS through this API.\nTo edit a scheduled slot, there should a minimum gap of 5 minutes before its execution.\n> Application must have a scheduled SMS campaign to further modify it and user must save a Group ID of an SMS campaign to be rescheduled\n# Prerequisites\n1. API Key\n2. An active Internet connection\n3. Group ID of the scheduled SMS\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t\t| Description\t| Expected Value\t|\n|---------------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n\n\n\n## Response Data\n\n| Field\t| Description\t|\n|-------|---------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message. |\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"056abb6d-2a3c-414a-8553-c182fb35c3ba","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/index.php?api_key={{api_key}}&groupid={{groupid}}&time={{time}}&task=modify&method={{schedule}}","host":["{{base_url}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"groupid","value":"{{groupid}}"},{"key":"time","value":"{{time}}"},{"key":"task","value":"modify"},{"key":"method","value":"{{schedule}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<api>\r\n<status>OK</status>\r\n<message>Campaign updated successfully</message>\r\n</api>"},{"id":"7ad1ef6b-8814-4c76-a3f7-91530f7c0550","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/index.php?api_key={{api_key}}&groupid={{groupid}}&time={{time}}&task=modify&method={{schedule}}","host":["{{base_url}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"groupid","value":"{{groupid}}"},{"key":"time","value":"{{time}}"},{"key":"task","value":"modify"},{"key":"method","value":"{{schedule}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"status\": \"OK\",\r\n  \"data\": \"\",\r\n  \"message\": \"Campaign updated successfully\"\r\n}"}],"_postman_id":"924c5921-0211-248a-6905-88cd43465068"},{"name":"Delete Scheduled SMS ","id":"2ce6fde5-c04d-0f2f-94c5-c1fc45f3bd78","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/index.php?api_key={{api_key}}&method={{schedule}}&groupid={{groupid}}&task=delete","host":["{{base_url}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{schedule}}"},{"key":"groupid","value":"{{groupid}}"},{"key":"task","value":"delete"}]},"description":"# What can you do with this API?\nThrough this API, you can delete a scheduled SMS from your account.To delete a scheduled slot, there should a minimum gap of 5 minutes before its execution. \n\n>Your account must have a scheduled SMS campaign to further modify it and also use must save a Group ID of an SMS campaign to be deleted.\n# Prerequisites\n1. API Key\n2. Group ID of the scheduled SMS\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Response Data\n\n| Field\t| Description\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n\n## Mandatory Parameters"},"response":[{"id":"ad5a2be4-4957-4d0d-8a32-237080f49995","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/index.php?api_key={{api_key}}&method={{schedule}}&groupid={{groupid}}&task=delete","host":["{{base_url}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{schedule}}"},{"key":"groupid","value":"{{groupid}}"},{"key":"task","value":"delete"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\",\r\n    \"data\": \"\",\r\n    \"message\": \"Campaign cancelled successfully and credits are refunded.\"\r\n}\r\n"},{"id":"c70dac7b-fa89-409b-a76b-ceb204468230","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/index.php?api_key={{api_key}}&method={{schedule}}&groupid={{groupid}}&task=delete","host":["{{base_url}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{schedule}}"},{"key":"groupid","value":"{{groupid}}"},{"key":"task","value":"delete"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<api>\r\n<status>OK</status>\r\n<message>Campaign cancelled successfully and credits are refunded</message>\r\n</api>"}],"_postman_id":"2ce6fde5-c04d-0f2f-94c5-c1fc45f3bd78"},{"name":"Send a Unicode SMS","id":"32fb6a79-de25-52a4-f9b6-db2020122d84","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/index.php?api_key={{api_key}}&method={{sms}}&unicode=1&message={{hello}}&sender={{sender_id}}&to={{to}}","host":["{{base_url}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"unicode","value":"1"},{"key":"message","value":"{{hello}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"to","value":"{{to}}"}]},"description":"You can send a Unicode SMS to a phone number or a group, in the language of your choice. To send a Unicode SMS, follow the steps below:\r\n\r\n**If you wish to send SMS globally, the Base URL is listed below.**\r\n\r\n> https://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\r\n\r\n## Unicode Character Counts\r\n\r\n1. Put Unicode=1 if you want to send message in Unicode format. Even if its English, credits will be charged as per Unicode characters.\r\n\r\n2. Put Unicode=0 if you don`t want to send Unicode message.\r\n\r\n3. Put Unicode=auto for automatic detection of Unicode SMS. Based on language, system will detect language and charge accordingly.\r\n\r\n# Prerequisites\r\n1. An API Key\r\n2. Sender ID\r\n3. An active Internet connection\r\n\r\n# API Parameter Specifications\r\n\r\nThe API parameter specifications are described in the following sections. Mandatory parameters are must to send an SMS, while optional parameters are defined as per the user's requirement.\r\n\r\n## Optional Parameters\r\nThe optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| dlrurl\t| The encoded URL to receive delivery reports. Spiffing custom in the DLR url is mandatory.\t| delivery reports URL\t|\r\n| custom\t| Custom message ID by customer, comma separated\t| Alphanumeric (max 40 char)\t|\r\n| time\t| Date and time for scheduling an SMS\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t|\r\n| unicode\t| To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.\t| 1 / 0 / auto\t|\r\n| flash\t| To specify that the message is to be sent in the flash format\t| To specify that the message is to be sent in the flash format\t|\r\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\r\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\r\n\r\n\r\n## Advanced Parameters(Optional)\r\nThe advanced parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| format\t| Output format should be as specified by this variable\t| XML/JSON/JSONP. Default response will be in JSON\t|\r\n| callback\t| callback Callback function for JSONP response format\t| String\t|\r\n| custom1 and custom2\t| Custom reference fields\t| Alphanumeric (max 40 char)\t|\r\n| port\t| Port number to which SMS has to be sent\t| Valid integer port number above 2000\t|\r\n\r\n\r\n## Response Data\r\n\r\n| Parameter\t| Description\t|\r\n|-----------|---------------|\r\n| status\t| It indicates the success or failure of your request.\t|\r\n| message\t| It indicates the success or failure message.\t|\r\n| group_id\t| Website group id for your reference. Which is the current date\t|\r\n| data\t| All the response is wrapped in side data\t|\r\n| sms\t| Each number will be wrapped inside sms\t|\r\n| id\t| Website message id for your reference\t|\r\n| customid\t| Custom message id if you provide one\t|\r\n| customid1\t| Custom message id 1 if you provide one\t|\r\n| customid2\t| Custom message id 2 if you provide one\t|\r\n| mobile\t| Receiver Mobile number\t|\r\n| status\t| status of the message\t|\r\n\r\n## Mandatory Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"7a282ee6-8364-460b-a883-565c83ecb8fd","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/index.php?api_key={{api_key}}&method={{sms}}&unicode=1&message={{hello}}&sender={{sender_id}}&to={{to}}","host":["{{base_url}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"unicode","value":"1"},{"key":"message","value":"{{hello}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"to","value":"{{to}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <data>\r\n        <sms>\r\n            <id>e6bf8207-d226-4429-a1f0-ba0506efa539:1</id>\r\n            <customid>1</customid>\r\n            <customid1>11</customid1>\r\n            <customid2>22</customid2>\r\n            <mobile>95XXXXXXXX</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </sms>\r\n        <sms>\r\n            <id>e6bf8207-d226-4429-a1f0-ba0506efa539:2</id>\r\n            <customid>2</customid>\r\n            <customid1>1</customid1>\r\n            <customid2>2</customid2>\r\n            <mobile>99XXXXXXXX</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </sms>\r\n    </data>\r\n    <message>Campaign of 2 numbers Submitted successfully.</message>\r\n</api>"},{"id":"8e246b18-b521-47bc-8b5d-575207e99969","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/index.php?api_key={{api_key}}&method={{sms}}&unicode=1&message={{hello}}&sender={{sender_id}}&to={{to}}","host":["{{base_url}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"unicode","value":"1"},{"key":"message","value":"{{hello}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"to","value":"{{to}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"status\": \"OK\",\r\n  \"data\": [\r\n    {\r\n      \"id\": \"811436f5-0053-4ea6-8cac-b035880b8473:1\",\r\n      \"customid\": \"1\",\r\n      \"customid1\": \"11\",\r\n      \"customid2\": \"22\",\r\n      \"mobile\": \"95XXXXXXXXX\",\r\n      \"status\": \"AWAITED-DLR\"\r\n    },\r\n    {\r\n      \"id\": \"811436f5-0053-4ea6-8cac-b035880b8473:2\",\r\n      \"customid\": \"2\",\r\n      \"customid1\": \"1\",\r\n      \"customid2\": \"2\",\r\n      \"mobile\": \"97XXXXXXXX\",\r\n      \"status\": \"AWAITED-DLR\"\r\n    }\r\n  ],\r\n  \"message\": \"Campaign of 2 numbers Submitted successfully.\"\r\n}"}],"_postman_id":"32fb6a79-de25-52a4-f9b6-db2020122d84"},{"name":"Send a Port SMS ","id":"3a11c372-518e-1f3e-53bf-5b672b0662fc","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms}}&message={{hello world}}&to={{to}}&sender={{sender_id}}&port=8XXX","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"message","value":"{{hello world}}"},{"key":"to","value":"{{to}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"port","value":"8XXX"}]},"description":"Using the below API, one can send a normal or Unicode SMS to a particular port. Application port numbers can be used in SMS messages to deliver a particular SMS to an application on a mobile phone.\r\n\r\nIf any application is present and running in that particular port, the text will be received as port SMS, else the message will hit the native inbox of the mobile phone.\r\n\r\n> NOTE: The API tries to hit the application(port) for 10 seconds, if unsuccessful the message is delivered on the native inbox\r\n\r\n# Prerequisites\r\n\r\n1. An API Key\r\n2. Sender ID\r\n3. Port number\r\n\r\n#API Parameter Specifications\r\n\r\nThe API parameter specifications are described in the following sections. Mandatory parameters are must to send an SMS, while optional parameters are defined as per the user's requirement.\r\n\r\n## Optional Parameters\r\nThe optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| dlrurl\t| The encoded URL to receive delivery reports. Spiffing custom in the DLR url is mandatory.\t| delivery reports URL\t|\r\n| custom\t| Custom message ID by customer, comma separated\t| Alphanumeric (max 40 char)\t|\r\n| time\t| Date and time for scheduling an SMS\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t|\r\n| unicode\t| To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.\t| 1 / 0 / auto\t|\r\n| flash\t| To specify that the message is to be sent in the flash format\t| To specify that the message is to be sent in the flash format\t|\r\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\r\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\r\n\r\n\r\n## Advanced Parameters(Optional)\r\nThe advanced parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| format\t| Output format should be as specified by this variable\t| XML/JSON/JSONP. Default response will be in JSON\t|\r\n| callback\t| Callback function for JSONP response format\t| String\t|\r\n| custom1 and custom2\t| Custom reference fields\t| Alphanumeric (max 40 char)\t|\r\n| port\t| Port number to which SMS has to be sent\t| Valid integer port number above 2000\t|\r\n\r\n## Response Data\r\n\r\n| Parameter\t| Description\t|\r\n|-----------|---------------|\r\n| status\t| It indicates the success or failure of your request.\t|\r\n| message\t| It indicates the success or failure message.\t|\r\n| group_id\t| Website group id for your reference. Which is the current date\t|\r\n| data\t| All the response is wrapped in side data\t|\r\n| sms\t| Each number will be wrapped inside sms\t|\r\n| id\t| Website message id for your reference\t|\r\n| customid\t| Custom message id if you provide one\t|\r\n| customid1\t| Custom message id 1 if you provide one\t|\r\n| customid2\t| Custom message id 2 if you provide one\t|\r\n| mobile\t| Receiver Mobile number\t|\r\n| status\t| status of the message\t|\r\n\r\n## Mandatory Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"987d38e9-c9da-4fc8-b5dc-969cae8498a7","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms}}&message={{hello world}}&to={{to}}&sender={{sender_id}}&port=8XXX","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"message","value":"{{hello world}}"},{"key":"to","value":"{{to}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"port","value":"8XXX"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <data>\r\n        <sms>\r\n            <id>e6bf8207-d226-4429-a1f0-ba0506efa539:1</id>\r\n            <customid>1</customid>\r\n            <customid1>11</customid1>\r\n            <customid2>22</customid2>\r\n            <mobile>95XXXXXXXX</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </sms>\r\n        <sms>\r\n            <id>e6bf8207-d226-4429-a1f0-ba0506efa539:2</id>\r\n            <customid>2</customid>\r\n            <customid1>1</customid1>\r\n            <customid2>2</customid2>\r\n            <mobile>99XXXXXXXX</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </sms>\r\n    </data>\r\n    <message>Campaign of 2 numbers Submitted successfully.</message>\r\n</api>"},{"id":"c1968647-4098-4c4c-97f3-729bb01553d6","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms}}&message={{hello world}}&to={{to}}&sender={{sender_id}}&port=8XXX","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms}}"},{"key":"message","value":"{{hello world}}"},{"key":"to","value":"{{to}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"port","value":"8XXX"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"status\": \"OK\",\r\n  \"data\": [\r\n    {\r\n      \"id\": \"811436f5-0053-4ea6-8cac-b035880b8473:1\",\r\n      \"customid\": \"1\",\r\n      \"customid1\": \"11\",\r\n      \"customid2\": \"22\",\r\n      \"mobile\": \"95XXXXXXXXX\",\r\n      \"status\": \"AWAITED-DLR\"\r\n    },\r\n    {\r\n      \"id\": \"811436f5-0053-4ea6-8cac-b035880b8473:2\",\r\n      \"customid\": \"2\",\r\n      \"customid1\": \"1\",\r\n      \"customid2\": \"2\",\r\n      \"mobile\": \"97XXXXXXXX\",\r\n      \"status\": \"AWAITED-DLR\"\r\n    }\r\n  ],\r\n  \"message\": \"Campaign of 2 numbers Submitted successfully.\"\r\n}"}],"_postman_id":"3a11c372-518e-1f3e-53bf-5b672b0662fc"},{"name":"Send SMS using XML Data","id":"e1848cb7-5bae-15da-cf71-dcd47c760c73","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms.xml}}&xml=<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<api>\n<campaign></campaign>\n<unicode>0</unicode>\n<flash>0</flash>\n<sender>INFINI</sender>\n<message><![CDATA[Message from xml v4]]></message>\n<sms>\n   <to>9986136317</to>\n</sms>\n</api>","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms.xml}}"},{"key":"xml","value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<api>\n<campaign></campaign>\n<unicode>0</unicode>\n<flash>0</flash>\n<sender>INFINI</sender>\n<message><![CDATA[Message from xml v4]]></message>\n<sms>\n   <to>9986136317</to>\n</sms>\n</api>"}]},"description":"# What can you do with this API?\nThis API enables you to send an SMS using XML programming language. \n\n# Prerequisites\n1. An API Key\n2. Sender ID\n3. XML Data\n\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional parameters\nThe Optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/JSON/JSONP. Default JSON\t|\n| callback\t| Callback function for JSONP response format\t| Javascript function name standards\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n## XML Tag Parameters\n>NOTE: If message,sender and dlrurl is specified within both SMS tag and XML tag, the former overrides the later.\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| xml version=\"1.0 \"encoding=\"UTF-8\"\t| XML Header\t| Version and Encoding\t|\n| api\t| Document Root\t| Document Root\t|\n| flash\t| Global node for flash\t| 1/0\t|\n| campaign\t| Global campaign name tag\t| campaign name\t|\n| sms\t| SMS Node(can repeat)\t| SMS Node\t|\n| to\t| Mobile number in sms node\t| Comma separated 10 digit mobile numbers\t|\n| custom\t| Message ID for sms\t| comma separated message ID's\t|\n| custom1\t| Custom reference 1 (comma separate)\t| comma separated custom 1 references\t|\n| custom2\t| Custom reference 2 (comma separate)\t| comma separated custom 2 references\t|\n| sender\t| Sender ID assigned to your account\t| Sender ID\t|\n| message\t| Message to be sent. In case of any special characters in your message, enclose it within CDATA a s in the example\t| Message text\t|\n| dlrurl\t| The URL to receive delivery reports. Spiffing reference id is mandatory\t| EX:http://www.example.com/dlr.php\t|\n| unicode\t| To specify that the message to be sent is in unicode format.Also can be used for automatic detection of unicode SMS\t| 1/0/auto\t|\n| time\t| Global schedule time\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n\nIn case of special characters in the content within any of the XML tags, enclose it within CDATA as in following examples.\n\n## Sending to multiple numbers with same message\n\t<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\t<api>\n\t<campaign>campaign</campaign>\n\t<dlrurl><![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]></dlrurl>\n\t<time>2014-12-2604:00pm</time>\n\t<unicode>0</unicode>\n\t<flash>0</flash>\n\t<sender>senderid</sender>\n\t<message><![CDATA[smstext]]></message>\n\t<sms><to>9190********</to></sms>\n\t<sms><to>9191********</to></sms>\n\t</api>\n## Sending to multiple numbers with different message\n\t<api>\n\t<campaign>campaign</campaign>\n\t<time>2014-12-26 04:00pm</time>\n\t<unicode>0</unicode>\n\t<flash>0</flash>\n\t<sms>\n\t<to>9190********</to>\n\t<sender>senderid</sender>\n\t<message>smstext</message>\n\t<custom>2</custom>\n\t<dlrurl>\n\t<![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]>\n\t</dlrurl> \n\t</sms>\n\t<sms>\n\t<to>9191********</to>\n\t<sender>senderid</sender>\n\t<message><![CDATA[smstext]]></message>\n\t<custom>2</custom>\n\t<dlrurl>\n\t<![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]>\n\t</dlrurl> \n\t</sms>\n\t</api>\n\t\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"dfb34a3f-b755-4694-bfa4-ae9c83091f3c","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms.xml}}&xml=<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<api>\n<campaign></campaign>\n<unicode>0</unicode>\n<flash>0</flash>\n<sender>INFINI</sender>\n<message><![CDATA[Message from xml v4]]></message>\n<sms>\n   <to>9986136317</to>\n</sms>\n</api>","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms.xml}}"},{"key":"xml","value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<api>\n<campaign></campaign>\n<unicode>0</unicode>\n<flash>0</flash>\n<sender>INFINI</sender>\n<message><![CDATA[Message from xml v4]]></message>\n<sms>\n   <to>9986136317</to>\n</sms>\n</api>"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[],"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <data>\r\n        <group_id>150047</group_id>\r\n        <sms>\r\n            <id>150047-1</id>\r\n            <customid>22</customid>\r\n            <customid1>23</customid1>\r\n            <customid2></customid2>\r\n            <mobile>8075691152</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </sms>\r\n        <sms>\r\n            <id>150047-2</id>\r\n            <customid>99</customid>\r\n            <customid1>995</customid1>\r\n            <customid2></customid2>\r\n            <mobile>8951238427</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </sms>\r\n    </data>\r\n    <message>Campaign of 2 numbers Submitted successfully.</message>\r\n</api>"}],"_postman_id":"e1848cb7-5bae-15da-cf71-dcd47c760c73"},{"name":"Send SMS using  JSON Data ","id":"fda80e12-3774-92ff-c58e-94b05da0c667","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms.json}}&json={\n    \"sender\": \"{{sender_id}}\",\n    \"unicode\": 0,\n    \"flash\": 0,\n    \"sms\": [{\n        \"to\": \"{{to}}\",\n        \"msgid\": \"1\",\n        \"message\": \"duplicate check 123456789\",\n        \"custom1\": \"11\",\n        \"custom2\": \"22\",\n        \"sender\": \"{{sender_id}}\"\n    }]\n}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms.json}}"},{"key":"json","value":"{\n    \"sender\": \"{{sender_id}}\",\n    \"unicode\": 0,\n    \"flash\": 0,\n    \"sms\": [{\n        \"to\": \"{{to}}\",\n        \"msgid\": \"1\",\n        \"message\": \"duplicate check 123456789\",\n        \"custom1\": \"11\",\n        \"custom2\": \"22\",\n        \"sender\": \"{{sender_id}}\"\n    }]\n}"}]},"description":"# What can you do with this API?\nThis API enables you to send an SMS using JSON data to send similar message to multiple numbers or different messages to different numbers.\n\n> SMS can be sent using the JSON API by posting values to the preceding URL by the POST method with URL encoded JSON data.\n\n**If you wish to send SMS globally, the Base URL is listed below.**\n\n> https://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\n# Prerequisites\n1. An API Key\n2. Sender ID\n3. JSON Data\n\n# Example Data\nIn case of special characters in the content within any of the JSON tags, enclose it within CDATA as in following examples.\n\n## Sending to multiple numbers with same message\n\n\t{\n\t\"message\": \"test json\",\n\t\"sender\": \"AAAAAA\",\n\t\"sms\":[\n\t{\n\t\"to\": \"95XXXXXXXX\",\n\t\"msgid\": \"1\",\n\t\"message\": \"test sms\",\n\t\"custom1\": \"11\",\n\t\"custom2\": \"22\",\n\t\"sender\": \"AAAAAA\"\n\t},\n\t{\n\t\"to\": \"99XXXXXXXX\",\n\t\"msgid\": \"2\",\n\t\"custom1\": \"1\",\n\t\"custom2\": \"2\" \n\t}],\n\t\"unicode\": 1,\n\t\"flash\": 1,\n\t\"dlrurl\": \"http://www.example.com/dlr.php\" \n\t}\n\n\t\n## Sending to multiple numbers with different message\n\n\n\t\"message\": \"test json\",\n\t\"sms\":[\n\t{\n\t\"to\": \"95XXXXXXXX\",\n\t\"msgid\": \"1\",\n\t\"message\": \"test sms\",\n\t\"custom1\": \"11\",\n\t\"custom2\": \"22\",\n\t\"sender\": \"AAAAAA\" },\n\t{\n\t\"to\": \"99XXXXXXXX\",\n\t\"msgid\": \"2\",\n\t\"message\": \"json test sms\",\n\t\"custom1\": \"1\",\n\t\"custom2\": \"2\"\n\t}],\n\t\"unicode\": 1,\n\t\"flash\": 1,\n\t\"dlrurl\": \"http://www.example.com/dlr.php\"\n\t}\n\t\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional parameters\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| callback\t| Callback function for JSONP response format\t| Javascript function name standards\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n\n## JSON Tag Parameters\nIf message, sender and dlrurl is specified within both SMS tag and JSON tag, the former overrides the later.\n\n| Parameter\t| Description\t| Expected Value\t| \t|\n|-----------|---------------|-------------------|---|\n| flash\t| Global node for flash\t| 1/0\t| Optional\t|\n| sms\t| SMS Node(can repeat)\t| SMS Node\t| Mandatory\t|\n| to\t| Mobile number in sms node\t| Comma separated 10 digit mobile numbers\t| required\t|\n| custom\t| Message ID for sms\t| comma separated message ID's\t| Optional\t|\n| custom1\t| Custom reference 1 (comma separate)\t| comma separated custom 1 references\t| Optional\t|\n| custom2\t| Custom reference 2 (comma separate)\t| comma separated custom 2 references\t| Optional\t|\n| sender\t| Sender ID assigned to your account\t| Sender ID\t| Mandatory\t|\n| message\t| Message to be sent. In case of any special characters in your message, enclose it within CDATA a s in the example\t| Message text\t| Mandatory\t|\n| dlrurl\t| The URL to receive delivery reports. Spiffing reference id is mandatory\t| EX: http://www.example.com/dlr.php\t| Optional\t|\n| unicode\t| To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS\t| 1/0/auto\t| Optional\t|\n| time\t| Global schedule time\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t| Optional\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n\n## API Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"d90eaeab-fe8b-4331-909c-46c4808014f7","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms.json}}&json={\n    \"sender\": \"{{sender_id}}\",\n    \"unicode\": 0,\n    \"flash\": 0,\n    \"sms\": [{\n        \"to\": \"{{to}}\",\n        \"msgid\": \"1\",\n        \"message\": \"duplicate check 123456789\",\n        \"custom1\": \"11\",\n        \"custom2\": \"22\",\n        \"sender\": \"{{sender_id}}\"\n    }]\n}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms.json}}"},{"key":"json","value":"{\n    \"sender\": \"{{sender_id}}\",\n    \"unicode\": 0,\n    \"flash\": 0,\n    \"sms\": [{\n        \"to\": \"{{to}}\",\n        \"msgid\": \"1\",\n        \"message\": \"duplicate check 123456789\",\n        \"custom1\": \"11\",\n        \"custom2\": \"22\",\n        \"sender\": \"{{sender_id}}\"\n    }]\n}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\",\r\n    \"data\": {\r\n        \"0\": {\r\n            \"id\": \"150049-1\",\r\n            \"customid\": \"1\",\r\n            \"customid1\": \"11\",\r\n            \"customid2\": \"22\",\r\n            \"mobile\": \"8951238427\",\r\n            \"status\": \"AWAITED-DLR\"\r\n        },\r\n        \"group_id\": 150049\r\n    },\r\n    \"message\": \"Campaign of 1 numbers Submitted successfully.\"\r\n           \t \r\n            }"}],"_postman_id":"fda80e12-3774-92ff-c58e-94b05da0c667"},{"name":"Send SMS to an Optin Group","id":"ab548c53-8e9d-46b5-ff95-ca0c02ddb918","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{optin}}&sender={{sender_id}}&message={{message}}&name=optingroup","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{optin}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"message","value":"{{message}}"},{"key":"name","value":"optingroup"}]},"description":"# What can you do with this API?\n\nThrough this API, you can send exclusive messages to your subscriber / Opt in list.\n\nTo send an SMS to an opt in group,one must create a optin group and keyword associated with it in your account. Also, need to add numbers for those optin keywords to a group i.e. Optin group.\n\n# Prerequisites\n\n1. An API Key\n2. Sender ID\n3. Optin Group ID/ Name\n4. Message\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional Parameters\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n|time\t| Date and time for scheduling an SMS\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t|\n| unicode\t| To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.\t| 1 / 0 / auto\t|\n| flash\t| To specify that the message is to be sent in the flash format\t| 1 or 0\t|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| callback\t| Callback function for JSONP response format\t| String\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n## Error Codes\n\n| Status\t| Message\t|\n|-----------|-----------|\n| A430\t| Group name/id missing\t|\n| A431\t| Group is empty\t|\n| A432\t| Invalid mobile number\t|\n| A433\t| Keyword name/number missing\t|\n| A434\t| Keyword not found\t|\n| A435\t| Keyword is not active\t|\n| A436\t| No sender found!\t|\n\n\n### Example Error Response (JSON)\n\n\t{\n    \"status\": \"ERROR\",\n    \"code\": \"A431\",\n    \"message\": \"Group is empty\"\n\t}\n\n### Example Error Response (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n\t<api>\n    <status>ERROR</status>\n    <code>A431</code>\n    <message>Group is empty</message>\n\t</api>\n\t\n## Response Data\n\n| Field\t| Description\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| group_id\t| Website group id for your reference which is the current date\t|\n| data\t| All the response is wrapped in side data\t|\n| optin\t| Each number will be wrapped inside optin group\t|\n| id\t| Website message id for your reference\t|\n| customid\t| Custom message id if you provide one\t|\n| customid1\t| Custom message id 1 if you provide one\t|\n| customid2\t| Custom message id 2 if you provide one\t|\n| mobile\t| Mobile number the sms will be sent\t|\n| status\t| status of the message\t|\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"4ac34b17-8cd2-48ae-b5a7-afbc59c77c60","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{optin}}&sender={{sender_id}}&message={{hello world}}&name={{name}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{optin}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"message","value":"{{hello world}}"},{"key":"name","value":"{{name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <data>\r\n        <group_id>8334144816</group_id>\r\n        <optin>\r\n            <id>8334144806:1</id>\r\n            <customid></customid>\r\n            <customid1></customid1>\r\n            <customid2></customid2>\r\n            <mobile>9711xxxxxx</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </optin>\r\n        <optin>\r\n            <id>8334144806:2</id>\r\n            <customid></customid>\r\n            <customid1></customid1>\r\n            <customid2></customid2>\r\n            <mobile>88xxxxxxxx</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </optin>\r\n        <optin>\r\n            <id>8334144806:3</id>\r\n            <customid></customid>\r\n            <customid1></customid1>\r\n            <customid2></customid2>\r\n            <mobile>8310xxxxxx</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </optin>\r\n        <optin>\r\n            <id>8334144806:4</id>\r\n            <customid></customid>\r\n            <customid1></customid1>\r\n            <customid2></customid2>\r\n            <mobile>9986xxxxxx</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </optin>\r\n    </data>\r\n    <message>Campaign of 4 numbers Submitted successfully.</message>\r\n</api>"},{"id":"d92b6894-486b-4e32-b61d-553f89ef7aa6","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{optin}}&sender={{sender_id}}&message={{hello world}}&name={{name}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{optin}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"message","value":"{{hello world}}"},{"key":"name","value":"{{name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":" {\r\n    \"status\": \"OK\",\r\n    \"data\": {\r\n        \"0\": {\r\n            \"id\": \"4422177667:1\",\r\n            \"customid\": \"\",\r\n            \"customid1\": \"\",\r\n            \"customid2\": \"\",\r\n            \"mobile\": \"971xxxxxxx\",\r\n            \"status\": \"AWAITED-DLR\"\r\n        },\r\n        \"1\": {\r\n            \"id\": \"4422177667:2\",\r\n            \"customid\": \"\",\r\n            \"customid1\": \"\",\r\n            \"customid2\": \"\",\r\n            \"mobile\": \"88xxxxxxx\",\r\n            \"status\": \"AWAITED-DLR\"\r\n        },\r\n        \"2\": {\r\n            \"id\": \"4422177667:3\",\r\n            \"customid\": \"\",\r\n            \"customid1\": \"\",\r\n            \"customid2\": \"\",\r\n            \"mobile\": \"95xxxxxxx\",\r\n            \"status\": \"AWAITED-DLR\"\r\n        },\r\n        \"group_id\": 4422177667\r\n    },\r\n    \"message\": \"Campaign of 3 numbers Submitted successfully.\"\r\n}"}],"_postman_id":"ab548c53-8e9d-46b5-ff95-ca0c02ddb918"},{"name":"Create an SMS Group","id":"dc36ba00-96c6-c84a-8272-9e0ca9313d9f","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{create.group}}&task=save&app=1&data[name]={{name}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{create.group}}"},{"key":"task","value":"save"},{"key":"app","value":"1"},{"key":"data[name]","value":"{{name}}"}]},"description":"# What can you do with this API?\nThis API enables you to create a group of contacts from your account, so that you can simply use the group name to send SMS instead of adding multiple numbers manually. \n# Prerequisites\n1. API Key\n2. Sender ID\n3. An active Internet connection\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional Parameters\nThe Optional parameter in the HTTP API is tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\": \"ERROR\",\n    \"message\": \"Group name already exists.\",\n    \"data\": []\n\t}\n\t\n\n## \tExample Error Response (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n\t<api>\n    <status>A401A</status>\n    <message>Method Not Implemented</message>\n\t</api>\n\n## Response Data\n\n| Field\t| Description\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the responses are wrapped inside data\t|\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"70bdab25-b120-400d-84fd-2b50f4fc8954","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{create.group}}&task=save&app=1&data[name]={{name}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{create.group}}"},{"key":"task","value":"save"},{"key":"app","value":"1"},{"key":"data[name]","value":"{{name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":" {\r\n    \"status\": \"OK\",\r\n    \"message\": \"Group added Successfully\",\r\n    \"data\": []\r\n}"},{"id":"7daac6d3-497c-4f73-90ec-3d00f803f2ae","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{create.group}}&task=save&app=1&data[name]={{name}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{create.group}}"},{"key":"task","value":"save"},{"key":"app","value":"1"},{"key":"data[name]","value":"{{name}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n    <status>OK</status>\n    <message>Group added Successfully</message>\n    <data></data>\n</api>"}],"_postman_id":"dc36ba00-96c6-c84a-8272-9e0ca9313d9f"},{"name":"Add Contacts to an SMS Group","id":"0ad2b681-593f-0d00-ef4a-f420c65bead9","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{add.contacts}}&number={{phone_number}}&name={{name}}&action=add&fullname={{name}}&email={{emailid}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{add.contacts}}"},{"key":"number","value":"{{phone_number}}"},{"key":"name","value":"{{name}}"},{"key":"action","value":"add"},{"key":"fullname","value":"{{name}}"},{"key":"email","value":"{{emailid}}"}]},"description":"# What can you do with this API?\nThrough this API, you can add contacts to the SMS group you have created.\n# Prerequisites\n\n1. An API Key\n2. Sender ID\n3. SMS Group Name\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| fullname\t| name of the contact to be added\t| name of the contact\t|\n| email\t| email of the contact to be added\t| email of the contact\t|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| action\t| Flag to specify the action\t| add/delete; Add action is Default\t|\n\n## Example Error Response (JSON)\n\n\t{\n      \"status\": \"ERROR\",\n      \"code\": \"A424\",\n      \"message\": \"Group Name does not exist!\"\n\t}\n\t\n## Example Error Response (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n\t<api>\n    <status>ERROR</status>\n    <code>A424</code>\n    <message>Group Name does not exist!</message>\n\t</api>\n\t\n## Response Data\n\n| Status\t| Message\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| Code\t| Error code\t|\n| message | It indicates the success or failure message.\t|\n\n## API Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"adb0665e-8628-4628-9536-a6eaafdb57a7","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{add.contacts}}&number={{phone_number}}&name={{name}}&action=add&fullname={{name}}&email={{emailid}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{add.contacts}}"},{"key":"number","value":"{{phone_number}}"},{"key":"name","value":"{{name}}"},{"key":"action","value":"add"},{"key":"fullname","value":"{{name}}"},{"key":"email","value":"{{emailid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\",\r\n    \"code\": 200,\r\n    \"message\": \"Number updated Successfully\"\r\n}\r\n"},{"id":"b959a730-2f8d-4912-ab9f-f6627eef6ce6","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{add.contacts}}&number={{phone_number}}&name={{name}}&action=add&fullname={{name}}&email={{emailid}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{add.contacts}}"},{"key":"number","value":"{{phone_number}}"},{"key":"name","value":"{{name}}"},{"key":"action","value":"add"},{"key":"fullname","value":"{{name}}"},{"key":"email","value":"{{emailid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n<status>OK</status>\r\n<message>Number updated Successfully</message>\r\n</api>"}],"_postman_id":"0ad2b681-593f-0d00-ef4a-f420c65bead9"},{"name":"Add Contacts to SMS Group using JSON","id":"dc7e164a-57e4-7d2e-f934-2ab33e7b7f93","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{groups.json}}&name={{name}}&action=add&json=%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{groups.json}}"},{"key":"name","value":"{{name}}"},{"key":"action","value":"add"},{"key":"json","value":"%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D"}]},"description":"# What can you do with this API?\nThrough this API, you can add a single contact or multiple contacts to a group using JSON / XML data.\n\n>You need to create a group in your account to add multiple contacts to an existing valid group before using the API\n\n# Prerequisites\n1. JSON/ XML Data\n2. Group name to which contacts needs to be added\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## API Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| action\t| Flag to specify the action\t| add/delete. Add action is Default\t|\n\n\n## JSON/XML Tags\n\n| Parameter\t| Description\t|\n|-----------|---------------|\n| number\t| mobile number of the contact to be added\t|\n| fullname\t| full name of the contact\t|\n| email\t| email address of the contact\t|\n\n## Sample Data (JSON)\n\n\t{\n    \"contacts\": \n    [{ \n        \"number\": \"9xxxxxxxx\", \n        \"fullname\": \"xyz\", \n        \"email\": \"xyz@email.com\"  \n      }, \n      {\n        \"number\":\"91xxxxxxxx\",   \n        \"fullname\":\"xyz1\",\n        \"email\":\"xyz1@email.com\"  \n      }] \n\t}\n\t\n## Sample Data (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\t<xmlapi>\n\t<contacts>\n    <number>95xxxxxxxx</number>\n    <fullname>xyz</fullname>\n    <email>x@email.com</email>\n\t</contacts>\n\t<contacts>  \n    <number>99xxxxxxxx</number>\n    <fullname>xyz1</fullname>\n    <email>y@email.com</email>\n\t</contacts>\n\t</xmlapi>\n\n## Response Data\n\n| Status\t| Response\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| Code\t| Error code\t|\n| message\t| It indicates the success or failure message.\t|\n\n## API Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"651be097-69d7-4d37-b465-c0d6dbc7f0ea","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{groups.xml}}&name={{name}}&action=add&json=%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{groups.xml}}"},{"key":"name","value":"{{name}}"},{"key":"action","value":"add"},{"key":"json","value":"%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n<status>OK</status>\r\n<message>Number updated Successfully</message>\r\n</api>"},{"id":"6c31f881-3617-4ff3-8b87-2e0761a0cf2f","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{groups.json}}&name={{name}}&action=add&json=%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{groups.json}}"},{"key":"name","value":"{{name}}"},{"key":"action","value":"add"},{"key":"json","value":"%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\",\r\n    \"code\": 200,\r\n    \"message\": \"Number updated Successfully\"\r\n}"}],"_postman_id":"dc7e164a-57e4-7d2e-f934-2ab33e7b7f93"},{"name":"Add Contacts to SMS Group using XML Data","id":"cdb20cc8-64c1-4cf8-a0cc-3411bd970c1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{groups.xml}}&name={{name}}&action=add&xml=%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{groups.xml}}"},{"key":"name","value":"{{name}}"},{"key":"action","value":"add"},{"key":"xml","value":"%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D"}]},"description":"# What can you do with this API?\nThrough this API, you can add a single contact or multiple contacts to a group using JSON / XML data.\n\n>You need to create a group in your account to add multiple contacts to an existing valid group before using the API\n\n# Prerequisites\n1. JSON/ XML Data\n2. Group name to which contacts needs to be added\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## API Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| action\t| Flag to specify the action\t| add/delete. Add action is Default\t|\n\n\n## JSON/XML Tags\n\n| Parameter\t| Description\t|\n|-----------|---------------|\n| number\t| mobile number of the contact to be added\t|\n| fullname\t| full name of the contact\t|\n| email\t| email address of the contact\t|\n\n## Sample Data (JSON)\n\n\t{\n    \"contacts\": \n    [{ \n        \"number\": \"9xxxxxxxx\", \n        \"fullname\": \"xyz\", \n        \"email\": \"xyz@email.com\"  \n      }, \n      {\n        \"number\":\"91xxxxxxxx\",   \n        \"fullname\":\"xyz1\",\n        \"email\":\"xyz1@email.com\"  \n      }] \n\t}\n\t\n## Sample Data (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\t<xmlapi>\n\t<contacts>\n    <number>95xxxxxxxx</number>\n    <fullname>xyz</fullname>\n    <email>x@email.com</email>\n\t</contacts>\n\t<contacts>  \n    <number>99xxxxxxxx</number>\n    <fullname>xyz1</fullname>\n    <email>y@email.com</email>\n\t</contacts>\n\t</xmlapi>\n\n## Response Data\n\n| Status\t| Response\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| Code\t| Error code\t|\n| message\t| It indicates the success or failure message.\t|\n\n## API Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"0b3ac02b-7a94-45ff-9b15-19a837ecb65e","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{groups.json}}&name={{name}}&action=add&json=%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{groups.json}}"},{"key":"name","value":"{{name}}"},{"key":"action","value":"add"},{"key":"json","value":"%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\",\r\n    \"code\": 200,\r\n    \"message\": \"Number updated Successfully\"\r\n}"},{"id":"db4b88bc-f87f-4536-84a0-f5b0ac6fe647","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{groups.xml}}&name={{name}}&action=add&json=%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{groups.xml}}"},{"key":"name","value":"{{name}}"},{"key":"action","value":"add"},{"key":"json","value":"%7B%22sms%22%3A%20%5B%7B%20%22to%22%3A%20%229xxxxxxxx......%7D%5D%20%7D"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n<status>OK</status>\r\n<message>Number updated Successfully</message>\r\n</api>"}],"_postman_id":"cdb20cc8-64c1-4cf8-a0cc-3411bd970c1d"},{"name":"Send SMS to a Group","id":"f2266f2f-1ce1-a311-9af5-0dbd7046a817","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{groups}}&name={{name}}&sender={{sender_id}}&message={{hello world}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{groups}}"},{"key":"name","value":"{{name}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"message","value":"{{hello world}}"}]},"description":"# What can you do with this API?\nThrough this API, you'll be able to send an SMS to a group, anytime.In case, you have not added the group yet, you can create one by referring to the **[SMS Manual](https://www.kaleyra.com/PDF/alerts-user-manual.pdf)**\n\nIn your account, there must be an existing group and numbers under that group to send any message to a group. \n**The following URL enables you to integrate the URL through which you can send customized messages to the group:**\n\n>https://api-alerts.kaleyra.com/v4/?api_key=Af59xxxxxxxxxx&method=groups&name=MyGroupName&sender=AAAAAA&message=Dear {name}, Your email is {email}\n\nIn this case, {name} and {email} would be variable parameters and will be picked up from the existing group MYGROUP which is corresponding to each mobile number.\n>Response formats would be same for simple message to a group or a customized one.\n\n**If you wish to send SMS globally, the Base URL is listed below.**\n>https://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\n\n# Prerequisites\n\n1. An API Key\n2. Sender ID\n3. Group Name/ ID\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\": \"ERROR\",\n    \"code\": \"A421\",\n    \"message\": \"Group is empty/Invalid group\"\n\t}\n\n## Response Data\n\n| Field\t| Description\t|\n|-------|---------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| group_id\t| Website group id for your reference\t|\n| data\t| All the response is wrapped in side data\t|\n| groups\t| Each number will be wrapped inside groups\t|\n| id\t| Website message id for your reference\t|\n| customid\t| Custom message id if you provide one\t|\n| customid1\t| Custom message id 1 if you provide one\t|\n| customid2\t| Custom message id 2 if you provide one\t|\n| mobile\t| Mobile number the sms will be sent\t|\n| status\t| status of the message\t|\n\n## API Error Codes\n\n| Code\t| Description\t|\n|-------|---------------|\n| A420\t| Group name/id missing\t|\n| A421\t| Group is empty/Invalid group\t|\n| A422\t| Invalid mobile number\t|\n| A423\t| Group name/number missing\t|\n| A424\t| Group Name does not exist!\t|\n| A425\t| Number does not Exist\t|\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"015aa33b-2e34-4df8-b62b-18f29bdb87ba","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{groups}}&name={{name}}&sender={{sender_id}}&message={{hello world}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{groups}}"},{"key":"name","value":"{{name}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"message","value":"{{hello world}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <message>Submitted successfully</message>\r\n    <data>\r\n        <group_id>150069</group_id>\r\n        <groups>\r\n            <id>150069-1</id>\r\n            <customid></customid>\r\n            <customid1></customid1>\r\n            <customid2></customid2>\r\n            <mobile>9234567894</mobile>\r\n            <status>DUPLICATE</status>\r\n        </groups>\r\n        <groups>\r\n            <id>150069-2</id>\r\n            <customid></customid>\r\n            <customid1></customid1>\r\n            <customid2></customid2>\r\n            <mobile>7855677905</mobile>\r\n            <status>DUPLICATE</status>\r\n        </groups>\r\n    </data>\r\n</api>"},{"id":"1c34f2b1-d936-49df-b8d3-b319c96ff7bd","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{groups}}&name={{name}}&sender={{sender_id}}&message={{hello world}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{groups}}"},{"key":"name","value":"{{name}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"message","value":"{{hello world}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"OK\",\n    \"message\": \"Submitted successfully\",\n    \"data\": {\n        \"0\": {\n            \"id\": \"150051-1\",\n            \"customid\": \"\",\n            \"customid1\": \"\",\n            \"customid2\": \"\",\n            \"mobile\": \"9234567894\",\n            \"status\": \"AWAITED-DLR\"\n        },\n        \"1\": {\n            \"id\": \"150051-2\",\n            \"customid\": \"\",\n            \"customid1\": \"\",\n            \"customid2\": \"\",\n            \"mobile\": \"7855677905\",\n            \"status\": \"AWAITED-DLR\"\n        },\n        \"group_id\": 150051\n    }\n}"}],"_postman_id":"f2266f2f-1ce1-a311-9af5-0dbd7046a817"},{"name":"Check Credit Status","id":"b9d7fe39-cb69-db6b-b2ed-6b165f233e36","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{account.credits}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{account.credits}}"}]},"description":"# What can you do with this API?\n\nThrough this API, user will be able to check the available credits in his/her account.\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional Parameter\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\": \"A401A\",\n    \"message\": \"Method Not Implemented\"\n\t}\n\t\n## Example Error Response (XML)\t\n\n\t<api>\n    <status>A401A</status>\n    <message>Method Not Implemented</message>\n\t</api>\n\n## Response Data\n\n| Field\t| Description\t|\n|-------|---------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the response is wrapped in side data\t|\n| credits\t| Displays the credits available in the account\t|\n\n## Mandatory Parameters"},"response":[{"id":"8e69aeec-5a09-45a0-91f6-ede034aa7750","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key=A14d33607a2ea23d918f31144805f8fe6&method={{account.credits}}&credits=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"A14d33607a2ea23d918f31144805f8fe6"},{"key":"method","value":"{{account.credits}}"},{"key":"credits","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <code>200</code>\r\n    <message></message>\r\n    <data>\r\n        <credits>3</credits>\r\n    </data>\r\n</api>"},{"id":"ba6b68e9-6857-484d-9d36-278c9e607af2","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key=A14d33607a2ea23d918f31144805f8fe6&method={{account.credits}}&credits=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"A14d33607a2ea23d918f31144805f8fe6"},{"key":"method","value":"{{account.credits}}"},{"key":"credits","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\",\r\n    \"code\": \"200\",\r\n    \"message\": \"\",\r\n    \"data\":\r\n    {\r\n        \"credits\": \"-22\"\r\n    }\r\n}"}],"_postman_id":"b9d7fe39-cb69-db6b-b2ed-6b165f233e36"},{"name":"Check Credit Usage","id":"cbd268a5-72fd-4461-9720-e8fafad75411","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{credit_usage}}&from=2019-01-01&to=2019-01-30&format=json","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{credit_usage}}"},{"key":"from","value":"2019-01-01"},{"key":"to","value":"2019-01-30"},{"key":"format","value":"json"}]},"description":"# What can you do with this API?\n\nThrough this API, user will be able to check the credits usage in his/her account.\n\n> “from” date is mandatory field. if user misses providing “to” date in API, by default API will fetch data till yesterday's date\n\n> Past 6 months data will be available"},"response":[{"id":"6ba0466d-56db-4566-85db-28348773c899","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{credit_usage}}&from={{from_date}}&to={{to_date}}&format=xml","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{credit_usage}}"},{"key":"from","value":"{{from_date}}"},{"key":"to","value":"{{to_date}}"},{"key":"format","value":"xml"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <code>200</code>\r\n    <message></message>\r\n    <data>\r\n        <credits>3</credits>\r\n    </data>\r\n</api>"},{"id":"e1afd9aa-82af-4208-bf5b-6a89876a6150","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{credit_usage}}&from={{from_date}}&to={{to_date}}&format=json","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{credit_usage}}"},{"key":"from","value":"{{from_date}}"},{"key":"to","value":"{{to_date}}"},{"key":"format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\",\r\n    \"code\": \"200\",\r\n    \"message\": \"\",\r\n    \"data\":\r\n    {\r\n        \"credits\": \"-22\"\r\n    }\r\n}"}],"_postman_id":"cbd268a5-72fd-4461-9720-e8fafad75411"},{"name":"Check Pull SMS Status","id":"0253378a-8b67-4f06-872b-a178fa2eee81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms.status}}&id={{id}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms.status}}"},{"key":"id","value":"{{id}}"}]},"description":"# What can you do with this API?\nTo check status of any sent SMS campaign, you must have message id only (not group ID) of the respective message(s). You can only check status for messages which have been sent on the same day.\n\n> If using POST method for pulling messages status, then statuses for maximum 500 messages can be pulled at a time.\n# Prerequisites\n\n1. API key\n2. Sender ID\n3. Message ID\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/JSON/JSONP. Default response will be in JSON\t|\n| numberinfo\t| Flag to query service provider and location data\t| 1 or 0\t|\n| page\t| Page number to fetch status details from a particular page\t| 1 or more (1 page can contain maximum 500 entries)\t|\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\": \"A417\",\n    \"message\": \"Invalid Message ID/Mobile. No details found\"\n\t}\n\n## Example Error Response (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n\t<api>\n    <status>A416</status>\n    <message>Invalid Message ID/Mobile</message>\n\t</api>\n\n## Response Data\n\n| Field\t| Description\t|\n|-------|---------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the response is wrapped in side data\t|\n| sms\t| Each number will be wrapped inside sms\t|\n| id\t| Website message id for your reference\t|\n| custom1\t| Custom message id 1 if you provide one\t|\n| custom2\t| Custom message id 2 if you provide one\t|\n| mobile\t| Mobile number the sms will be sent\t|\n| status\t| status of the message\t|\n| custom\t| Custom message id if you provide one\t|\n| senttime | message sent time\t|\n| dlrtime\t| message delivered time\t|\n| provider\t| provider of the mobile numer\t|\n| location\t| Registered location of the mobile number\t|\n\n## Mandatory Parameters"},"response":[{"id":"60625229-64bf-45b3-bbfc-58293d8d6cb9","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms.status}}&id={{id}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms.status}}"},{"key":"id","value":"{{id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <data>\r\n        <sms>\r\n            <id>03b99825-f68d-4453-8ca2-4abfae107600:1</id>\r\n            <mobile>97xxxxxxxx</mobile>\r\n            <status>DELIVRD</status>\r\n            <senttime>2018-02-26 13:41:41</senttime>\r\n            <dlrtime>2018-02-26 13:41:45</dlrtime>\r\n            <custom></custom>\r\n            <custom1></custom1>\r\n            <custom2></custom2>\r\n        </sms>\r\n    </data>\r\n    <message>Processed Successfully</message>\r\n</api>"},{"id":"781893a7-9cea-40fc-b30c-011aabe696a4","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms.status}}&id={{id}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms.status}}"},{"key":"id","value":"{{id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \r\n    \"status\": \"OK\", \"data\": [ \r\n    { \r\n        \"id\": \"612c4378-84b3-496c-9123-64f248a20b88:1\",\r\n        \"mobile\": \"88xxxxxxxx\",\r\n        \"status\": \"DELIVRD\", \r\n        \"senttime\": \"2017-02-06 14:54:25\", \r\n        \"dlrtime\": \"2017-02-06 14:54:26\", \r\n        \"custom\": \"\",\r\n        \"custom1\": null,\r\n        \"custom2\": null,\r\n        \"provider\": \"\", \r\n        \"location\": \"\" \r\n    } ],\r\n    \"message\": \"Processed Successfully\" \r\n}"}],"_postman_id":"0253378a-8b67-4f06-872b-a178fa2eee81"},{"name":"Look up Using HLR Information","id":"b61a5bf0-bb97-adcd-c19a-85951f176a07","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{lookup}}&to={{phone_number}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{lookup}}"},{"key":"to","value":"{{phone_number}}"}]},"description":"# What can you do with this API?\nThrough this API, you'll be able to look up for HLR (Home Location Register) information for any valid mobile number. After performing lookup, you will be able to access HLR information only on your account. HLR information will include information about number network operator, Home Location, roaming network, ported network etc.,\n\n## API to initiate HLR on Global application\n**API 1: To trigger this API for global application, follow the API below:**\n> https://api-global.kaleyra.com/v4/?api_key=Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx5&method=hlr&to=xxxxxxxxxxxx&format=xml\n\n**API 2: An optional API is provided with same parameters, listed below:**\n> https://api-global.kaleyra.com/v4/?api_key=Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx5&method=hlr&to=xxxxxxxxxxxx&format=xml\n\n### Difference between API 1 & API 2:\n\tThe only difference between the above mentioned API are the response in the delivery status of the SMS.\n\n\tIn the API where,\n\tmethod=hlr, the delivery status is \"DELIVERED\"\n\n\twhereas in the API where,\n\tmethod=lookup, the delivery status is \"AWAITED DLR\"\n\n\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\":\"A400\",\n    \"message\":\"Api Not Implemented\"\n\t}\n\n## Example Error Response (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n\t<api>\n    <status>E608</status>\n    <message>No Valid mobile numbers found</message>\n\t</api>\n\n## Response Data\n\n| Field\t| Description\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the responses are wrapped inside data\t|\n| Mobile\t| Mobile number\t|\n| id\t| External message ID\t|\n\n## API Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"4c3caa90-38f7-45e7-af92-ce50100b1da2","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{lookup}}&to={{phone_number}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{lookup}}"},{"key":"to","value":"{{phone_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <data>\r\n        <lookup>\r\n            <id>234909-1</id>\r\n            <customid></customid>\r\n            <customid1></customid1>\r\n            <customid2></customid2>\r\n            <mobile>9711xxxxxx</mobile>\r\n            <status>AWAITED-DLR</status>\r\n        </lookup>\r\n    </data>\r\n    <message>Campaign of 1 numbers Submitted successfully.</message>\r\n</api>"},{"id":"ca00da46-ab99-426e-afae-9c91526c994e","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{lookup}}&to={{phone_number}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{lookup}}"},{"key":"to","value":"{{phone_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\",\r\n    \"data\": [\r\n    {\r\n        \"id\": \"336-1\",\r\n        \"customid\": \"\",\r\n        \"customid1\": \"\",\r\n        \"customid2\": \"\",\r\n        \"mobile\": \"97XXXXXXXX\",\r\n        \"status\": \"AWAITED-DLR\"\r\n    }],\r\n    \"message\": \"Campaign of 1 numbers Submitted successfully.\"\r\n}"}],"_postman_id":"b61a5bf0-bb97-adcd-c19a-85951f176a07"},{"name":"Look up using JSON Data","id":"8c25bddf-79a9-45dc-001b-807c2f369c8e","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{lookup.json}}&json={\"lookup\": [{\n\"to\": \"{{to}}\"\n}, {\n\"to\": \"{{to}}\"\n}], \"dlrurl\": \"http://www.example.com/dlr.php/......\"\n}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{lookup.json}}"},{"key":"to","value":"{{to}}","disabled":true},{"key":"json","value":"{\"lookup\": [{\n\"to\": \"{{to}}\"\n}, {\n\"to\": \"{{to}}\"\n}], \"dlrurl\": \"http://www.example.com/dlr.php/......\"\n}"}]},"description":"# What can you do with this API?\nThrough this API, you'll be able to perform LookUp to access HLR information for single or multiple numbers using XML/JSON data.\n\n## API to Lookup using JSON Data\n\t\n\thttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.json&to=92xxxxxxxx&json=%3A%2F%2Fdomain.net%2F.......\n\n## API to Lookup using XML Data\n\t\n\thttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.xml&to=92xxxxxxxx&xml=%3A%2F%2Fdomain.net%2F.......\n# Prerequisites\n\n1. Valid Mobile Number(s)\n2. XMl/JSON Data\n\n## Sample DLR URL\n\t\n\thttp%3A%2F%2Fdomain.net%2Fdlr%2Ftrigger.php%3Forig_network%3D%7Borig_network%7D%26orig_country%3D%7Borig_country%7D%26orig_circle%3D%7Borig_circle%7D%26%0D%0Aorig_cprefix%3D%7Borig_cprefix%7D%26orig_nprefix%3D%7Borig_nprefix%7D%26orig_code%3D%7Borig_code%7D%26is_roaming%3D%7Bis_roaming%7D%26roaming_network%3D%7Broaming_network%7D%26roaming_country%3D%7Broaming_country%7D%26roaming_circle%3D%7Broaming_circle%7D%26roaming_cprefix%3D%7Broaming_cprefix%7D%26roaming_nprefix%3D%7Broaming_nprefix%7D%26roaming_code%3D%7Broaming_code%7D%26is_ported%3D%7Bis_ported%7D%26ported_network%3D%7B+ported_network%7D%26ported_country%3D%7Bported_country%7D%26ported_circle%3D%7Bported_circle%7D%26ported_cprefix%3D%7Bported_cprefix%7D%26ported_nprefix%3D%7Bported_nprefix%7D%26ported_code%3D%7Bported_code%7D%26mcc%3D%7Bmcc%7D%26mnc%3D%7Bmnc%7D%26imsi%3D%7Bimsi%7D%26status%3D%7Bstatus%7D%26smsc%3D%7Bsmsc%7D%26err_code%3D%7Berr_code%7D\n\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional API Parameters\nThe Optional parameter in HTTP API is tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n\n\n## Custom XML/JSON Tags\n\n| Field Name\t| Description\t|\n|-----------|-------------------|\n| {orig_country}\t| Original Country Name\t|\n| {orig_circle}\t| From which circle, number does belong originally\t|\n| {orig_cprefix}\t| Original Country Prefix\t|\n| {orig_nprefix}\t| Original Network Prefix\t|\n| {orig_code}\t| Original geographical circle code\t|\n| {is_roaming}\t| Whether number is in roaming or not\t|\n| {roaming_network}\t| Roaming Network Name\t|\n| {roaming_country}\t| Roaming Country Name\t|\n| {roaming_circle}\t| In which circle current number is under roaming\t|\n| {orig_network}\t| Original Network Name\t|\n| {roaming_cprefix}\t| Roaming Country Prefix\t|\n| {roaming_nprefix}\t| Roaming Network Prefix\t|\n| {roaming_code}\t| Geographical roaming circle code\t|\n| {is_ported}\t| Whether number has been ported or not\t|\n| {ported_network}\t| Ported Network Name\t|\n| {ported_country}\t| Ported Country Name\t|\n| {ported_nprefix}\t| Ported Network Prefix\t|\n| {ported_code}\t| Geographical ported circle code\t|\n| {mcc}\t| Mobile country code used in the combination of mobile network code to uniquely identify an operator\t|\n| {mnc}\t| Mobile country code used in the combination of mobile network code to uniquely identify an operator\t|\n| {imsi}\t| 15-digit IMSI number of the mobile subscriber's phone number (MSISDN)\t|\n| {ported_circle}\t| To which circle this number has been ported\t|\n| {ported_cprefix}\t| Ported Country Prefix\t|\n| {status}\t| It indicates the success or failure of your request.\t|\n| {smsc}\t| SMS Centre number\t|\n| {err_code}\t| If there is any error or not\t|\n\n\n## Response Data\n\n| Field Name\t| Description\t|\n|-----------|-------------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the responses is wrapped inside data\t|\n| Mobile\t| Mobile number\t|\n| id\t| External message ID\t|\n\n## Mandatory API Specifications\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"13d86c30-2c23-1a92-b4a4-2248fb30758c","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key=A14d33607a2ea23d918f31144805f8fe6&method={{lookup.json}}&json={\n    \"lookup\": [{\n        \"to\": \"{{to}}\"\n    }],\n    \"dlrurl\": \"http://www.example.com/dlr.php/......\"\n}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"A14d33607a2ea23d918f31144805f8fe6"},{"key":"method","value":"{{lookup.json}}"},{"key":"json","value":"{\n    \"lookup\": [{\n        \"to\": \"{{to}}\"\n    }],\n    \"dlrurl\": \"http://www.example.com/dlr.php/......\"\n}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"private, no-cache, no-store, proxy-revalidate, no-transform, must-revalidate, max-age=600","description":""},{"name":"content-disposition","key":"content-disposition","value":"attachment; filename=\"api.json\"","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Thu, 10 Jan 2019 07:27:08 GMT","description":""},{"name":"expires","key":"expires","value":"Sat, 26 Jul 1997 05:00:00 GMT","description":""},{"name":"pragma","key":"pragma","value":"no-cache","description":""},{"name":"server","key":"server","value":"","description":""},{"name":"status","key":"status","value":"200","description":""},{"name":"strict-transport-security","key":"strict-transport-security","value":"max-age=86400; includeSubDomains","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-permitted-cross-domain-policies","key":"x-permitted-cross-domain-policies","value":"none","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":"82","body":"{\r\n\"status\": \"OK\",\r\n\"data\": [\r\n{\r\n\"id\": \"336-1\",\r\n\"customid\": \"\",\r\n\"customid1\": \"\",\r\n\"customid2\": \"\",\r\n\"mobile\": \"97XXXXXXXX\",\r\n\"status\": \"AWAITED-DLR\"\r\n}],\r\n\"message\": \"Campaign of 1 numbers Submitted successfully.\"\r\n}\r\n"}],"_postman_id":"8c25bddf-79a9-45dc-001b-807c2f369c8e"},{"name":"Look up using XML Data","id":"b8b2854d-5f10-4b4f-8525-cd3a0be527bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{lookup.xml}}&to={{phone_number}}&xml=<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<dlrurl>\n   <![CDATA[http://domain.com/dlr.php]]>\n</dlrurl>\n<lookup>\n  <to>{{to}}</to>\n</lookup>\n</xmlapi>","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{lookup.xml}}"},{"key":"to","value":"{{phone_number}}"},{"key":"xml","value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<dlrurl>\n   <![CDATA[http://domain.com/dlr.php]]>\n</dlrurl>\n<lookup>\n  <to>{{to}}</to>\n</lookup>\n</xmlapi>"}]},"description":"# What can you do with this API?\nThrough this API, you'll be able to perform LookUp to access HLR information for single or multiple numbers using XML/JSON data.\n\n## API to Lookup using JSON Data\n\t\n\thttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.json&to=92xxxxxxxx&json=%3A%2F%2Fdomain.net%2F.......\n\n## API to Lookup using XML Data\n\t\n\thttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.xml&to=92xxxxxxxx&xml=%3A%2F%2Fdomain.net%2F.......\n# Prerequisites\n\n1. Valid Mobile Number(s)\n2. XMl/JSON Data\n\n## Sample DLR URL\n\t\n\thttp%3A%2F%2Fdomain.net%2Fdlr%2Ftrigger.php%3Forig_network%3D%7Borig_network%7D%26orig_country%3D%7Borig_country%7D%26orig_circle%3D%7Borig_circle%7D%26%0D%0Aorig_cprefix%3D%7Borig_cprefix%7D%26orig_nprefix%3D%7Borig_nprefix%7D%26orig_code%3D%7Borig_code%7D%26is_roaming%3D%7Bis_roaming%7D%26roaming_network%3D%7Broaming_network%7D%26roaming_country%3D%7Broaming_country%7D%26roaming_circle%3D%7Broaming_circle%7D%26roaming_cprefix%3D%7Broaming_cprefix%7D%26roaming_nprefix%3D%7Broaming_nprefix%7D%26roaming_code%3D%7Broaming_code%7D%26is_ported%3D%7Bis_ported%7D%26ported_network%3D%7B+ported_network%7D%26ported_country%3D%7Bported_country%7D%26ported_circle%3D%7Bported_circle%7D%26ported_cprefix%3D%7Bported_cprefix%7D%26ported_nprefix%3D%7Bported_nprefix%7D%26ported_code%3D%7Bported_code%7D%26mcc%3D%7Bmcc%7D%26mnc%3D%7Bmnc%7D%26imsi%3D%7Bimsi%7D%26status%3D%7Bstatus%7D%26smsc%3D%7Bsmsc%7D%26err_code%3D%7Berr_code%7D\n\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional API Parameters\nThe Optional parameter in HTTP API is tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n\n\n## Custom XML/JSON Tags\n\n| Field Name\t| Description\t|\n|-----------|-------------------|\n| {orig_country}\t| Original Country Name\t|\n| {orig_circle}\t| From which circle, number does belong originally\t|\n| {orig_cprefix}\t| Original Country Prefix\t|\n| {orig_nprefix}\t| Original Network Prefix\t|\n| {orig_code}\t| Original geographical circle code\t|\n| {is_roaming}\t| Whether number is in roaming or not\t|\n| {roaming_network}\t| Roaming Network Name\t|\n| {roaming_country}\t| Roaming Country Name\t|\n| {roaming_circle}\t| In which circle current number is under roaming\t|\n| {orig_network}\t| Original Network Name\t|\n| {roaming_cprefix}\t| Roaming Country Prefix\t|\n| {roaming_nprefix}\t| Roaming Network Prefix\t|\n| {roaming_code}\t| Geographical roaming circle code\t|\n| {is_ported}\t| Whether number has been ported or not\t|\n| {ported_network}\t| Ported Network Name\t|\n| {ported_country}\t| Ported Country Name\t|\n| {ported_nprefix}\t| Ported Network Prefix\t|\n| {ported_code}\t| Geographical ported circle code\t|\n| {mcc}\t| Mobile country code used in the combination of mobile network code to uniquely identify an operator\t|\n| {mnc}\t| Mobile country code used in the combination of mobile network code to uniquely identify an operator\t|\n| {imsi}\t| 15-digit IMSI number of the mobile subscriber's phone number (MSISDN)\t|\n| {ported_circle}\t| To which circle this number has been ported\t|\n| {ported_cprefix}\t| Ported Country Prefix\t|\n| {status}\t| It indicates the success or failure of your request.\t|\n| {smsc}\t| SMS Centre number\t|\n| {err_code}\t| If there is any error or not\t|\n\n\n## Response Data\n\n| Field Name\t| Description\t|\n|-----------|-------------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the responses is wrapped inside data\t|\n| Mobile\t| Mobile number\t|\n| id\t| External message ID\t|\n\n## Mandatory API Specifications\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"1d223e61-a00f-4268-b0c3-b2990feef3d9","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{lookup.xml}}&to={{phone_number}}&xml=<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<dlrurl>\n   <![CDATA[http://domain.com/dlr.php]]>\n</dlrurl>\n<lookup>\n  <to>890464xxxx</to>\n</lookup>\n</xmlapi>","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{lookup.xml}}"},{"key":"to","value":"{{phone_number}}"},{"key":"xml","value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<dlrurl>\n   <![CDATA[http://domain.com/dlr.php]]>\n</dlrurl>\n<lookup>\n  <to>890464xxxx</to>\n</lookup>\n</xmlapi>"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"name":"cache-control","key":"cache-control","value":"private, no-cache, no-store, proxy-revalidate, no-transform, must-revalidate, max-age=600","description":""},{"name":"content-disposition","key":"content-disposition","value":"attachment; filename=\"api.json\"","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Thu, 10 Jan 2019 07:27:08 GMT","description":""},{"name":"expires","key":"expires","value":"Sat, 26 Jul 1997 05:00:00 GMT","description":""},{"name":"pragma","key":"pragma","value":"no-cache","description":""},{"name":"server","key":"server","value":"","description":""},{"name":"status","key":"status","value":"200","description":""},{"name":"strict-transport-security","key":"strict-transport-security","value":"max-age=86400; includeSubDomains","description":""},{"name":"x-content-type-options","key":"x-content-type-options","value":"nosniff","description":""},{"name":"x-frame-options","key":"x-frame-options","value":"SAMEORIGIN","description":""},{"name":"x-permitted-cross-domain-policies","key":"x-permitted-cross-domain-policies","value":"none","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"","description":""},{"name":"x-xss-protection","key":"x-xss-protection","value":"1; mode=block","description":""}],"cookie":[],"responseTime":null,"body":"<api>\n    <status>OK</status>\n    <data>\n        <lookup>\n            <id>337-1</id>\n            <customid></customid>\n            <customid1></customid1>\n            <customid2></customid2>\n            <mobile>97XXXXXXXX</mobile>\n            <status>AWAITED-DLR</status>\n        </lookup>\n    </data>\n    <message>Campaign of 1 numbers Submitted successfully.</message>\n</api>"}],"_postman_id":"b8b2854d-5f10-4b4f-8525-cd3a0be527bc"},{"name":"Create a Txtly Link","id":"9d24c15f-d86a-b964-7551-7f1504c1460b","request":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly.create}}&url=txtly_url&token={{name}}&title={{name}}&advanced=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly.create}}"},{"key":"url","value":"txtly_url"},{"key":"token","value":"{{name}}"},{"key":"title","value":"{{name}}"},{"key":"advanced","value":"1"}]},"description":"# What can you do with this API?\r\nTxtly is basically a shortened URL which can be used within text messages so that SMS would not exceed the specified characters.\r\n\r\n> NOTE: It is mandatory to either provide a URL or attachment that has to be compressed to a short link\r\n### Txtly {advanced} token\r\n\r\nIf Txtly URL has been sent via SMS to customers with analytics enabled, then this will be valid only for 3days. After 3 days, user will be redirected to the valid URL but their mobile numbers would not be captured.\r\n\r\n# Prerequisites\r\n\r\n1. An API Key\r\n2. Sender ID\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional API Parameters\r\nThe Optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| Format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\r\n| Token\t| http://msg.mn/heel Here heel is the token. It is unique for each txtly\t| This can be customized word representing your brand/company. If not provided a random unique token is generated\t|\r\n| Title\t| A significant title to your txtly\t| If not provided, your txtly will not contain any title\t|\r\n| Advanced\t| advanced analytics gives an option to track who (Recipient mobile numbers) visited the page\t| 1- will enable advanced analytics/0(default) - will disable advanced analytics.\t|\r\n| Track\t| Location Track gives the city and state details of URL visitor\t| 1- will enable location tracking/0(default) - will disable location tracking\t|\r\n| Attach\t| Media file that requires to be compressed to a short link.\t| Provide the media file in a CURL request\t|\r\n\r\n## Example Error Response (JSON)\r\n\r\n\t{\r\n    \"status\": \"E500\",\r\n    \"message\": \"Please provide url to redirect\"\r\n\t}\r\n\r\n## Example Error Response (XML)\r\n\r\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n\t<api>\r\n    <status>E500</status>\r\n    <message>Please provide url to redirect</message>\r\n\t</api>\r\n\r\n## Response Data\r\n\r\n| Field\t| Description\t|\r\n|-------|---------------|\r\n| status\t| It indicates the success or failure of your request.\t|\r\n| message\t| It indicates the success or failure message.\t|\r\n| token\t| Returns the unique token of that txtly\t|\r\n| txtly\t| compressed url that is ready to use\t|\r\n| id\t| ID of the txtly created\t|\r\n\r\n\r\n## Mandatory API Specifications\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"6ad6c7e2-cb80-4e55-a7d5-e43090027154","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly.create}}&url=txtly_url&token={{name}}&title={{name}}&advanced=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly.create}}"},{"key":"url","value":"txtly_url"},{"key":"token","value":"{{name}}"},{"key":"title","value":"{{name}}"},{"key":"advanced","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <message>Details saved Successfully</message>\r\n    <token>fxz7iD</token>\r\n    <id>205298546</id>\r\n    <txtly>http://msg.mn/fxz7iD/{advanced}</txtly>\r\n</api>"},{"id":"e1adb34d-099e-4803-9121-c3966758e8cb","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly.create}}&url=txtly_url&token={{name}}&title={{name}}&advanced=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly.create}}"},{"key":"url","value":"txtly_url"},{"key":"token","value":"{{name}}"},{"key":"title","value":"{{name}}"},{"key":"advanced","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\",\r\n    \"message\": \"Details saved Successfully\",\r\n    \"token\": \"5yx1\",\r\n    \"id\":\"33527\",\r\n    \"txtly\": \"http://msg.mn/bKX6yf\" \r\n}"}],"_postman_id":"9d24c15f-d86a-b964-7551-7f1504c1460b"},{"name":"Extract Txtly Reports","id":"4c90004c-a2f4-4934-a9e8-1cbc88245653","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly}}"},{"key":"app","value":"1"}]},"description":"# What can you do with this API?\nThrough this API, you can extract the reports of all the Txtly links that have been shortened in your account. At once, user may pull maximum 25 Txtly reports.\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional API Parameters\nThe Optional parameter in the HTTP API is tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| page\t| Page number to fetch Txtly reports from a particular page\t| 1 or more (1 page can contain maximum 25 Txtly reports)\t|\n\n## Mandatory API Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"915d3d33-6405-4ebd-a817-b26e77c2f441","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly}}"},{"key":"app","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <message>OK</message>\r\n    <data>\r\n        <txtlys>\r\n            <txtly>\r\n                <link_id>205289433</link_id>\r\n                <title></title>\r\n                <token>FUDmQf</token>\r\n                <long_url>https://drive.google.com/drive/u/0/folders/1P2Psa8E2ZgyjzaBe82fqnJwukGVDk8Xu</long_url>\r\n                <advanced>0</advanced>\r\n                <link_type>URL</link_type>\r\n                <callback></callback>\r\n                <meta_value>{\"track\":null}</meta_value>\r\n                <views>1</views>\r\n                <last_viewed>1519729850</last_viewed>\r\n                <status>1</status>\r\n                <created>1519729790</created>\r\n                <serial>1</serial>\r\n                <short_url>http://msg.mn/FUDmQf</short_url>\r\n                <uw>0</uw>\r\n            </txtly>\r\n            <txtly>\r\n                <link_id>205288597</link_id>\r\n                <title></title>\r\n                <token>JmxY!x</token>\r\n                <long_url>asferger,gmerklgtwmg;t;ltltw;l</long_url>\r\n                <advanced>0</advanced>\r\n                <link_type>URL</link_type>\r\n                <callback></callback>\r\n                <meta_value>{\"track\":null}</meta_value>\r\n                <views>0</views>\r\n                <last_viewed>0</last_viewed>\r\n                <status>1</status>\r\n                <created>1519728702</created>\r\n                <serial>2</serial>\r\n                <short_url>http://msg.mn/JmxY!x</short_url>\r\n                <uw>0</uw>\r\n            </txtly>\r\n            <txtly>\r\n                <link_id>187361485</link_id>\r\n                <title></title>\r\n                <token>JqXY1P</token>\r\n                <long_url>https://www.solutionsinfini.com/contact</long_url>\r\n                <advanced>0</advanced>\r\n                <link_type>URL</link_type>\r\n                <callback></callback>\r\n                <meta_value>null</meta_value>\r\n                <views>5</views>\r\n                <last_viewed>1518678249</last_viewed>\r\n                <status>1</status>\r\n                <created>1518678069</created>\r\n                <serial>5</serial>\r\n                <short_url>http://msg.mn/JqXY1P</short_url>\r\n                <uw>0</uw>\r\n            </txtly>\r\n            <txtly>\r\n                <link_id>149542362</link_id>\r\n                <title>testing induction</title>\r\n                <token>nadhi</token>\r\n                <long_url>https://www.domain.com/contact/helpus</long_url>\r\n                <advanced>1</advanced>\r\n                <link_type>URL</link_type>\r\n                <callback></callback>\r\n                <meta_value>null</meta_value>\r\n                <views>1</views>\r\n                <last_viewed>1519623347</last_viewed>\r\n                <status>1</status>\r\n                <created>1516168538</created>\r\n                <serial>7</serial>\r\n                <short_url>http://msg.mn/tokentest/{advanced}</short_url>\r\n                <uw>0</uw>\r\n            </txtly>\r\n        </txtlys>\r\n        <pagination>\r\n            <now>25</now>\r\n            <next>2</next>\r\n            <page>1</page>\r\n            <limit>25</limit>\r\n            <limitstart>0</limitstart>\r\n            <total>100564</total>\r\n            <extra></extra>\r\n        </pagination>\r\n    </data>\r\n</api>\r\n            \r\n            \t\r\n            "},{"id":"eaa77b3c-7157-465f-be15-b1a57c884671","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly}}"},{"key":"app","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"            {\r\n            \t\"status\": \"OK\",\r\n            \t\"message\": \"OK\",\r\n            \t\"data\": {\r\n            \t\t\"txtlys\": [{\r\n            \t\t\t\t\"link_id\": \"426272\",\r\n            \t\t\t\t\"title\": \"\",\r\n            \t\t\t\t\"token\": \"Eu6uVN\",\r\n            \t\t\t\t\"long_url\": \"https://www.google.co.in/search?q= url. & oq = solut & aqs = chrome.1.69 i60j69i59j69i60l3j69i57 .2228 j0j7 &sourceid = chrome & ie = UTF - 8 \",\r\n            \t\t\t\t\"advanced\": \"0\",\r\n            \t\t\t\t\"link_type\": \"URL\",\r\n            \t\t\t\t\"callback\": \"\",\r\n            \t\t\t\t\"meta_value\": \"{\\\"track\\\":null}\",\r\n            \t\t\t\t\"views\": \"1\",\r\n            \t\t\t\t\"last_viewed\": \"1486730380\",\r\n            \t\t\t\t\"status\": \"1\",\r\n            \t\t\t\t\"created\": \"1486730303\",\r\n            \t\t\t\t\"serial\": 1,\r\n            \t\t\t\t\"short_url\": \"http://msg.mn/Eu6uVN\"\r\n            \t\t\t},\r\n            \t\t\t{\r\n            \t\t\t\t\"link_id\": \"426068\",\r\n            \t\t\t\t\"title\": \"\",\r\n            \t\t\t\t\"token\": \"wNO6c2\",\r\n            \t\t\t\t\"long_url\": \"https://www.google.co.in\",\r\n            \t\t\t\t\"advanced\": \"0\",\r\n            \t\t\t\t\"link_type\": \"URL\",\r\n            \t\t\t\t\"callback\": \"\",\r\n            \t\t\t\t\"meta_value\": \"{\\\"track\\\":null}\",\r\n            \t\t\t\t\"views\": \"0\",\r\n            \t\t\t\t\"last_viewed\": \"0\",\r\n            \t\t\t\t\"status\": \"1\",\r\n            \t\t\t\t\"created\": \"1486725578\",\r\n            \t\t\t\t\"serial\": 2,\r\n            \t\t\t\t\"short_url\": \"http://msg.mn/wNO6c2\"\r\n            \t\t\t},\r\n            \t\t\t{\r\n            \t\t\t\t\"link_id\": \"426067\",\r\n            \t\t\t\t\"title\": \"\",\r\n            \t\t\t\t\"token\": \"KcIaHc\",\r\n            \t\t\t\t\"long_url\": \"https://www.google.co.in\",\r\n            \t\t\t\t\"advanced\": \"0\",\r\n            \t\t\t\t\"link_type\": \"URL\",\r\n            \t\t\t\t\"callback\": \"\",\r\n            \t\t\t\t\"meta_value\": \"{\\\"track\\\":null}\",\r\n            \t\t\t\t\"views\": \"0\",\r\n            \t\t\t\t\"last_viewed\": \"0\",\r\n            \t\t\t\t\"status\": \"1\",\r\n            \t\t\t\t\"created\": \"1486725490\",\r\n            \t\t\t\t\"serial\": 3,\r\n            \t\t\t\t\"short_url\": \"http://msg.mn/KcIaHc\"\r\n            \t\t\t}\r\n            \t\t],\r\n            \t\t\"pagination\": {\r\n            \t\t\t\"now\": 3,\r\n            \t\t\t\"next\": false,\r\n            \t\t\t\"page\": 1,\r\n            \t\t\t\"limit\": 25,\r\n            \t\t\t\"limitstart\": 0,\r\n            \t\t\t\"total\": 3,\r\n            \t\t\t\"extra\": null\r\n            \t\t}\r\n            \t}\r\n            }"}],"_postman_id":"4c90004c-a2f4-4934-a9e8-1cbc88245653"},{"name":"Pull Individual Txtly Logs","id":"038040aa-e55d-49f6-9b62-60e0e67b049a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly.logs}}&id={{id}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly.logs}}"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}]},"description":"# What can you do with this API?\r\nThrough this API, you can pull out event logs for a particular Txtly URL. You must have created and executed any Txtly campaign so as to track its views/clicked logs.\r\n\r\n\r\n# Prerequisites\r\n1. An active API Key\r\n2. Txtly ID\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Mandatory API Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"2da9f392-2b6c-4d1d-aad1-2f0c53d95c76","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly.logs}}&id={{id}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly.logs}}"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <message>OK</message>\r\n    <data>\r\n        <txtlys>\r\n            <logs>\r\n                <log_id>54988250</log_id>\r\n                <fkuserid>7458555450</fkuserid>\r\n                <fk_link_id>205289493</fk_link_id>\r\n                <client_ip>170.151.41.80</client_ip>\r\n                <scheme></scheme>\r\n                <host></host>\r\n                <query_string></query_string>\r\n                <user_agent>Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Safari/537.36</user_agent>\r\n                <browser>Chrome</browser>\r\n                <browser_version>63.0.3239.</browser_version>\r\n                <browser_lang>en</browser_lang>\r\n                <browser_engine>Blink</browser_engine>\r\n                <resolution></resolution>\r\n                <platform>Windows</platform>\r\n                <platform_version>10</platform_version>\r\n                <device_type>desktop</device_type>\r\n                <device_brand></device_brand>\r\n                <device_version></device_version>\r\n                <device_model></device_model>\r\n                <touch_enabled>0</touch_enabled>\r\n                <latitude>12.9833</latitude>\r\n                <longitude>77.5833</longitude>\r\n                <country>India</country>\r\n                <region>Karnataka</region>\r\n                <city>Bengaluru</city>\r\n                <status>1</status>\r\n                <created>27-Feb-2018 04:40 PM</created>\r\n                <mobile></mobile>\r\n                <serial>1</serial>\r\n            </logs>\r\n        </txtlys>\r\n        <pagination>\r\n            <now>1</now>\r\n            <next></next>\r\n            <page>1</page>\r\n            <limit>25</limit>\r\n            <limitstart>0</limitstart>\r\n            <total>1</total>\r\n            <extra></extra>\r\n        </pagination>\r\n    </data>\r\n</api>"},{"id":"e1745a6e-4b89-4c24-85ab-3c14859f710b","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly.logs}}&id={{id}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly.logs}}"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\", \r\n    \"message\": \"OK\",\r\n    \"data\":\r\n    {\r\n        \"txtlys\":\r\n        [{\r\n            \"log_id\": \"11219199\",\r\n            \"fkuserid\": \"7458555458\",\r\n            \"fk_link_id\": \"426272\",\r\n            \"client_ip\": \"240520452894295621769\",\r\n            \"scheme\": \"\",\r\n            \"host\": \"\",\r\n            \"query_string\": \"\",\r\n            \"user_agent\": \"Mozilla/5.0 \r\n            (Linux; Android 7.0; Moto G(4)\r\n            Build/NPJ25.93-14)AppleWebKit/537.36\r\n            (KHTML,like Gecko)          \r\n            Chrome/55.0.2883.91 Mobile Safari/537.36\",\r\n            \"browser\": \"Chrome Mobile\",\r\n            \"browser_version\": \"55.0.2883.\",\r\n            \"browser_lang\": \"en\",\r\n            \"browser_engine\": \"Blink\",\r\n            \"resolution\": \"\",\r\n            \"platform\": \"Android\",\r\n            \"platform_version\": \"7.0\",\r\n            \"device_type\": \"smartphone\",\r\n            \"device_brand\": \"Motorola\",\r\n            \"device_version\": \"\",\r\n            \"device_model\": \"\",\r\n            \"touch_enabled\": \"0\",\r\n            \"latitude\": \"\",\r\n            \"longitude\": \"\",\r\n            \"country\": \"\",\r\n            \"region\": \"\",\r\n            \"city\": \"\",\r\n            \"status\": \"1\",\r\n            \"created\": \"10-Feb 06:09 PM\",\r\n            \"mobile\": null,\r\n            \"serial\": 1 \r\n        }], \r\n        \"pagination\":\r\n        { \r\n            \"now\": 1, \r\n            \"next\": false, \r\n            \"page\": 1,\r\n            \"limit\": 25,\r\n            \"limitstart\": 0,\r\n            \"total\": 1,\r\n            \"extra\": null \r\n        } \r\n    }\r\n}"}],"_postman_id":"038040aa-e55d-49f6-9b62-60e0e67b049a"},{"name":"Delete a Txtly Link","id":"a5297513-773c-44ff-93fd-f510f719b400","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly}}&task=delete&id={{id}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly}}"},{"key":"task","value":"delete"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}]},"description":"# What can you do with this API?\r\nThis API enables you to delete the created Txtly web link. If Txtly URL got deleted, then user wont be able to use it and redirect anywhere.\r\n\r\n> User must have a Txtly ID to delete the associated Txtly URL from the database.\r\n\r\n# Prerequisites\r\n1. An active API Key\r\n2. Txtly ID\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional API parameters\r\nThe Optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\r\n\r\n## Example Error Response (JSON)\r\n\r\n\t{\r\n    \"status\": \"ERROR\",\r\n    \"message\": \"Id entered not exits with this api user\", \"data\": []\r\n\t}\r\n\r\n## Example Error Response (XML)\r\n\r\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n\t<api>\r\n    <status>ERROR</status>\r\n    <message>Id entered not exits with this api user</message>\r\n    <data></data>\r\n\t</api>\r\n\r\n## Response Data\r\n\r\n| Field\t| Description\t|\r\n|-------|---------------|\r\n| status\t| It indicates the success or failure of your request.\t|\r\n| message\t| It indicates the success or failure message.\t|\r\n| data\t| All the responses is wrapped inside data\t|\r\n\r\n## Mandatory API Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"0a8f0ef3-d042-41f0-b6be-340f2a006967","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly}}&task=delete&id={{id}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly}}"},{"key":"task","value":"delete"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>OK</status>\r\n    <message>Deleted successfully..</message>\r\n    <data></data>\r\n</api>"},{"id":"1097201f-a44c-4d60-b534-b5bdb0be4213","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{txtly}}&task=delete&id={{id}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly}}"},{"key":"task","value":"delete"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \r\n    \"status\": \"OK\",\r\n    \"message\": \"Deleted successfully..\", \"data\": [ ]\r\n}"}],"_postman_id":"a5297513-773c-44ff-93fd-f510f719b400"},{"name":"Send an Email","id":"d8f8a125-d2ef-4c43-92b7-ca185d441a6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{email}}&task=delete&id={{id}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"task","value":"delete"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}]},"description":"# What can you do with this API?\r\nThrough Email API, you can send email to multiple contacts, schedule emails and track analytics of such emails. You can use any of the following email content parameters while executing email campaigns:\r\n### Email Content Parameters\r\n1. Text - plain text content to be sent\r\n2. Html - full html content to be sent\r\n3. Template – pre-defined template to be used\r\n### Multiple Email ID\r\n\r\n> If you have added multiple email IDs in a single parameter, then system will pick the last email ID.\r\n\t\r\nExample: To[0][email]= recipient_one@example.com , To[0][email]= recipient_two@example.com To[0][email]= recipient_three@example.com To[0][email]= recipient_four@example.com, then in this case, system will send an email to recipient_four@example.com.\r\n\t\r\n### Email Sequencing\r\n\r\n> Email IDs must be in the following format & sequence only:\r\nTo[0][email]= recipient_one@example.com , To[1][email]= recipient_two@example.com To[2][email]= recipient_three@example.com To[3][email]= recipient_four@example.com\r\n\r\n### Mapping Email Parameters\r\n\r\n> Parameters will be be mapped in the following way while sending emails: To[0][email]= recipient_one@example.com & to[0][name]=Recipient One To[1][email]= recipient_two@example.com & to[1][name]=Recipient Two\r\n\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional Parameters\r\nThe optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| To[0][name]\t| Name of recipient to be shown in email; Can also be used for multiple recipients associated with email IDs like To[1][name], to[2][name],etc\t| To whom you want to send email(s); Recipient name(s)\t|\r\n| From[name]\t| Who has sent this email(s) i.e. Sender Name to be shown in email\t| Sender name so that recipients must know that you have sent email(s)\t|\r\n| format\t| XML/PHP/JSON/JSONP.\t| In which format you want to see the response. Default response will be in JSON\t|\r\n| time\t| YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t| Date and time need to be mentioned; when you want to schedule an email.\t|\r\n| name\t| Campaign name\t| You may give any name to this email campaign\t|\r\n\r\n## Mandatory API Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"bb95613c-741a-4216-bbb2-f04a5924746d","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{email}}&task=delete&id={{id}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"task","value":"delete"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<api>\r\n    <status>OK</status>\r\n    <data>\r\n        <group_id>1878063</group_id>\r\n        <email>\r\n            <id>1878063-1</id>\r\n            <email>xyz@gmail.com</email>\r\n            <name>abc</name>\r\n            <status>AWAITED-DLR</status>\r\n        </email>\r\n    </data>\r\n    <message>Campaign of 1 emails Submitted successfully.</message>\r\n</api>"},{"id":"ef92f9ff-ab98-4f3b-97f6-e566981314ec","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{email}}&task=delete&id={{id}}&app=1","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"task","value":"delete"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \"status\": \"OK\",\r\n  \"data\": {\r\n    \"0\": {\r\n      \"id\": \"1878054-1\",\r\n      \"email\": \"xyz@gmail.com\",\r\n      \"name\": \"ABC\",\r\n      \"status\": \"AWAITED-DLR\"\r\n    },\r\n    \"group_id\": 1878054\r\n  },\r\n  \"message\": \"Campaign of 1 emails Submitted successfully.\"}"}],"_postman_id":"d8f8a125-d2ef-4c43-92b7-ca185d441a6b"},{"name":"Send an Email Template","id":"94e00e9c-e5df-4adf-8c49-6c59bbb39290","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{email}}&format=xml&subject=Kaleyraemail&to[0][email]={{emailid}}&to[0][name]={{name}}&from[email]={{emailid}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"format","value":"xml"},{"key":"subject","value":"Kaleyraemail"},{"key":"to[0][email]","value":"{{emailid}}"},{"key":"to[0][name]","value":"{{name}}"},{"key":"from[email]","value":"{{emailid}}"}]},"description":"# What can you do with this API?\r\nThrough this API, you'll be able to send an email using a predefined Template format.\r\n\r\nHere is an API format to send email using the pre-defined templates created using “Template” feature under E mailer menu. If you use any specific templates, then you may skip Text or HTML parameter i.e. Body of an email as system will pick the template content for body of an email. \r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional Parameters\r\nThe optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| Template[id]\t| Template ID (numeric value) for specific template\t| Use this template ID for pre-defined templates created in the application; template will be applied to outgoing email campaign\t|\r\n| Files[]\t| Attachment upto 10Mb\t| Attach any file to be sent to recipients; Recipients will receive emails along with the attachments upto 10Mb\t|\r\n| To[0][name]\t| Name of recipient to be shown in email; Can also be used for multiple recipients associated with email IDs like To[1][name], to[2][name],etc\t| To whom you want to send email(s); Recipient name(s)\t|\r\n| From[name]\t| Who has sent this email(s) i.e. Sender Name to be shown in email\t| Sender name so that recipients must know that you have sent email(s)\t|\r\n| format\t| XML/PHP/JSON/JSONP.\t| In which format you want to see the response. Default response will be in JSON\t|\r\n| time\t| YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t| Date and time need to be mentioned; when you want to schedule an email.\t|\r\n| name\t| Campaign name\t| You may give any name to this email campaign\t|\r\n\r\n## Mandatory Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"32121fb4-46b9-40bb-9362-50e790595cfc","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{email}}&format=xml&subject=Kaleyraemail&to[0][email]={{emailid}}&to[0][name]={{name}}&from[email]={{emailid}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"format","value":"xml"},{"key":"subject","value":"Kaleyraemail"},{"key":"to[0][email]","value":"{{emailid}}"},{"key":"to[0][name]","value":"{{name}}"},{"key":"from[email]","value":"{{emailid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<api>\r\n    <status>OK</status>\r\n    <data>\r\n        <group_id>1878063</group_id>\r\n        <email>\r\n            <id>1878063-1</id>\r\n            <email>xyz@gmail.com</email>\r\n            <name>abc</name>\r\n            <status>AWAITED-DLR</status>\r\n        </email>\r\n    </data>\r\n    <message>Campaign of 1 emails Submitted successfully.</message>\r\n</api>"},{"id":"b8959a00-19a3-4c08-a9ec-3c1e4f32c75e","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{email}}&format=json&subject=Kaleyraemail&to[0][email]={{emailid}}&to[0][name]={{name}}&from[email]={{emailid}}","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"format","value":"json"},{"key":"subject","value":"Kaleyraemail"},{"key":"to[0][email]","value":"{{emailid}}"},{"key":"to[0][name]","value":"{{name}}"},{"key":"from[email]","value":"{{emailid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \"status\": \"OK\",\r\n  \"data\": {\r\n    \"0\": {\r\n      \"id\": \"1878054-1\",\r\n      \"email\": \"xyz@gmail.com\",\r\n      \"name\": \"ABC\",\r\n      \"status\": \"AWAITED-DLR\"\r\n    },\r\n    \"group_id\": 1878054\r\n  },\r\n  \"message\": \"Campaign of 1 emails Submitted successfully.\"}"}],"_postman_id":"94e00e9c-e5df-4adf-8c49-6c59bbb39290"},{"name":"Send an Email with Attachment","id":"d32b7502-6ba6-4feb-9987-8985c4d757ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{email}}&format=xml&subject=Kaleyraemail&to[0][email]={{emailid}}&to[0][name]={{name}}&from[email]={{emailid}}&text={{hello world}} world}}&from[name]={{name}}&files[]=sdfrt12.png'","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"format","value":"xml"},{"key":"subject","value":"Kaleyraemail"},{"key":"to[0][email]","value":"{{emailid}}"},{"key":"to[0][name]","value":"{{name}}"},{"key":"from[email]","value":"{{emailid}}"},{"key":"text","value":"{{hello world}} world}}"},{"key":"from[name]","value":"{{name}}"},{"key":"files[]","value":"sdfrt12.png'"}]},"description":"# What can you do with this API?\r\nYou can send an email with media and attachments through this API. \r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional Parameters\r\nThe optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| Files[]\t| Attachment upto 10Mb\t| Attach any file to be sent to recipients; Recipients will receive emails along with the attachments upto 10Mb\t|\r\n| To[0][name]\t| Name of recipient to be shown in email; Can also be used for multiple recipients associated with email IDs like To[1][name], to[2][name],etc\t| To whom you want to send email(s); Recipient name(s)\t|\r\n| From[name]\t| Who has sent this email(s) i.e. Sender Name to be shown in email\t| Sender name so that recipients must know that you have sent email(s)\t|\r\n| format\t| XML/PHP/JSON/JSONP.\t| In which format you want to see the response. Default response will be in JSON\t|\r\n| time\t| YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t| Date and time need to be mentioned; when you want to schedule an email.\t|\r\n| name\t| Campaign name\t| You may give any name to this email campaign\t|\r\n\r\n## Mandatory API Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[{"id":"d3bc547e-2753-4d60-8ccc-76be04467644","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{email}}&format=xml&subject=Kaleyraemail&to[0][email]={{emailid}}&to[0][name]={{name}}&from[email]={{emailid}}&text={{hello world}} world}}&from[name]={{name}}&files[]=sdfrt12.png'","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"format","value":"xml"},{"key":"subject","value":"Kaleyraemail"},{"key":"to[0][email]","value":"{{emailid}}"},{"key":"to[0][name]","value":"{{name}}"},{"key":"from[email]","value":"{{emailid}}"},{"key":"text","value":"{{hello world}} world}}"},{"key":"from[name]","value":"{{name}}"},{"key":"files[]","value":"sdfrt12.png'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<api>\r\n    <status>OK</status>\r\n    <data>\r\n        <group_id>1878063</group_id>\r\n        <email>\r\n            <id>1878063-1</id>\r\n            <email>xyz@gmail.com</email>\r\n            <name>abc</name>\r\n            <status>AWAITED-DLR</status>\r\n        </email>\r\n    </data>\r\n    <message>Campaign of 1 emails Submitted successfully.</message>\r\n</api>"},{"id":"e7eaea67-2790-43a0-82c2-79a71e773354","name":"JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{email}}&format=json&subject=Kaleyraemail&to[0][email]={{emailid}}&to[0][name]={{name}}&from[email]={{emailid}}&text={{hello world}} world}}&from[name]={{name}}&files[]=sdfrt12.png'","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"format","value":"json"},{"key":"subject","value":"Kaleyraemail"},{"key":"to[0][email]","value":"{{emailid}}"},{"key":"to[0][name]","value":"{{name}}"},{"key":"from[email]","value":"{{emailid}}"},{"key":"text","value":"{{hello world}} world}}"},{"key":"from[name]","value":"{{name}}"},{"key":"files[]","value":"sdfrt12.png'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \"status\": \"OK\",\r\n  \"data\": {\r\n    \"0\": {\r\n      \"id\": \"1878054-1\",\r\n      \"email\": \"xyz@gmail.com\",\r\n      \"name\": \"ABC\",\r\n      \"status\": \"AWAITED-DLR\"\r\n    },\r\n    \"group_id\": 1878054\r\n  },\r\n  \"message\": \"Campaign of 1 emails Submitted successfully.\"}"}],"_postman_id":"d32b7502-6ba6-4feb-9987-8985c4d757ba"},{"name":"Send a HTML Email","id":"8a142bfd-c5b5-4664-be98-d129c37a2a96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{email}}&format=xml&subject=Kaleyraemail&to[0][email]={{emailid}}&to[0][name]={{name}}&from[email]={{emailid}}&from[name]={{name}}&files[]=sdfrt12.png&template[id]={{id}}&html= <div class=\"form-group\"> <label for=\"password\"> Password </label> <input type=\"password\" name=\"password\" class=\"form-control\" required=\"required\" placeholder=\"Enter your password\" autocomplete=\"off\" /> <a href=\"http://<domainURL/members/resetpass\" id=\"forgot-password\">Forgot?</a> </div>","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"format","value":"xml"},{"key":"subject","value":"Kaleyraemail"},{"key":"to[0][email]","value":"{{emailid}}"},{"key":"to[0][name]","value":"{{name}}"},{"key":"from[email]","value":"{{emailid}}"},{"key":"from[name]","value":"{{name}}"},{"key":"files[]","value":"sdfrt12.png"},{"key":"template[id]","value":"{{id}}"},{"key":"html","value":" <div class=\"form-group\"> <label for=\"password\"> Password </label> <input type=\"password\" name=\"password\" class=\"form-control\" required=\"required\" placeholder=\"Enter your password\" autocomplete=\"off\" /> <a href=\"http://<domainURL/members/resetpass\" id=\"forgot-password\">Forgot?</a> </div>"}]},"description":"# What can you do with this API?\r\nThrough this API, you can apply CSS styles to such HTML content based emails and your outgoing mail will adopt these styles across all recipients.\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional Parameters\r\nThe optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| Template[id]\t| Template ID (numeric value) for specific template\t| Use this template ID for pre-defined templates created in the application; template will be applied to outgoing email campaign\t|\r\n| Files[]\t| Attachment upto 10Mb\t| Attach any file to be sent to recipients; Recipients will receive emails along with the attachments upto 10Mb\t|\r\n| To[0][name]\t| Name of recipient to be shown in email; Can also be used for multiple recipients associated with email IDs like To[1][name], to[2][name],etc\t| To whom you want to send email(s); Recipient name(s)\t|\r\n| From[name]\t| Who has sent this email(s) i.e. Sender Name to be shown in email\t| Sender name so that recipients must know that you have sent email(s)\t|\r\n| format\t| XML/PHP/JSON/JSONP.\t| In which format you want to see the response. Default response will be in JSON\t|\r\n| time\t| YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t| Date and time need to be mentioned; when you want to schedule an email.\t|\r\n| name\t| Campaign name\t| You may give any name to this email campaign\t|\r\n\r\n## Expected API Error Codes\r\n\r\n| Code\t| Description\t|\r\n|-------|---------------|\r\n| E601\t| Missing recipient\t|\r\n| E602\t| Invalid Template\t|\r\n| E603\t| Missing message\t|\r\n| E604\t| Invalid schedule time. Minimum 5minutes time gap is required.\t|\r\n| E606\t| Unable to find gateway to send email\t|\r\n| E607\t| No valid email address found\t|\r\n| E609\t| Unable to write to temp files\t|\r\n| E610\t| Unable to process your request. try again\t|\r\n| E599\t| Missing From address\t|\r\n| A401B\t| Method not found\t|\r\n| E600\t| Missing Subject\t|\r\n| A402\t| API key not found\t|\r\n\r\n## Mandatory Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"8a142bfd-c5b5-4664-be98-d129c37a2a96"}],"id":"baa1b748-d061-41ab-ad64-c0c9f160efd6","description":"Kaleyra SMS API will enable you to send an SMS to a mobile number or a group of mobile numbers. You can send Unicode SMS through the API. SMS can be sent using XML, JSON payload over Query string.\n\n# Base URL for Integration\n\t\n\thttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\n\n# Still facing trouble using the API?\nWe have the best support team that works 24*7 providing regional language support in India. You can get in touch with them at support@kaleyra.com and we'll address your concern.\n\n","event":[{"listen":"prerequest","script":{"id":"abc9b1dd-b67e-4aaf-b8e6-2d3c1b93a06a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2464036f-7daa-4bd9-979b-6ca3317e11fc","type":"text/javascript","exec":[""]}}],"_postman_id":"baa1b748-d061-41ab-ad64-c0c9f160efd6"},{"name":"Global Messaging Platform (GMP)","item":[{"name":"Send an SMS","id":"a535531d-6400-4aba-8a44-20d1dec77625","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&message=Welcome to Kaleyra API&sender={{sender_id}}&to={{phone_number}}&method=sms","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"message","value":"Welcome to Kaleyra API","description":"Enter your message"},{"key":"sender","value":"{{sender_id}}"},{"key":"to","value":"{{phone_number}}"},{"key":"method","value":"sms"}]},"description":"With the GMP base url, you can send SMS with all the API in alerts section.\n\nAn example of using base url is mentioned on this page."},"response":[],"_postman_id":"a535531d-6400-4aba-8a44-20d1dec77625"},{"name":"Schedule an SMS","id":"da36c589-b9c2-4a5a-812f-3fee3d903603","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/index.php?api_key={{api_key}}&method=sms&message=Welcome to Kaleyra API&to={{to}}&sender={{sender_id}}&time=2019-08-29 06:48 PM","host":["{{global_baseurl}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"sms"},{"key":"message","value":"Welcome to Kaleyra API","description":"Enter your message"},{"key":"to","value":"{{to}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"time","value":"2019-08-29 06:48 PM","description":"Format is in \"YYY-MM-DD HH:MM AM/PM\""}]},"description":"# What can you do with this API?\nYou can schedule the SMS to a specified time and trigger it to a phone number or a group.This API can let user schedule SMS to single as well as multiple recipients at anytime.\n\n**Message Schedule Time lapses**\n> SMS cannot be scheduled before 5 minutes and after 3 months from the date of scheduling the SMS.\n\n\n# Prerequisites\n\n1. An API Key\n2. Sender ID\n3. An active Internet connection\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections. Mandatory parameters are must to send an SMS, while optional parameters are defined as per the user's requirement.\n\n## Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t\t| Description\t| Expected Value\t|\n|---------------|---------------|-------------------|\n| dlrurl\t| The encoded URL to receive delivery reports. Spiffing custom in the DLR url is mandatory.\t| delivery reports URL\t|\n| custom\t| Custom message ID by customer, comma separated\t| Alphanumeric (max 40 char)\t| \n| time\t| Date and time for scheduling an SMS\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t|\n| unicode\t| To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.\t| 1 / 0 / auto\t|\n| flash\t\t| To specify that the message is to be sent in the flash format\t| To specify that the message is to be sent in the flash format\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n## Advanced Parameters (Optional)\nThe advanced parameters in the HTTP API are tabulated below:\n\n| Parameter\t\t| Description\t| Expected Value\t|\n|---------------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/JSON/JSONP. Default response will be in JSON\t|\n| callback\t| callback Callback function for JSONP response format\t| String\t|\n| custom1 and custom2\t| Custom reference fields\t| Alphanumeric (max 40 char)\t|\n| port\t| Port number to which SMS has to be sent\t| Valid integer port number above 2000\t|\n\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"da36c589-b9c2-4a5a-812f-3fee3d903603"},{"name":"Edit Scheduled SMS","id":"32394247-dba4-4e3c-a29d-48f86e4b51b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/index.php?api_key={{api_key}}&method=sms.schedule&groupid=6XXXX:1&time=2019-08-30 06:55 PM&task=modify","host":["{{global_baseurl}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"sms.schedule"},{"key":"groupid","value":"6XXXX:1","description":"Enter your scheduled SMS ID"},{"key":"time","value":"2019-08-30 06:55 PM","description":"Format is in \"YYY-MM-DD HH:MM AM/PM\""},{"key":"task","value":"modify"}]},"description":"# What can you do with this API?\nOnce you create an SMS and schedule it, you'll be able to edit the schedule of the SMS through this API.\nTo edit a scheduled slot, there should a minimum gap of 5 minutes before its execution.\n> Application must have a scheduled SMS campaign to further modify it and user must save a Group ID of an SMS campaign to be rescheduled\n# Prerequisites\n1. API Key\n2. An active Internet connection\n3. Group ID of the scheduled SMS\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t\t| Description\t| Expected Value\t|\n|---------------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n\n\n\n## Response Data\n\n| Field\t| Description\t|\n|-------|---------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message. |\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"32394247-dba4-4e3c-a29d-48f86e4b51b2"},{"name":"Delete Scheduled SMS","id":"65d6471b-49a6-488a-937d-913445426d6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/index.php?api_key={{api_key}}&method=sms.schedule&groupid=6XXXX:1&task=delete","host":["{{global_baseurl}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"sms.schedule"},{"key":"groupid","value":"6XXXX:1","description":"Enter your scheduled SMS ID"},{"key":"task","value":"delete"}]},"description":"# What can you do with this API?\nThrough this API, you can delete a scheduled SMS from your account.To delete a scheduled slot, there should a minimum gap of 5 minutes before its execution. \n\n>Your account must have a scheduled SMS campaign to further modify it and also use must save a Group ID of an SMS campaign to be deleted.\n# Prerequisites\n1. API Key\n2. Group ID of the scheduled SMS\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Response Data\n\n| Field\t| Description\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n\n## Mandatory Parameters"},"response":[],"_postman_id":"65d6471b-49a6-488a-937d-913445426d6e"},{"name":"Send a Unicode SMS","id":"1be10d60-9518-4a6b-b404-671f215e3af1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/index.php?method=sms&message=Welcome to Kaleyra API&to={{to}}&api_key={{api_key}}&sender={{sender_id}}&unicode=1","host":["{{global_baseurl}}"],"path":["{{version}}","index.php"],"query":[{"key":"method","value":"sms"},{"key":"message","value":"Welcome to Kaleyra API","description":"Enter your message"},{"key":"to","value":"{{to}}","description":"Enter mobile number"},{"key":"api_key","value":"{{api_key}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"unicode","value":"1"}]},"description":"You can send a Unicode SMS to a phone number or a group, in the language of your choice. To send a Unicode SMS, follow the steps below:\r\n\r\n\r\n## Unicode Character Counts\r\n\r\n1. Put Unicode=1 if you want to send message in Unicode format. Even if its English, credits will be charged as per Unicode characters.\r\n\r\n2. Put Unicode=0 if you don`t want to send Unicode message.\r\n\r\n3. Put Unicode=auto for automatic detection of Unicode SMS. Based on language, system will detect language and charge accordingly.\r\n\r\n# Prerequisites\r\n1. An API Key\r\n2. Sender ID\r\n3. An active Internet connection\r\n\r\n# API Parameter Specifications\r\n\r\nThe API parameter specifications are described in the following sections. Mandatory parameters are must to send an SMS, while optional parameters are defined as per the user's requirement.\r\n\r\n## Optional Parameters\r\nThe optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| dlrurl\t| The encoded URL to receive delivery reports. Spiffing custom in the DLR url is mandatory.\t| delivery reports URL\t|\r\n| custom\t| Custom message ID by customer, comma separated\t| Alphanumeric (max 40 char)\t|\r\n| time\t| Date and time for scheduling an SMS\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t|\r\n| unicode\t| To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.\t| 1 / 0 / auto\t|\r\n| flash\t| To specify that the message is to be sent in the flash format\t| To specify that the message is to be sent in the flash format\t|\r\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\r\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\r\n\r\n\r\n## Advanced Parameters(Optional)\r\nThe advanced parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| format\t| Output format should be as specified by this variable\t| XML/JSON/JSONP. Default response will be in JSON\t|\r\n| callback\t| callback Callback function for JSONP response format\t| String\t|\r\n| custom1 and custom2\t| Custom reference fields\t| Alphanumeric (max 40 char)\t|\r\n| port\t| Port number to which SMS has to be sent\t| Valid integer port number above 2000\t|\r\n\r\n\r\n## Response Data\r\n\r\n| Parameter\t| Description\t|\r\n|-----------|---------------|\r\n| status\t| It indicates the success or failure of your request.\t|\r\n| message\t| It indicates the success or failure message.\t|\r\n| group_id\t| Website group id for your reference. Which is the current date\t|\r\n| data\t| All the response is wrapped in side data\t|\r\n| sms\t| Each number will be wrapped inside sms\t|\r\n| id\t| Website message id for your reference\t|\r\n| customid\t| Custom message id if you provide one\t|\r\n| customid1\t| Custom message id 1 if you provide one\t|\r\n| customid2\t| Custom message id 2 if you provide one\t|\r\n| mobile\t| Receiver Mobile number\t|\r\n| status\t| status of the message\t|\r\n\r\n## Mandatory Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"1be10d60-9518-4a6b-b404-671f215e3af1"},{"name":"Send a Port SMS","id":"51fad6a9-5a03-4b07-813a-1a08c8fb63a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=sms&message=Welcome to Kaleyra API&to={{to}}&sender={{sender_id}}&port=82XX","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"sms"},{"key":"message","value":"Welcome to Kaleyra API","description":"Enter your message"},{"key":"to","value":"{{to}}","description":"Enter mobile number"},{"key":"sender","value":"{{sender_id}}"},{"key":"port","value":"82XX","description":"Enter port number"}]},"description":"Using the below API, one can send a normal or Unicode SMS to a particular port. Application port numbers can be used in SMS messages to deliver a particular SMS to an application on a mobile phone.\r\n\r\nIf any application is present and running in that particular port, the text will be received as port SMS, else the message will hit the native inbox of the mobile phone.\r\n\r\n> NOTE: The API tries to hit the application(port) for 10 seconds, if unsuccessful the message is delivered on the native inbox\r\n\r\n# Prerequisites\r\n\r\n1. An API Key\r\n2. Sender ID\r\n3. Port number\r\n\r\n#API Parameter Specifications\r\n\r\nThe API parameter specifications are described in the following sections. Mandatory parameters are must to send an SMS, while optional parameters are defined as per the user's requirement.\r\n\r\n## Optional Parameters\r\nThe optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| dlrurl\t| The encoded URL to receive delivery reports. Spiffing custom in the DLR url is mandatory.\t| delivery reports URL\t|\r\n| custom\t| Custom message ID by customer, comma separated\t| Alphanumeric (max 40 char)\t|\r\n| time\t| Date and time for scheduling an SMS\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t|\r\n| unicode\t| To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS.\t| 1 / 0 / auto\t|\r\n| flash\t| To specify that the message is to be sent in the flash format\t| To specify that the message is to be sent in the flash format\t|\r\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\r\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\r\n\r\n\r\n## Advanced Parameters(Optional)\r\nThe advanced parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| format\t| Output format should be as specified by this variable\t| XML/JSON/JSONP. Default response will be in JSON\t|\r\n| callback\t| Callback function for JSONP response format\t| String\t|\r\n| custom1 and custom2\t| Custom reference fields\t| Alphanumeric (max 40 char)\t|\r\n| port\t| Port number to which SMS has to be sent\t| Valid integer port number above 2000\t|\r\n\r\n## Response Data\r\n\r\n| Parameter\t| Description\t|\r\n|-----------|---------------|\r\n| status\t| It indicates the success or failure of your request.\t|\r\n| message\t| It indicates the success or failure message.\t|\r\n| group_id\t| Website group id for your reference. Which is the current date\t|\r\n| data\t| All the response is wrapped in side data\t|\r\n| sms\t| Each number will be wrapped inside sms\t|\r\n| id\t| Website message id for your reference\t|\r\n| customid\t| Custom message id if you provide one\t|\r\n| customid1\t| Custom message id 1 if you provide one\t|\r\n| customid2\t| Custom message id 2 if you provide one\t|\r\n| mobile\t| Receiver Mobile number\t|\r\n| status\t| status of the message\t|\r\n\r\n## Mandatory Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"51fad6a9-5a03-4b07-813a-1a08c8fb63a1"},{"name":"Send SMS using XML Data","id":"7daabf24-d812-4090-8ee6-898c5aa26acb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/index.php?method=sms.xml&api_key={{api_key}}&xml=<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<api>\n\t<campaign>campaign name</campaign>\n\t<unicode>0</unicode>\n\t<flash>0</flash>\n\t<sender>{{sender_id}}</sender>\n\t<message>\n\t\t<![CDATA[Sending message from XML]]>\n\t</message>\n\t<sms>\n\t\t<to>{{to}}</to>\n\t</sms>\n<dlrurl><![CDATA[http://domain.com/receive?msgid={msgid}%26sid={sid}%26status={status}%26custom1={custom1}]]></dlrurl>\n</api>","host":["{{global_baseurl}}"],"path":["{{version}}","index.php"],"query":[{"key":"method","value":"sms.xml"},{"key":"api_key","value":"{{api_key}}"},{"key":"xml","value":"<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n<api>\n\t<campaign>campaign name</campaign>\n\t<unicode>0</unicode>\n\t<flash>0</flash>\n\t<sender>{{sender_id}}</sender>\n\t<message>\n\t\t<![CDATA[Sending message from XML]]>\n\t</message>\n\t<sms>\n\t\t<to>{{to}}</to>\n\t</sms>\n<dlrurl><![CDATA[http://domain.com/receive?msgid={msgid}%26sid={sid}%26status={status}%26custom1={custom1}]]></dlrurl>\n</api>"}]},"description":"# What can you do with this API?\nThis API enables you to send an SMS using XML programming language. \n\n# Prerequisites\n1. An API Key\n2. Sender ID\n3. XML Data\n\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional parameters\nThe Optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/JSON/JSONP. Default JSON\t|\n| callback\t| Callback function for JSONP response format\t| Javascript function name standards\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n## XML Tag Parameters\n>NOTE: If message,sender and dlrurl is specified within both SMS tag and XML tag, the former overrides the later.\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| xml version=\"1.0 \"encoding=\"UTF-8\"\t| XML Header\t| Version and Encoding\t|\n| api\t| Document Root\t| Document Root\t|\n| flash\t| Global node for flash\t| 1/0\t|\n| campaign\t| Global campaign name tag\t| campaign name\t|\n| sms\t| SMS Node(can repeat)\t| SMS Node\t|\n| to\t| Mobile number in sms node\t| Comma separated 10 digit mobile numbers\t|\n| custom\t| Message ID for sms\t| comma separated message ID's\t|\n| custom1\t| Custom reference 1 (comma separate)\t| comma separated custom 1 references\t|\n| custom2\t| Custom reference 2 (comma separate)\t| comma separated custom 2 references\t|\n| sender\t| Sender ID assigned to your account\t| Sender ID\t|\n| message\t| Message to be sent. In case of any special characters in your message, enclose it within CDATA a s in the example\t| Message text\t|\n| dlrurl\t| The URL to receive delivery reports. Spiffing reference id is mandatory\t| EX:http://www.example.com/dlr.php\t|\n| unicode\t| To specify that the message to be sent is in unicode format.Also can be used for automatic detection of unicode SMS\t| 1/0/auto\t|\n| time\t| Global schedule time\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t|\n\n\nIn case of special characters in the content within any of the XML tags, enclose it within CDATA as in following examples.\n\n## Sending to multiple numbers with same message\n\t<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\t<api>\n\t<campaign>campaign</campaign>\n\t<dlrurl><![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]></dlrurl>\n\t<time>2014-12-2604:00pm</time>\n\t<unicode>0</unicode>\n\t<flash>0</flash>\n\t<sender>senderid</sender>\n\t<message><![CDATA[smstext]]></message>\n\t<sms><to>9190********</to></sms>\n\t<sms><to>9191********</to></sms>\n\t</api>\n## Sending to multiple numbers with different message\n\t<api>\n\t<campaign>campaign</campaign>\n\t<time>2014-12-26 04:00pm</time>\n\t<unicode>0</unicode>\n\t<flash>0</flash>\n\t<sms>\n\t<to>9190********</to>\n\t<sender>senderid</sender>\n\t<message>smstext</message>\n\t<custom>2</custom>\n\t<dlrurl>\n\t<![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]>\n\t</dlrurl> \n\t</sms>\n\t<sms>\n\t<to>9191********</to>\n\t<sender>senderid</sender>\n\t<message><![CDATA[smstext]]></message>\n\t<custom>2</custom>\n\t<dlrurl>\n\t<![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]>\n\t</dlrurl> \n\t</sms>\n\t</api>\n\t\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"7daabf24-d812-4090-8ee6-898c5aa26acb"},{"name":"Send SMS using  JSON Data","id":"dfdb3156-378d-4c78-b5a0-b308b4f25fe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=sms.json&json={\"sender\": \"{{sender_id}}\",\"sms\":[{\"to\": \"{{to}}\",\"msgid\":\"1\",\"message\": \"duplicate check 123456789\",\"custom1\": \"11\",\"custom2\": \"22\",\"sender\": \"{{sender_id}}\" }],\"unicode\": 0, \"flash\": 0}","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"sms.json"},{"key":"json","value":"{\"sender\": \"{{sender_id}}\",\"sms\":[{\"to\": \"{{to}}\",\"msgid\":\"1\",\"message\": \"duplicate check 123456789\",\"custom1\": \"11\",\"custom2\": \"22\",\"sender\": \"{{sender_id}}\" }],\"unicode\": 0, \"flash\": 0}"}]},"description":"# What can you do with this API?\nThis API enables you to send an SMS using JSON data to send similar message to multiple numbers or different messages to different numbers.\n\n> SMS can be sent using the JSON API by posting values to the preceding URL by the POST method with URL encoded JSON data.\n\n**If you wish to send SMS globally, the Base URL is listed below.**\n\n> https://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\n# Prerequisites\n1. An API Key\n2. Sender ID\n3. JSON Data\n\n# Example Data\nIn case of special characters in the content within any of the JSON tags, enclose it within CDATA as in following examples.\n\n## Sending to multiple numbers with same message\n\n\t{\n\t\"message\": \"test json\",\n\t\"sender\": \"AAAAAA\",\n\t\"sms\":[\n\t{\n\t\"to\": \"95XXXXXXXX\",\n\t\"msgid\": \"1\",\n\t\"message\": \"test sms\",\n\t\"custom1\": \"11\",\n\t\"custom2\": \"22\",\n\t\"sender\": \"AAAAAA\"\n\t},\n\t{\n\t\"to\": \"99XXXXXXXX\",\n\t\"msgid\": \"2\",\n\t\"custom1\": \"1\",\n\t\"custom2\": \"2\" \n\t}],\n\t\"unicode\": 1,\n\t\"flash\": 1,\n\t\"dlrurl\": \"http://www.example.com/dlr.php\" \n\t}\n\n\t\n## Sending to multiple numbers with different message\n\n\n\t\"message\": \"test json\",\n\t\"sms\":[\n\t{\n\t\"to\": \"95XXXXXXXX\",\n\t\"msgid\": \"1\",\n\t\"message\": \"test sms\",\n\t\"custom1\": \"11\",\n\t\"custom2\": \"22\",\n\t\"sender\": \"AAAAAA\" },\n\t{\n\t\"to\": \"99XXXXXXXX\",\n\t\"msgid\": \"2\",\n\t\"message\": \"json test sms\",\n\t\"custom1\": \"1\",\n\t\"custom2\": \"2\"\n\t}],\n\t\"unicode\": 1,\n\t\"flash\": 1,\n\t\"dlrurl\": \"http://www.example.com/dlr.php\"\n\t}\n\t\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional parameters\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| callback\t| Callback function for JSONP response format\t| Javascript function name standards\t|\n| entity_id\t\t| The Entity ID that is registered with DLT Platform\t\t| The Entity ID that is registered with DLT Platform\t|\n| template_id\t\t| The Template ID that is registered with DLT Platform\t\t| The Template ID that is registered with DLT Platform\t|\n\n\n## JSON Tag Parameters\nIf message, sender and dlrurl is specified within both SMS tag and JSON tag, the former overrides the later.\n\n| Parameter\t| Description\t| Expected Value\t| \t|\n|-----------|---------------|-------------------|---|\n| flash\t| Global node for flash\t| 1/0\t| Optional\t|\n| sms\t| SMS Node(can repeat)\t| SMS Node\t| Mandatory\t|\n| to\t| Mobile number in sms node\t| Comma separated 10 digit mobile numbers\t| required\t|\n| custom\t| Message ID for sms\t| comma separated message ID's\t| Optional\t|\n| custom1\t| Custom reference 1 (comma separate)\t| comma separated custom 1 references\t| Optional\t|\n| custom2\t| Custom reference 2 (comma separate)\t| comma separated custom 2 references\t| Optional\t|\n| sender\t| Sender ID assigned to your account\t| Sender ID\t| Mandatory\t|\n| message\t| Message to be sent. In case of any special characters in your message, enclose it within CDATA a s in the example\t| Message text\t| Mandatory\t|\n| dlrurl\t| The URL to receive delivery reports. Spiffing reference id is mandatory\t| EX: http://www.example.com/dlr.php\t| Optional\t|\n| unicode\t| To specify that the message to be sent is in unicode format. Also can be used for automatic detection of unicode SMS\t| 1/0/auto\t| Optional\t|\n| time\t| Global schedule time\t| EX Format: YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t| Optional\t|\n\n\n\n## API Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"dfdb3156-378d-4c78-b5a0-b308b4f25fe8"},{"name":"Create an SMS Group","id":"371fc58e-7389-43dc-870a-9d0bb3b5380a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?method=groups.add&api_key={{api_key}}&app=1&task=save&data[name]=Name of Group","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"method","value":"groups.add"},{"key":"api_key","value":"{{api_key}}"},{"key":"app","value":"1"},{"key":"task","value":"save"},{"key":"data[name]","value":"Name of Group","description":"Mention the group name"}]},"description":"# What can you do with this API?\nThis API enables you to create a group of contacts from your account, so that you can simply use the group name to send SMS instead of adding multiple numbers manually. \n# Prerequisites\n1. API Key\n2. Sender ID\n3. An active Internet connection\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional Parameters\nThe Optional parameter in the HTTP API is tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\": \"ERROR\",\n    \"message\": \"Group name already exists.\",\n    \"data\": []\n\t}\n\t\n\n## \tExample Error Response (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n\t<api>\n    <status>A401A</status>\n    <message>Method Not Implemented</message>\n\t</api>\n\n## Response Data\n\n| Field\t| Description\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the responses are wrapped inside data\t|\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"371fc58e-7389-43dc-870a-9d0bb3b5380a"},{"name":"Add Contacts to an SMS Group","id":"f14621f1-bcb6-4003-99fb-daa1dd519be0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?method=groups.register&api_key={{api_key}}&number={{phone_number}}&name=Name of Group&action=add&fullname={{name}}&email={{emailid}}","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"method","value":"groups.register"},{"key":"api_key","value":"{{api_key}}"},{"key":"number","value":"{{phone_number}}"},{"key":"name","value":"Name of Group","description":"Mention the group name."},{"key":"action","value":"add"},{"key":"fullname","value":"{{name}}"},{"key":"email","value":"{{emailid}}"}]},"description":"# What can you do with this API?\nThrough this API, you can add contacts to the SMS group you have created.\n# Prerequisites\n\n1. An API Key\n2. Sender ID\n3. SMS Group Name\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| fullname\t| name of the contact to be added\t| name of the contact\t|\n| email\t| email of the contact to be added\t| email of the contact\t|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| action\t| Flag to specify the action\t| add/delete; Add action is Default\t|\n\n## Example Error Response (JSON)\n\n\t{\n      \"status\": \"ERROR\",\n      \"code\": \"A424\",\n      \"message\": \"Group Name does not exist!\"\n\t}\n\t\n## Example Error Response (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n\t<api>\n    <status>ERROR</status>\n    <code>A424</code>\n    <message>Group Name does not exist!</message>\n\t</api>\n\t\n## Response Data\n\n| Status\t| Message\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| Code\t| Error code\t|\n| message | It indicates the success or failure message.\t|\n\n## API Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"f14621f1-bcb6-4003-99fb-daa1dd519be0"},{"name":"Add Contacts to SMS Group using JSON","id":"b32decc8-8649-4995-97bd-11aa836b7c2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=groups.json&name=Name of Group&action=add&json={\n\"contacts\": \n[{ \n    \"number\": \"{{phone_number}}\", \n    \"fullname\": \"{{name}}\", \n    \"email\": \"{{emailid}}\" \n  }]}","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"groups.json"},{"key":"name","value":"Name of Group"},{"key":"action","value":"add"},{"key":"json","value":"{\n\"contacts\": \n[{ \n    \"number\": \"{{phone_number}}\", \n    \"fullname\": \"{{name}}\", \n    \"email\": \"{{emailid}}\" \n  }]}"}]},"description":"# What can you do with this API?\nThrough this API, you can add a single contact or multiple contacts to a group using JSON / XML data.\n\n>You need to create a group in your account to add multiple contacts to an existing valid group before using the API\n\n# Prerequisites\n1. JSON/ XML Data\n2. Group name to which contacts needs to be added\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## API Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| action\t| Flag to specify the action\t| add/delete. Add action is Default\t|\n\n\n## JSON/XML Tags\n\n| Parameter\t| Description\t|\n|-----------|---------------|\n| number\t| mobile number of the contact to be added\t|\n| fullname\t| full name of the contact\t|\n| email\t| email address of the contact\t|\n\n## Sample Data (JSON)\n\n\t{\n    \"contacts\": \n    [{ \n        \"number\": \"9xxxxxxxx\", \n        \"fullname\": \"xyz\", \n        \"email\": \"xyz@email.com\"  \n      }, \n      {\n        \"number\":\"91xxxxxxxx\",   \n        \"fullname\":\"xyz1\",\n        \"email\":\"xyz1@email.com\"  \n      }] \n\t}\n\t\n## Sample Data (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\t<xmlapi>\n\t<contacts>\n    <number>95xxxxxxxx</number>\n    <fullname>xyz</fullname>\n    <email>x@email.com</email>\n\t</contacts>\n\t<contacts>  \n    <number>99xxxxxxxx</number>\n    <fullname>xyz1</fullname>\n    <email>y@email.com</email>\n\t</contacts>\n\t</xmlapi>\n\n## Response Data\n\n| Status\t| Response\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| Code\t| Error code\t|\n| message\t| It indicates the success or failure message.\t|\n\n## API Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"b32decc8-8649-4995-97bd-11aa836b7c2c"},{"name":"Add Contacts to SMS Group using XML Data","id":"f8720b2a-23f0-4c4d-b638-119f4a6a04dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=groups.xml&group_name=Name of Group&action=add&xml=<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<contacts>\n<number>{{phone_number}}</number>\n<fullname>{{name}}</fullname>\n<email>x{{emailid}}</email>\n</contacts>\n</xmlapi>","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"groups.xml"},{"key":"group_name","value":"Name of Group","description":"Mention the group name."},{"key":"action","value":"add"},{"key":"xml","value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<contacts>\n<number>{{phone_number}}</number>\n<fullname>{{name}}</fullname>\n<email>x{{emailid}}</email>\n</contacts>\n</xmlapi>"}]},"description":"# What can you do with this API?\nThrough this API, you can add a single contact or multiple contacts to a group using JSON / XML data.\n\n>You need to create a group in your account to add multiple contacts to an existing valid group before using the API\n\n# Prerequisites\n1. JSON/ XML Data\n2. Group name to which contacts needs to be added\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## API Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| action\t| Flag to specify the action\t| add/delete. Add action is Default\t|\n\n\n## JSON/XML Tags\n\n| Parameter\t| Description\t|\n|-----------|---------------|\n| number\t| mobile number of the contact to be added\t|\n| fullname\t| full name of the contact\t|\n| email\t| email address of the contact\t|\n\n## Sample Data (JSON)\n\n\t{\n    \"contacts\": \n    [{ \n        \"number\": \"9xxxxxxxx\", \n        \"fullname\": \"xyz\", \n        \"email\": \"xyz@email.com\"  \n      }, \n      {\n        \"number\":\"91xxxxxxxx\",   \n        \"fullname\":\"xyz1\",\n        \"email\":\"xyz1@email.com\"  \n      }] \n\t}\n\t\n## Sample Data (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\t<xmlapi>\n\t<contacts>\n    <number>95xxxxxxxx</number>\n    <fullname>xyz</fullname>\n    <email>x@email.com</email>\n\t</contacts>\n\t<contacts>  \n    <number>99xxxxxxxx</number>\n    <fullname>xyz1</fullname>\n    <email>y@email.com</email>\n\t</contacts>\n\t</xmlapi>\n\n## Response Data\n\n| Status\t| Response\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| Code\t| Error code\t|\n| message\t| It indicates the success or failure message.\t|\n\n## API Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"f8720b2a-23f0-4c4d-b638-119f4a6a04dd"},{"name":"Send SMS to a Group","id":"05d10927-d945-4aec-af61-9f26a1b56072","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=groups&name=GroupName&sender={{sender_id}}&message=Welcome to Kaleyra API","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"groups"},{"key":"name","value":"GroupName"},{"key":"sender","value":"{{sender_id}}"},{"key":"message","value":"Welcome to Kaleyra API","description":"Type your message"}]},"description":"# What can you do with this API?\nThrough this API, you'll be able to send an SMS to a group, anytime.In case, you have not added the group yet, you can create one by referring to the **[SMS Manual](https://www.kaleyra.com/PDF/alerts-user-manual.pdf)**\n\nIn your account, there must be an existing group and numbers under that group to send any message to a group. \n**The following URL enables you to integrate the URL through which you can send customized messages to the group:**\n\n>https://api-alerts.kaleyra.com/v4/?api_key=Af59xxxxxxxxxx&method=groups&name=MyGroupName&sender=AAAAAA&message=Dear {name}, Your email is {email}\n\nIn this case, {name} and {email} would be variable parameters and will be picked up from the existing group MYGROUP which is corresponding to each mobile number.\n>Response formats would be same for simple message to a group or a customized one.\n\n**If you wish to send SMS globally, the Base URL is listed below.**\n>https://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\n\n# Prerequisites\n\n1. An API Key\n2. Sender ID\n3. Group Name/ ID\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\": \"ERROR\",\n    \"code\": \"A421\",\n    \"message\": \"Group is empty/Invalid group\"\n\t}\n\n## Response Data\n\n| Field\t| Description\t|\n|-------|---------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| group_id\t| Website group id for your reference\t|\n| data\t| All the response is wrapped in side data\t|\n| groups\t| Each number will be wrapped inside groups\t|\n| id\t| Website message id for your reference\t|\n| customid\t| Custom message id if you provide one\t|\n| customid1\t| Custom message id 1 if you provide one\t|\n| customid2\t| Custom message id 2 if you provide one\t|\n| mobile\t| Mobile number the sms will be sent\t|\n| status\t| status of the message\t|\n\n## API Error Codes\n\n| Code\t| Description\t|\n|-------|---------------|\n| A420\t| Group name/id missing\t|\n| A421\t| Group is empty/Invalid group\t|\n| A422\t| Invalid mobile number\t|\n| A423\t| Group name/number missing\t|\n| A424\t| Group Name does not exist!\t|\n| A425\t| Number does not Exist\t|\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"05d10927-d945-4aec-af61-9f26a1b56072"},{"name":"Check Credit Status","id":"5d91a277-fbd4-49a0-8cbc-60df24608330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=account.credits","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"account.credits"}]},"description":"# What can you do with this API?\nThrough this API, you'll be able to send an SMS to a group, anytime.In case, you have not added the group yet, you can create one by referring to the **[SMS Manual](https://www.kaleyra.com/PDF/alerts-user-manual.pdf)**\n\nIn your account, there must be an existing group and numbers under that group to send any message to a group. \n**The following URL enables you to integrate the URL through which you can send customized messages to the group:**\n\n>https://api-alerts.kaleyra.com/v4/?api_key=Af59xxxxxxxxxx&method=groups&name=MyGroupName&sender=AAAAAA&message=Dear {name}, Your email is {email}\n\nIn this case, {name} and {email} would be variable parameters and will be picked up from the existing group MYGROUP which is corresponding to each mobile number.\n>Response formats would be same for simple message to a group or a customized one.\n\n**If you wish to send SMS globally, the Base URL is listed below.**\n>https://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\n\n# Prerequisites\n\n1. An API Key\n2. Sender ID\n3. Group Name/ ID\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\": \"ERROR\",\n    \"code\": \"A421\",\n    \"message\": \"Group is empty/Invalid group\"\n\t}\n\n## Response Data\n\n| Field\t| Description\t|\n|-------|---------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| group_id\t| Website group id for your reference\t|\n| data\t| All the response is wrapped in side data\t|\n| groups\t| Each number will be wrapped inside groups\t|\n| id\t| Website message id for your reference\t|\n| customid\t| Custom message id if you provide one\t|\n| customid1\t| Custom message id 1 if you provide one\t|\n| customid2\t| Custom message id 2 if you provide one\t|\n| mobile\t| Mobile number the sms will be sent\t|\n| status\t| status of the message\t|\n\n## API Error Codes\n\n| Code\t| Description\t|\n|-------|---------------|\n| A420\t| Group name/id missing\t|\n| A421\t| Group is empty/Invalid group\t|\n| A422\t| Invalid mobile number\t|\n| A423\t| Group name/number missing\t|\n| A424\t| Group Name does not exist!\t|\n| A425\t| Number does not Exist\t|\n\n## Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"5d91a277-fbd4-49a0-8cbc-60df24608330"},{"name":"Check Credit Usage","id":"89811076-f6e3-4ee8-867f-17bdaca81572","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method={{credit_usage}}&from=2019-01-01&to=2019-01-30&format=json","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{credit_usage}}"},{"key":"from","value":"2019-01-01","description":"Format  is \"YYYY-MM-DD\""},{"key":"to","value":"2019-01-30","description":"Format  is \"YYYY-MM-DD\""},{"key":"format","value":"json"}]},"description":"# What can you do with this API?\n\nThrough this API, user will be able to check the credits usage in his/her account.\n\n> “from” date is mandatory field. if user misses providing “to” date in API, by default API will fetch data till yesterday's date\n\n> Past 6 months data will be available"},"response":[],"_postman_id":"89811076-f6e3-4ee8-867f-17bdaca81572"},{"name":"Check Pull SMS Status","id":"582318f2-4260-4ce3-b55c-d2e934a2ffe0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=sms.status&id=6XXXX:1","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"sms.status"},{"key":"id","value":"6XXXX:1"}]},"description":"# What can you do with this API?\nTo check status of any sent SMS campaign, you must have message id only (not group ID) of the respective message(s). You can only check status for messages which have been sent on the same day.\n\n> If using POST method for pulling messages status, then statuses for maximum 500 messages can be pulled at a time.\n# Prerequisites\n\n1. API key\n2. Sender ID\n3. Message ID\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional Parameters\nThe optional parameters in the HTTP API are tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/JSON/JSONP. Default response will be in JSON\t|\n| numberinfo\t| Flag to query service provider and location data\t| 1 or 0\t|\n| page\t| Page number to fetch status details from a particular page\t| 1 or more (1 page can contain maximum 500 entries)\t|\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\": \"A417\",\n    \"message\": \"Invalid Message ID/Mobile. No details found\"\n\t}\n\n## Example Error Response (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n\t<api>\n    <status>A416</status>\n    <message>Invalid Message ID/Mobile</message>\n\t</api>\n\n## Response Data\n\n| Field\t| Description\t|\n|-------|---------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the response is wrapped in side data\t|\n| sms\t| Each number will be wrapped inside sms\t|\n| id\t| Website message id for your reference\t|\n| custom1\t| Custom message id 1 if you provide one\t|\n| custom2\t| Custom message id 2 if you provide one\t|\n| mobile\t| Mobile number the sms will be sent\t|\n| status\t| status of the message\t|\n| custom\t| Custom message id if you provide one\t|\n| senttime | message sent time\t|\n| dlrtime\t| message delivered time\t|\n| provider\t| provider of the mobile numer\t|\n| location\t| Registered location of the mobile number\t|\n\n## Mandatory Parameters"},"response":[],"_postman_id":"582318f2-4260-4ce3-b55c-d2e934a2ffe0"},{"name":"Look up Using HLR Information","id":"2b96a7a5-66ef-433f-a259-6ee9c8e68b62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/index.php?api_key={{api_key}}&method=lookup&to={{phone_number}}","host":["{{global_baseurl}}"],"path":["{{version}}","index.php"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"lookup"},{"key":"to","value":"{{phone_number}}"}]},"description":"# What can you do with this API?\nThrough this API, you'll be able to look up for HLR (Home Location Register) information for any valid mobile number. After performing lookup, you will be able to access HLR information only on your account. HLR information will include information about number network operator, Home Location, roaming network, ported network etc.,\n\n## API to initiate HLR on Global application\n**API 1: To trigger this API for global application, follow the API below:**\n> https://api-global.kaleyra.com/v4/?api_key=Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx5&method=hlr&to=xxxxxxxxxxxx&format=xml\n\n**API 2: An optional API is provided with same parameters, listed below:**\n> https://api-global.kaleyra.com/v4/?api_key=Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx5&method=hlr&to=xxxxxxxxxxxx&format=xml\n\n### Difference between API 1 & API 2:\n\tThe only difference between the above mentioned API are the response in the delivery status of the SMS.\n\n\tIn the API where,\n\tmethod=hlr, the delivery status is \"DELIVERED\"\n\n\twhereas in the API where,\n\tmethod=lookup, the delivery status is \"AWAITED DLR\"\n\n\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\":\"A400\",\n    \"message\":\"Api Not Implemented\"\n\t}\n\n## Example Error Response (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n\t<api>\n    <status>E608</status>\n    <message>No Valid mobile numbers found</message>\n\t</api>\n\n## Response Data\n\n| Field\t| Description\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the responses are wrapped inside data\t|\n| Mobile\t| Mobile number\t|\n| id\t| External message ID\t|\n\n## API Mandatory Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"2b96a7a5-66ef-433f-a259-6ee9c8e68b62"},{"name":"DIP Look Up","id":"6a94b16b-20ce-4ec1-bbbd-1f8182f012e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=dip.lookup&to={{phone_number}}&format=json","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"dip.lookup"},{"key":"to","value":"{{phone_number}}","description":"Enter Mobile number"},{"key":"format","value":"json"}]},"description":"# What can you do with this API?\nThrough this API, you'll be able to look up for network information for any valid Indian mobile number. This will include information about number network operator, ported network etc.,\n\nThe following information can be accessed using this API:\n1. Original network\n2. Ported network\n3. MCC and MNC\n4. Current circle\n\n>> This API supports GET/ POST methods.\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Example Error Response (JSON)\n\n\t{\n    \"status\":\"A400\",\n    \"message\":\"Api Not Implemented\"\n\t}\n\n## Example Error Response (XML)\n\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n\t<api>\n    <status>E608</status>\n    <message>No Valid mobile numbers found</message>\n\t</api>\n\n## Response Data\n\n| Field\t| Description\t|\n|-----------|-----------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message |\t|\n| id\t| Message sent id post successful submission of SMS\t|\n| Mobile\t| Mobile number\t|\n| Origin network\t| mobile number original network\t|\n| Origin circle\t| mobile number original circle\t|\n| Ported network | The network to which the number is ported\t|\n| Ported circle\t| The ported circle\t|\n| MCC | Mobile country code |\n| MNC | Mobile network code |"},"response":[{"id":"f9d81b33-7747-4548-9129-cbec8a56de3b","name":"DIP Look Up","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://global.kaleyra.com/api/v4/?api_key={{api_key}}&method={{dip.lookup}}&to={{to}}&format=json","protocol":"https","host":["global","kaleyra","com"],"path":["api","v4",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{dip.lookup}}"},{"key":"to","value":"{{to}}"},{"key":"format","value":"json"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"OK\",\r\n    \"message\": \"Success\",\r\n    \"data\": [\r\n        {\r\n            \"id\": \"f96cb288-efa0-4745-bbff-2c689XXXXXXX\",\r\n            \"mobile\": 919900XXXXXX,\r\n            \"origin_network\": \"Airtel \",\r\n            \"origin_circle\": \" Karnataka\",\r\n            \"ported_network\": \"Vodafone \",\r\n            \"ported_circle\": \" Karnataka\",\r\n            \"mcc\": \"404\",\r\n            \"mnc\": \"86\"\r\n        }\r\n    ]\r\n}\r\n"}],"_postman_id":"6a94b16b-20ce-4ec1-bbbd-1f8182f012e3"},{"name":"Look up using JSON Data","id":"eae112d4-4d41-4c7d-a5ad-06a306eb56a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=lookup.json&json={\"lookup\": [{\n\"to\": \"{{phone_number}}\"\n}, {\n\"to\": \"{{phone_number}}\"\n}], \"dlrurl\": \"http://www.example.com/dlr.php/......\"\n}","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"lookup.json"},{"key":"json","value":"{\"lookup\": [{\n\"to\": \"{{phone_number}}\"\n}, {\n\"to\": \"{{phone_number}}\"\n}], \"dlrurl\": \"http://www.example.com/dlr.php/......\"\n}"}]},"description":"# What can you do with this API?\nThrough this API, you'll be able to perform LookUp to access HLR information for single or multiple numbers using XML/JSON data.\n\n## API to Lookup using JSON Data\n\t\n\thttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.json&to=92xxxxxxxx&json=%3A%2F%2Fdomain.net%2F.......\n\n## API to Lookup using XML Data\n\t\n\thttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.xml&to=92xxxxxxxx&xml=%3A%2F%2Fdomain.net%2F.......\n# Prerequisites\n\n1. Valid Mobile Number(s)\n2. XMl/JSON Data\n\n## Sample DLR URL\n\t\n\thttp%3A%2F%2Fdomain.net%2Fdlr%2Ftrigger.php%3Forig_network%3D%7Borig_network%7D%26orig_country%3D%7Borig_country%7D%26orig_circle%3D%7Borig_circle%7D%26%0D%0Aorig_cprefix%3D%7Borig_cprefix%7D%26orig_nprefix%3D%7Borig_nprefix%7D%26orig_code%3D%7Borig_code%7D%26is_roaming%3D%7Bis_roaming%7D%26roaming_network%3D%7Broaming_network%7D%26roaming_country%3D%7Broaming_country%7D%26roaming_circle%3D%7Broaming_circle%7D%26roaming_cprefix%3D%7Broaming_cprefix%7D%26roaming_nprefix%3D%7Broaming_nprefix%7D%26roaming_code%3D%7Broaming_code%7D%26is_ported%3D%7Bis_ported%7D%26ported_network%3D%7B+ported_network%7D%26ported_country%3D%7Bported_country%7D%26ported_circle%3D%7Bported_circle%7D%26ported_cprefix%3D%7Bported_cprefix%7D%26ported_nprefix%3D%7Bported_nprefix%7D%26ported_code%3D%7Bported_code%7D%26mcc%3D%7Bmcc%7D%26mnc%3D%7Bmnc%7D%26imsi%3D%7Bimsi%7D%26status%3D%7Bstatus%7D%26smsc%3D%7Bsmsc%7D%26err_code%3D%7Berr_code%7D\n\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional API Parameters\nThe Optional parameter in HTTP API is tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n\n\n## Custom XML/JSON Tags\n\n| Field Name\t| Description\t|\n|-----------|-------------------|\n| {orig_country}\t| Original Country Name\t|\n| {orig_circle}\t| From which circle, number does belong originally\t|\n| {orig_cprefix}\t| Original Country Prefix\t|\n| {orig_nprefix}\t| Original Network Prefix\t|\n| {orig_code}\t| Original geographical circle code\t|\n| {is_roaming}\t| Whether number is in roaming or not\t|\n| {roaming_network}\t| Roaming Network Name\t|\n| {roaming_country}\t| Roaming Country Name\t|\n| {roaming_circle}\t| In which circle current number is under roaming\t|\n| {orig_network}\t| Original Network Name\t|\n| {roaming_cprefix}\t| Roaming Country Prefix\t|\n| {roaming_nprefix}\t| Roaming Network Prefix\t|\n| {roaming_code}\t| Geographical roaming circle code\t|\n| {is_ported}\t| Whether number has been ported or not\t|\n| {ported_network}\t| Ported Network Name\t|\n| {ported_country}\t| Ported Country Name\t|\n| {ported_nprefix}\t| Ported Network Prefix\t|\n| {ported_code}\t| Geographical ported circle code\t|\n| {mcc}\t| Mobile country code used in the combination of mobile network code to uniquely identify an operator\t|\n| {mnc}\t| Mobile country code used in the combination of mobile network code to uniquely identify an operator\t|\n| {imsi}\t| 15-digit IMSI number of the mobile subscriber's phone number (MSISDN)\t|\n| {ported_circle}\t| To which circle this number has been ported\t|\n| {ported_cprefix}\t| Ported Country Prefix\t|\n| {status}\t| It indicates the success or failure of your request.\t|\n| {smsc}\t| SMS Centre number\t|\n| {err_code}\t| If there is any error or not\t|\n\n\n## Response Data\n\n| Field Name\t| Description\t|\n|-----------|-------------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the responses is wrapped inside data\t|\n| Mobile\t| Mobile number\t|\n| id\t| External message ID\t|\n\n## Mandatory API Specifications\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"eae112d4-4d41-4c7d-a5ad-06a306eb56a3"},{"name":"Look up using XML Data","id":"c9f3e95e-d028-4ee9-b4ae-64dc8f3c42e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=lookup.xml&to={{phone_number}}&xml=<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<dlrurl>\n   <![CDATA[http://domain.com/dlr.php]]>\n</dlrurl>\n<lookup>\n  <to>{{phone_number}}</to>\n</lookup>\n</xmlapi>","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"lookup.xml"},{"key":"to","value":"{{phone_number}}"},{"key":"xml","value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<dlrurl>\n   <![CDATA[http://domain.com/dlr.php]]>\n</dlrurl>\n<lookup>\n  <to>{{phone_number}}</to>\n</lookup>\n</xmlapi>"}]},"description":"# What can you do with this API?\nThrough this API, you'll be able to perform LookUp to access HLR information for single or multiple numbers using XML/JSON data.\n\n## API to Lookup using JSON Data\n\t\n\thttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.json&to=92xxxxxxxx&json=%3A%2F%2Fdomain.net%2F.......\n\n## API to Lookup using XML Data\n\t\n\thttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.xml&to=92xxxxxxxx&xml=%3A%2F%2Fdomain.net%2F.......\n# Prerequisites\n\n1. Valid Mobile Number(s)\n2. XMl/JSON Data\n\n## Sample DLR URL\n\t\n\thttp%3A%2F%2Fdomain.net%2Fdlr%2Ftrigger.php%3Forig_network%3D%7Borig_network%7D%26orig_country%3D%7Borig_country%7D%26orig_circle%3D%7Borig_circle%7D%26%0D%0Aorig_cprefix%3D%7Borig_cprefix%7D%26orig_nprefix%3D%7Borig_nprefix%7D%26orig_code%3D%7Borig_code%7D%26is_roaming%3D%7Bis_roaming%7D%26roaming_network%3D%7Broaming_network%7D%26roaming_country%3D%7Broaming_country%7D%26roaming_circle%3D%7Broaming_circle%7D%26roaming_cprefix%3D%7Broaming_cprefix%7D%26roaming_nprefix%3D%7Broaming_nprefix%7D%26roaming_code%3D%7Broaming_code%7D%26is_ported%3D%7Bis_ported%7D%26ported_network%3D%7B+ported_network%7D%26ported_country%3D%7Bported_country%7D%26ported_circle%3D%7Bported_circle%7D%26ported_cprefix%3D%7Bported_cprefix%7D%26ported_nprefix%3D%7Bported_nprefix%7D%26ported_code%3D%7Bported_code%7D%26mcc%3D%7Bmcc%7D%26mnc%3D%7Bmnc%7D%26imsi%3D%7Bimsi%7D%26status%3D%7Bstatus%7D%26smsc%3D%7Bsmsc%7D%26err_code%3D%7Berr_code%7D\n\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional API Parameters\nThe Optional parameter in HTTP API is tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n\n\n## Custom XML/JSON Tags\n\n| Field Name\t| Description\t|\n|-----------|-------------------|\n| {orig_country}\t| Original Country Name\t|\n| {orig_circle}\t| From which circle, number does belong originally\t|\n| {orig_cprefix}\t| Original Country Prefix\t|\n| {orig_nprefix}\t| Original Network Prefix\t|\n| {orig_code}\t| Original geographical circle code\t|\n| {is_roaming}\t| Whether number is in roaming or not\t|\n| {roaming_network}\t| Roaming Network Name\t|\n| {roaming_country}\t| Roaming Country Name\t|\n| {roaming_circle}\t| In which circle current number is under roaming\t|\n| {orig_network}\t| Original Network Name\t|\n| {roaming_cprefix}\t| Roaming Country Prefix\t|\n| {roaming_nprefix}\t| Roaming Network Prefix\t|\n| {roaming_code}\t| Geographical roaming circle code\t|\n| {is_ported}\t| Whether number has been ported or not\t|\n| {ported_network}\t| Ported Network Name\t|\n| {ported_country}\t| Ported Country Name\t|\n| {ported_nprefix}\t| Ported Network Prefix\t|\n| {ported_code}\t| Geographical ported circle code\t|\n| {mcc}\t| Mobile country code used in the combination of mobile network code to uniquely identify an operator\t|\n| {mnc}\t| Mobile country code used in the combination of mobile network code to uniquely identify an operator\t|\n| {imsi}\t| 15-digit IMSI number of the mobile subscriber's phone number (MSISDN)\t|\n| {ported_circle}\t| To which circle this number has been ported\t|\n| {ported_cprefix}\t| Ported Country Prefix\t|\n| {status}\t| It indicates the success or failure of your request.\t|\n| {smsc}\t| SMS Centre number\t|\n| {err_code}\t| If there is any error or not\t|\n\n\n## Response Data\n\n| Field Name\t| Description\t|\n|-----------|-------------------|\n| status\t| It indicates the success or failure of your request.\t|\n| message\t| It indicates the success or failure message.\t|\n| data\t| All the responses is wrapped inside data\t|\n| Mobile\t| Mobile number\t|\n| id\t| External message ID\t|\n\n## Mandatory API Specifications\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"c9f3e95e-d028-4ee9-b4ae-64dc8f3c42e8"},{"name":"Create a Txtly Link","id":"8e7f4ab4-abc9-4c37-b87b-aa45300133c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=txtly.create&url=txtly_url&token=Yxxxzzxxx&title=ABC&advanced=1","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"txtly.create"},{"key":"url","value":"txtly_url"},{"key":"token","value":"Yxxxzzxxx","description":"Mention the txtly token. "},{"key":"title","value":"ABC","description":"Mention the txtly title."},{"key":"advanced","value":"1"}]},"description":"If Txtly URL has been sent via SMS to customers with analytics enabled, then this will be valid only for 3days. After 3 days, user will be redirected to the valid URL but their mobile numbers would not be captured.\r\n\r\n# Prerequisites\r\n\r\n1. An API Key\r\n2. Sender ID\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional API Parameters\r\nThe Optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| Format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\r\n| Token\t| http://msg.mn/heel Here heel is the token. It is unique for each txtly\t| This can be customized word representing your brand/company. If not provided a random unique token is generated\t|\r\n| Title\t| A significant title to your txtly\t| If not provided, your txtly will not contain any title\t|\r\n| Advanced\t| advanced analytics gives an option to track who (Recipient mobile numbers) visited the page\t| 1- will enable advanced analytics/0(default) - will disable advanced analytics.\t|\r\n| Track\t| Location Track gives the city and state details of URL visitor\t| 1- will enable location tracking/0(default) - will disable location tracking\t|\r\n| Attach\t| Media file that requires to be compressed to a short link.\t| Provide the media file in a CURL request\t|\r\n\r\n## Example Error Response (JSON)\r\n\r\n\t{\r\n    \"status\": \"E500\",\r\n    \"message\": \"Please provide url to redirect\"\r\n\t}\r\n\r\n## Example Error Response (XML)\r\n\r\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n\t<api>\r\n    <status>E500</status>\r\n    <message>Please provide url to redirect</message>\r\n\t</api>\r\n\r\n## Response Data\r\n\r\n| Field\t| Description\t|\r\n|-------|---------------|\r\n| status\t| It indicates the success or failure of your request.\t|\r\n| message\t| It indicates the success or failure message.\t|\r\n| token\t| Returns the unique token of that txtly\t|\r\n| txtly\t| compressed url that is ready to use\t|\r\n| id\t| ID of the txtly created\t|\r\n\r\n\r\n## Mandatory API Specifications\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"8e7f4ab4-abc9-4c37-b87b-aa45300133c9"},{"name":"Extract Txtly Reports","id":"0ec73868-c3fe-446f-a654-e13b457dca09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=txtly&app=1","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"txtly"},{"key":"app","value":"1"}]},"description":"# What can you do with this API?\nThrough this API, you can extract the reports of all the Txtly links that have been shortened in your account. At once, user may pull maximum 25 Txtly reports.\n\n# API Parameter Specifications\nThe API parameter specifications are described in the following sections.\n\n## Optional API Parameters\nThe Optional parameter in the HTTP API is tabulated below:\n\n| Parameter\t| Description\t| Expected Value\t|\n|-----------|---------------|-------------------|\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\n| page\t| Page number to fetch Txtly reports from a particular page\t| 1 or more (1 page can contain maximum 25 Txtly reports)\t|\n\n## Mandatory API Parameters\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"0ec73868-c3fe-446f-a654-e13b457dca09"},{"name":"Pull Individual Txtly Logs","id":"2faaede9-7bc2-4785-8965-80b17deb7cba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=txtly.logs&id=351xx&app=1","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"txtly.logs"},{"key":"id","value":"351xx","description":"Enter your TXTLY id"},{"key":"app","value":"1"}]},"description":"# What can you do with this API?\r\nThrough this API, you can pull out event logs for a particular Txtly URL. You must have created and executed any Txtly campaign so as to track its views/clicked logs.\r\n\r\n\r\n# Prerequisites\r\n1. An active API Key\r\n2. Txtly ID\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Mandatory API Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"2faaede9-7bc2-4785-8965-80b17deb7cba"},{"name":"Delete a Txtly Link","id":"1e12ffd1-f306-4c0f-b44a-9323f780989a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=txtly&task=delete&id=351xx&app=1","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"txtly"},{"key":"task","value":"delete"},{"key":"id","value":"351xx","description":"Enter your txtly id"},{"key":"app","value":"1"}]},"description":"# What can you do with this API?\r\nThis API enables you to delete the created Txtly web link. If Txtly URL got deleted, then user wont be able to use it and redirect anywhere.\r\n\r\n> User must have a Txtly ID to delete the associated Txtly URL from the database.\r\n\r\n# Prerequisites\r\n1. An active API Key\r\n2. Txtly ID\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional API parameters\r\nThe Optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\r\n\r\n## Example Error Response (JSON)\r\n\r\n\t{\r\n    \"status\": \"ERROR\",\r\n    \"message\": \"Id entered not exits with this api user\", \"data\": []\r\n\t}\r\n\r\n## Example Error Response (XML)\r\n\r\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n\t<api>\r\n    <status>ERROR</status>\r\n    <message>Id entered not exits with this api user</message>\r\n    <data></data>\r\n\t</api>\r\n\r\n## Response Data\r\n\r\n| Field\t| Description\t|\r\n|-------|---------------|\r\n| status\t| It indicates the success or failure of your request.\t|\r\n| message\t| It indicates the success or failure message.\t|\r\n| data\t| All the responses is wrapped inside data\t|\r\n\r\n## Mandatory API Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"1e12ffd1-f306-4c0f-b44a-9323f780989a"},{"name":"Send an Email","id":"515fb655-8321-4667-bd79-aa96d25f7537","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=email&format=JSON&subject=Welcome to Kaleyra API&to[0][email]={{emailid}}&to[0][name]=Test API &from[email]={{emailid}}&text=Hi \nhow are you today&from[name]={{name}}&files[]=_logo.png","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"email"},{"key":"format","value":"JSON"},{"key":"subject","value":"Welcome to Kaleyra API"},{"key":"to[0][email]","value":"{{emailid}}","description":"To recipient email ID"},{"key":"to[0][name]","value":"Test API "},{"key":"from[email]","value":"{{emailid}}","description":"From email ID"},{"key":"text","value":"Hi \nhow are you today","description":"Your message"},{"key":"from[name]","value":"{{name}}"},{"key":"files[]","value":"_logo.png"}]},"description":"# What can you do with this API?\r\nThis API enables you to delete the created Txtly web link. If Txtly URL got deleted, then user wont be able to use it and redirect anywhere.\r\n\r\n> User must have a Txtly ID to delete the associated Txtly URL from the database.\r\n\r\n# Prerequisites\r\n1. An active API Key\r\n2. Txtly ID\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional API parameters\r\nThe Optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\r\n\r\n## Example Error Response (JSON)\r\n\r\n\t{\r\n    \"status\": \"ERROR\",\r\n    \"message\": \"Id entered not exits with this api user\", \"data\": []\r\n\t}\r\n\r\n## Example Error Response (XML)\r\n\r\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n\t<api>\r\n    <status>ERROR</status>\r\n    <message>Id entered not exits with this api user</message>\r\n    <data></data>\r\n\t</api>\r\n\r\n## Response Data\r\n\r\n| Field\t| Description\t|\r\n|-------|---------------|\r\n| status\t| It indicates the success or failure of your request.\t|\r\n| message\t| It indicates the success or failure message.\t|\r\n| data\t| All the responses is wrapped inside data\t|\r\n\r\n## Mandatory API Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"515fb655-8321-4667-bd79-aa96d25f7537"},{"name":"Send an Email Template","id":"c5d451e2-695b-45b4-8978-83a9e46eb0e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=email&format=xml&subject=Kaleyraemail&to[0][email]={{emailid}}&to[0][name]={{name}}&from[email]={{emailid}}","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"email"},{"key":"format","value":"xml"},{"key":"subject","value":"Kaleyraemail"},{"key":"to[0][email]","value":"{{emailid}}","description":"To recipient email ID"},{"key":"to[0][name]","value":"{{name}}","description":"Recipient name"},{"key":"from[email]","value":"{{emailid}}","description":"From email ID"}]},"description":"# What can you do with this API?\r\nThis API enables you to delete the created Txtly web link. If Txtly URL got deleted, then user wont be able to use it and redirect anywhere.\r\n\r\n> User must have a Txtly ID to delete the associated Txtly URL from the database.\r\n\r\n# Prerequisites\r\n1. An active API Key\r\n2. Txtly ID\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional API parameters\r\nThe Optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| format\t| Output format should be as specified by this variable\t| XML/PHP/JSON/JSONP. Default response will be in JSON\t|\r\n\r\n## Example Error Response (JSON)\r\n\r\n\t{\r\n    \"status\": \"ERROR\",\r\n    \"message\": \"Id entered not exits with this api user\", \"data\": []\r\n\t}\r\n\r\n## Example Error Response (XML)\r\n\r\n\t<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n\t<api>\r\n    <status>ERROR</status>\r\n    <message>Id entered not exits with this api user</message>\r\n    <data></data>\r\n\t</api>\r\n\r\n## Response Data\r\n\r\n| Field\t| Description\t|\r\n|-------|---------------|\r\n| status\t| It indicates the success or failure of your request.\t|\r\n| message\t| It indicates the success or failure message.\t|\r\n| data\t| All the responses is wrapped inside data\t|\r\n\r\n## Mandatory API Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"c5d451e2-695b-45b4-8978-83a9e46eb0e2"},{"name":"Send an Email with Attachment","id":"25dbc407-bc25-4179-a252-e0dcb72e3f62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=email&format=JSON&subject=Welcome to Kaleyra API&to[0][email]={{emailid}}&to[0][name]=Test API &from[email]={{emailid}}&text=Hi \nhow are you today&from[name]={{name}}&files[]=_logo.png","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"email"},{"key":"format","value":"JSON"},{"key":"subject","value":"Welcome to Kaleyra API"},{"key":"to[0][email]","value":"{{emailid}}","description":"To recipient email ID"},{"key":"to[0][name]","value":"Test API "},{"key":"from[email]","value":"{{emailid}}","description":"From email ID"},{"key":"text","value":"Hi \nhow are you today","description":"Your message"},{"key":"from[name]","value":"{{name}}"},{"key":"files[]","value":"_logo.png"}]},"description":"# What can you do with this API?\r\nYou can send an email with media and attachments through this API. \r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional Parameters\r\nThe optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| Files[]\t| Attachment upto 10Mb\t| Attach any file to be sent to recipients; Recipients will receive emails along with the attachments upto 10Mb\t|\r\n| To[0][name]\t| Name of recipient to be shown in email; Can also be used for multiple recipients associated with email IDs like To[1][name], to[2][name],etc\t| To whom you want to send email(s); Recipient name(s)\t|\r\n| From[name]\t| Who has sent this email(s) i.e. Sender Name to be shown in email\t| Sender name so that recipients must know that you have sent email(s)\t|\r\n| format\t| XML/PHP/JSON/JSONP.\t| In which format you want to see the response. Default response will be in JSON\t|\r\n| time\t| YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t| Date and time need to be mentioned; when you want to schedule an email.\t|\r\n| name\t| Campaign name\t| You may give any name to this email campaign\t|\r\n\r\n## Mandatory API Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"25dbc407-bc25-4179-a252-e0dcb72e3f62"},{"name":"Send a HTML Email","id":"04fdb208-ec78-4f87-ae12-8f4b3865c3c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=email&format=xml&subject=Kaleyraemail&to[0][email]={{email ID}}&to[0][name]={{name}}&from[email]={{emailid}}&from[name]={{name}}&files[]=_logo.png&template[id]=zYkNxxxx&html= <div class=\"form-group\"> <label for=\"password\"> Password </label> <input type=\"password\" name=\"password\" class=\"form-control\" required=\"required\" placeholder=\"Enter your password\" autocomplete=\"off\" /> <a href=\"http://<domainURL/members/resetpass\" id=\"forgot-password\">Forgot?</a> </div>","host":["{{global_baseurl}}"],"path":["{{version}}",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"email"},{"key":"format","value":"xml"},{"key":"subject","value":"Kaleyraemail"},{"key":"to[0][email]","value":"{{email ID}}","description":"To recipient email ID"},{"key":"to[0][name]","value":"{{name}}"},{"key":"from[email]","value":"{{emailid}}","description":"From email ID"},{"key":"from[name]","value":"{{name}}"},{"key":"files[]","value":"_logo.png"},{"key":"template[id]","value":"zYkNxxxx","description":"Enter your template ID"},{"key":"html","value":" <div class=\"form-group\"> <label for=\"password\"> Password </label> <input type=\"password\" name=\"password\" class=\"form-control\" required=\"required\" placeholder=\"Enter your password\" autocomplete=\"off\" /> <a href=\"http://<domainURL/members/resetpass\" id=\"forgot-password\">Forgot?</a> </div>"}]},"description":"# What can you do with this API?\r\nThrough this API, you can apply CSS styles to such HTML content based emails and your outgoing mail will adopt these styles across all recipients.\r\n\r\n# API Parameter Specifications\r\nThe API parameter specifications are described in the following sections.\r\n\r\n## Optional Parameters\r\nThe optional parameters in the HTTP API are tabulated below:\r\n\r\n| Parameter\t| Description\t| Expected Value\t|\r\n|-----------|---------------|-------------------|\r\n| Template[id]\t| Template ID (numeric value) for specific template\t| Use this template ID for pre-defined templates created in the application; template will be applied to outgoing email campaign\t|\r\n| Files[]\t| Attachment upto 10Mb\t| Attach any file to be sent to recipients; Recipients will receive emails along with the attachments upto 10Mb\t|\r\n| To[0][name]\t| Name of recipient to be shown in email; Can also be used for multiple recipients associated with email IDs like To[1][name], to[2][name],etc\t| To whom you want to send email(s); Recipient name(s)\t|\r\n| From[name]\t| Who has sent this email(s) i.e. Sender Name to be shown in email\t| Sender name so that recipients must know that you have sent email(s)\t|\r\n| format\t| XML/PHP/JSON/JSONP.\t| In which format you want to see the response. Default response will be in JSON\t|\r\n| time\t| YYYY-MM-DD HH:mm:SS OR YYYY-MM-DD HH:MM AM/PM\t| Date and time need to be mentioned; when you want to schedule an email.\t|\r\n| name\t| Campaign name\t| You may give any name to this email campaign\t|\r\n\r\n## Expected API Error Codes\r\n\r\n| Code\t| Description\t|\r\n|-------|---------------|\r\n| E601\t| Missing recipient\t|\r\n| E602\t| Invalid Template\t|\r\n| E603\t| Missing message\t|\r\n| E604\t| Invalid schedule time. Minimum 5minutes time gap is required.\t|\r\n| E606\t| Unable to find gateway to send email\t|\r\n| E607\t| No valid email address found\t|\r\n| E609\t| Unable to write to temp files\t|\r\n| E610\t| Unable to process your request. try again\t|\r\n| E599\t| Missing From address\t|\r\n| A401B\t| Method not found\t|\r\n| E600\t| Missing Subject\t|\r\n| A402\t| API key not found\t|\r\n\r\n## Mandatory Parameters\r\nThe mandatory parameters in the HTTP API are tabulated below:"},"response":[],"_postman_id":"04fdb208-ec78-4f87-ae12-8f4b3865c3c2"}],"id":"6dc9095e-023c-44c2-8626-be7a6a665ac3","description":"This section enables you to use our SMS API on Global messaging platform (GMP). You can use the API mentioned in the Alerts section except Optin message and SMS Optin group, with the following base URL\n\n> https://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\n","event":[{"listen":"prerequest","script":{"id":"1c09c59d-0de2-4441-a6d6-a136eafc0381","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"466b11f6-efa1-4e74-9ab2-07180b489153","type":"text/javascript","exec":[""]}}],"_postman_id":"6dc9095e-023c-44c2-8626-be7a6a665ac3"},{"name":"Promo SMS","item":[{"name":"Send an SMS","id":"ec9fd195-8ddf-45bb-af9b-cdebbdc20186","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"https://api-promo.kaleyra.com/v4/?api_key={{api_key}}&message={{hello}}&sender={{sender_id}}&to={{to}}&method=sms","protocol":"https","host":["api-promo","kaleyra","com"],"path":["v4",""],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"message","value":"{{hello}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"to","value":"{{to}}"},{"key":"method","value":"sms"}]},"description":"This is an example page that explains the usage of promo base url."},"response":[],"_postman_id":"ec9fd195-8ddf-45bb-af9b-cdebbdc20186"}],"id":"905d67a4-3b30-45a0-ad98-9f4e50ae1cc3","description":"This section enables you to trigger SMS API from our Promo application. With promo application, you can send promotional SMS with special offers and discounts.\n\nThe base url to trigger the API is mentioned below:\n> https://api-promo.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\n\nNote: You can use all SMS API mentioned in the Alerts section with the Promo base url.","_postman_id":"905d67a4-3b30-45a0-ad98-9f4e50ae1cc3"}],"event":[{"listen":"prerequest","script":{"id":"3d723514-a3e1-4a43-a732-81a14703ee83","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"329e947c-c9f7-40cd-a814-e1db7e4cefe1","type":"text/javascript","exec":[""]}}]}