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!
\nEach API works in both GET and POST methods.
\nTo read more about getting started with SMS and troubleshooting, visit our docs here
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"SMS Documentation","slug":"sms-documentation"}],"owner":"5548422","collectionId":"330401eb-cd49-db01-64bd-91f042632f70","publishedId":"Rztfuqyf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"1E1F2C","highlight":"D80D30"},"publishDate":"2019-02-15T07:20:13.000Z"},"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":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{sms}}&message={{hello}}&to={{phone_number}}&sender={{sender_id}}","description":"This API enables you to send an SMS to a single number, group of numbers and a contact group.
\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.
\nIf you wish to send SMS globally, the Base URL is listed below.
\n\n\nhttps://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX
\n
The 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.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe advanced parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"query":[{"description":{"content":"The API Key sent to your registered email ID
\n","type":"text/plain"},"key":"api_key","value":"{{api_key}}"},{"description":{"content":"Predefined method
\n","type":"text/plain"},"key":"method","value":"{{sms}}"},{"description":{"content":"Message text which is URL encoded (1000 char for normal, 500 for Unicode)
\n","type":"text/plain"},"key":"message","value":"{{hello}}"},{"description":{"content":"Phone number(s) to which you want to send the SMS
\n","type":"text/plain"},"key":"to","value":"{{phone_number}}"},{"description":{"content":"Sender ID assigned to your account
\n","type":"text/plain"},"key":"sender","value":"{{sender_id}}"}],"variable":[]}},"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":"\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.
\nMessage Schedule Time lapses
\n\n\nSMS cannot be scheduled before 5 minutes and after 3 months from the date of scheduling the SMS.
\n
If you wish to send SMS globally, the Base URL is listed below.
\n\n\nhttps://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX
\n
The 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.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe advanced parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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"}],"variable":[]}},"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":"\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\n\nApplication 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
The API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}","index.php"],"host":["{{base_url}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"groupid","value":"{{groupid}}"},{"key":"time","value":"{{time}}"},{"key":"task","value":"modify"},{"key":"method","value":"{{schedule}}"}],"variable":[]}},"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":"Through 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\nYour 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
The API parameter specifications are described in the following sections.
\nYou 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:
\nIf you wish to send SMS globally, the Base URL is listed below.
\n\n\nhttps://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX
\n
Put Unicode=1 if you want to send message in Unicode format. Even if its English, credits will be charged as per Unicode characters.
\nPut Unicode=0 if you don`t want to send Unicode message.
\nPut Unicode=auto for automatic detection of Unicode SMS. Based on language, system will detect language and charge accordingly.
\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.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe advanced parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}","index.php"],"host":["{{base_url}}"],"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}}"}],"variable":[]}},"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":"\r\nUsing 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.
\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.
\n\n\nNOTE: The API tries to hit the application(port) for 10 seconds, if unsuccessful the message is delivered on the native inbox
\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.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe advanced parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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"}],"variable":[]}},"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":"\r\nThis API enables you to send an SMS using XML programming language.
\nThe API parameter specifications are described in the following sections.
\nThe Optional parameters in the HTTP API are tabulated below:
\n\n\nNOTE: If message,sender and dlrurl is specified within both SMS tag and XML tag, the former overrides the later.
\n
In case of special characters in the content within any of the XML tags, enclose it within CDATA as in following examples.
\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<api>\n<campaign>campaign</campaign>\n<dlrurl><![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]></dlrurl>\n<time>2014-12-2604:00pm</time>\n<unicode>0</unicode>\n<flash>0</flash>\n<sender>senderid</sender>\n<message><![CDATA[smstext]]></message>\n<sms><to>9190********</to></sms>\n<sms><to>9191********</to></sms>\n</api>\n<api>\n<campaign>campaign</campaign>\n<time>2014-12-26 04:00pm</time>\n<unicode>0</unicode>\n<flash>0</flash>\n<sms>\n<to>9190********</to>\n<sender>senderid</sender>\n<message>smstext</message>\n<custom>2</custom>\n<dlrurl>\n<![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]>\n</dlrurl> \n</sms>\n<sms>\n<to>9191********</to>\n<sender>senderid</sender>\n<message><![CDATA[smstext]]></message>\n<custom>2</custom>\n<dlrurl>\n<![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]>\n</dlrurl> \n</sms>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{sms.xml}}"},{"key":"xml","value":"\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\nSMS can be sent using the JSON API by posting values to the preceding URL by the POST method with URL encoded JSON data.
\n
If you wish to send SMS globally, the Base URL is listed below.
\n\n\nhttps://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX
\n
In case of special characters in the content within any of the JSON tags, enclose it within CDATA as in following examples.
\n{\n\"message\": \"test json\",\n\"sender\": \"AAAAAA\",\n\"sms\":[\n{\n\"to\": \"95XXXXXXXX\",\n\"msgid\": \"1\",\n\"message\": \"test sms\",\n\"custom1\": \"11\",\n\"custom2\": \"22\",\n\"sender\": \"AAAAAA\"\n},\n{\n\"to\": \"99XXXXXXXX\",\n\"msgid\": \"2\",\n\"custom1\": \"1\",\n\"custom2\": \"2\" \n}],\n\"unicode\": 1,\n\"flash\": 1,\n\"dlrurl\": \"http://www.example.com/dlr.php\" \n}\n\"message\": \"test json\",\n\"sms\":[\n{\n\"to\": \"95XXXXXXXX\",\n\"msgid\": \"1\",\n\"message\": \"test sms\",\n\"custom1\": \"11\",\n\"custom2\": \"22\",\n\"sender\": \"AAAAAA\" },\n{\n\"to\": \"99XXXXXXXX\",\n\"msgid\": \"2\",\n\"message\": \"json test sms\",\n\"custom1\": \"1\",\n\"custom2\": \"2\"\n}],\n\"unicode\": 1,\n\"flash\": 1,\n\"dlrurl\": \"http://www.example.com/dlr.php\"\n}\nThe API parameter specifications are described in the following sections.
\nIf message, sender and dlrurl is specified within both SMS tag and JSON tag, the former overrides the later.
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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}"}],"variable":[]}},"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":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{optin}}&sender={{sender_id}}&message={{message}}&name=optingroup","description":"Through this API, you can send exclusive messages to your subscriber / Opt in list.
\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.
\nThe API parameter specifications are described in the following sections.
\n{\n\"status\": \"ERROR\",\n\"code\": \"A431\",\n\"message\": \"Group is empty\"\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>ERROR</status>\n<code>A431</code>\n<message>Group is empty</message>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{optin}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"message","value":"{{message}}"},{"key":"name","value":"optingroup"}],"variable":[]}},"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":"\r\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.
\nThe API parameter specifications are described in the following sections.
\nThe Optional parameter in the HTTP API is tabulated below:
\n{\n\"status\": \"ERROR\",\n\"message\": \"Group name already exists.\",\n\"data\": []\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>A401A</status>\n<message>Method Not Implemented</message>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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}}"}],"variable":[]}},"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":"\nThrough this API, you can add contacts to the SMS group you have created.
\nThe API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\n{\n \"status\": \"ERROR\",\n \"code\": \"A424\",\n \"message\": \"Group Name does not exist!\"\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>ERROR</status>\n<code>A424</code>\n<message>Group Name does not exist!</message>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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}}"}],"variable":[]}},"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":"\r\nThrough this API, you can add a single contact or multiple contacts to a group using JSON / XML data.
\n\n\nYou need to create a group in your account to add multiple contacts to an existing valid group before using the API
\n
The API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\n{\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}\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<contacts>\n<number>95xxxxxxxx</number>\n<fullname>xyz</fullname>\n<email>x@email.com</email>\n</contacts>\n<contacts> \n<number>99xxxxxxxx</number>\n<fullname>xyz1</fullname>\n<email>y@email.com</email>\n</contacts>\n</xmlapi>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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"}],"variable":[]}},"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":"\r\nThrough this API, you can add a single contact or multiple contacts to a group using JSON / XML data.
\n\n\nYou need to create a group in your account to add multiple contacts to an existing valid group before using the API
\n
The API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\n{\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}\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<contacts>\n<number>95xxxxxxxx</number>\n<fullname>xyz</fullname>\n<email>x@email.com</email>\n</contacts>\n<contacts> \n<number>99xxxxxxxx</number>\n<fullname>xyz1</fullname>\n<email>y@email.com</email>\n</contacts>\n</xmlapi>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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"}],"variable":[]}},"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":"\r\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
\nIn your account, there must be an existing group and numbers under that group to send any message to a group. \nThe following URL enables you to integrate the URL through which you can send customized messages to the group:
\n\n\nhttps://api-alerts.kaleyra.com/v4/?api_key=Af59xxxxxxxxxx&method=groups&name=MyGroupName&sender=AAAAAA&message=Dear {name}, Your email is {email}
\n
In 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\n\nResponse formats would be same for simple message to a group or a customized one.
\n
If you wish to send SMS globally, the Base URL is listed below.
\n\n\nhttps://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX
\n
The API parameter specifications are described in the following sections.
\n{\n\"status\": \"ERROR\",\n\"code\": \"A421\",\n\"message\": \"Group is empty/Invalid group\"\n}\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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}}"}],"variable":[]}},"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":"\r\nThrough this API, user will be able to check the available credits in his/her account.
\nThe API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\n{\n\"status\": \"A401A\",\n\"message\": \"Method Not Implemented\"\n}\n<api>\n<status>A401A</status>\n<message>Method Not Implemented</message>\n</api>\n200\r\n Through this API, user will be able to check the credits usage in his/her account.
\n\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\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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"}],"variable":[]}},"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":"\r\nPast 6 months data will be available
\n
200\r\n To 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\nIf using POST method for pulling messages status, then statuses for maximum 500 messages can be pulled at a time.
\n
The API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\n{\n\"status\": \"A417\",\n\"message\": \"Invalid Message ID/Mobile. No details found\"\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>A416</status>\n<message>Invalid Message ID/Mobile</message>\n</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.,
\nAPI 1: To trigger this API for global application, follow the API below:
\n\n\n\n
API 2: An optional API is provided with same parameters, listed below:
\n\n\n\n
The only difference between the above mentioned API are the response in the delivery status of the SMS.\n\nIn the API where,\nmethod=hlr, the delivery status is \"DELIVERED\"\n\nwhereas in the API where,\nmethod=lookup, the delivery status is \"AWAITED DLR\"\nThe API parameter specifications are described in the following sections.
\n{\n\"status\":\"A400\",\n\"message\":\"Api Not Implemented\"\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>E608</status>\n<message>No Valid mobile numbers found</message>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{lookup}}"},{"key":"to","value":"{{phone_number}}"}],"variable":[]}},"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":"\r\nThrough this API, you'll be able to perform LookUp to access HLR information for single or multiple numbers using XML/JSON data.
\nhttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.json&to=92xxxxxxxx&json=%3A%2F%2Fdomain.net%2F.......\nhttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.xml&to=92xxxxxxxx&xml=%3A%2F%2Fdomain.net%2F.......\nhttp%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\nThe API parameter specifications are described in the following sections.
\nThe Optional parameter in HTTP API is tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{lookup.json}}"},{"disabled":true,"key":"to","value":"{{to}}"},{"key":"json","value":"{\"lookup\": [{\n\"to\": \"{{to}}\"\n}, {\n\"to\": \"{{to}}\"\n}], \"dlrurl\": \"http://www.example.com/dlr.php/......\"\n}"}],"variable":[]}},"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":"{{base_url}}/{{version}}/?api_key={{api_key}}&method={{lookup.xml}}&to={{phone_number}}&xml=\nThrough this API, you'll be able to perform LookUp to access HLR information for single or multiple numbers using XML/JSON data.
\nhttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.json&to=92xxxxxxxx&json=%3A%2F%2Fdomain.net%2F.......\nhttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.xml&to=92xxxxxxxx&xml=%3A%2F%2Fdomain.net%2F.......\nhttp%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\nThe API parameter specifications are described in the following sections.
\nThe Optional parameter in HTTP API is tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{lookup.xml}}"},{"key":"to","value":"{{phone_number}}"},{"key":"xml","value":"\nTxtly is basically a shortened URL which can be used within text messages so that SMS would not exceed the specified characters.
\n\n\nNOTE: It is mandatory to either provide a URL or attachment that has to be compressed to a short link
\n
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.
\nThe API parameter specifications are described in the following sections.
\nThe Optional parameters in the HTTP API are tabulated below:
\n{\n\"status\": \"E500\",\n\"message\": \"Please provide url to redirect\"\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>E500</status>\n<message>Please provide url to redirect</message>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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"}],"variable":[]}},"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":"\r\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.
\nThe API parameter specifications are described in the following sections.
\nThe Optional parameter in the HTTP API is tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly}}"},{"key":"app","value":"1"}],"variable":[]}},"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":"\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.
\nThe API parameter specifications are described in the following sections.
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly.logs}}"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}],"variable":[]}},"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":"\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.
\n\n\nUser must have a Txtly ID to delete the associated Txtly URL from the database.
\n
The API parameter specifications are described in the following sections.
\nThe Optional parameters in the HTTP API are tabulated below:
\n{\n\"status\": \"ERROR\",\n\"message\": \"Id entered not exits with this api user\", \"data\": []\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>ERROR</status>\n<message>Id entered not exits with this api user</message>\n<data></data>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{txtly}}"},{"key":"task","value":"delete"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}],"variable":[]}},"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":"\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:
\n\n\nIf you have added multiple email IDs in a single parameter, then system will pick the last email ID.
\n
Example: 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.
\n\n\nEmail IDs must be in the following format & sequence only:\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
\n
\n\nParameters 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
\n
The API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{email}}"},{"key":"task","value":"delete"},{"key":"id","value":"{{id}}"},{"key":"app","value":"1"}],"variable":[]}},"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":"Through this API, you'll be able to send an email using a predefined Template format.
\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.
\nThe API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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}}"}],"variable":[]}},"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":"You can send an email with media and attachments through this API.
\nThe API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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'"}],"variable":[]}},"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":"Through this API, you can apply CSS styles to such HTML content based emails and your outgoing mail will adopt these styles across all recipients.
\nThe API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{base_url}}"],"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":" "}],"variable":[]}},"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.
\nhttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX\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","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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&message=Welcome to Kaleyra API&sender={{sender_id}}&to={{phone_number}}&method=sms","description":"With the GMP base url, you can send SMS with all the API in alerts section.
\nAn example of using base url is mentioned on this page.
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"description":{"content":"Enter your message
\n","type":"text/plain"},"key":"message","value":"Welcome to Kaleyra API"},{"key":"sender","value":"{{sender_id}}"},{"key":"to","value":"{{phone_number}}"},{"key":"method","value":"sms"}],"variable":[]}},"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":"{{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","description":"You 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.
\nMessage Schedule Time lapses
\n\n\nSMS cannot be scheduled before 5 minutes and after 3 months from the date of scheduling the SMS.
\n
The 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.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe advanced parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}","index.php"],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"sms"},{"description":{"content":"Enter your message
\n","type":"text/plain"},"key":"message","value":"Welcome to Kaleyra API"},{"key":"to","value":"{{to}}"},{"key":"sender","value":"{{sender_id}}"},{"description":{"content":"Format is in \"YYY-MM-DD HH:MM AM/PM\"
\n","type":"text/plain"},"key":"time","value":"2019-08-29 06:48 PM"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/index.php?api_key={{api_key}}&method=sms.schedule&groupid=6XXXX:1&time=2019-08-30 06:55 PM&task=modify","description":"Once 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\n\nApplication 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
The API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}","index.php"],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"sms.schedule"},{"description":{"content":"Enter your scheduled SMS ID
\n","type":"text/plain"},"key":"groupid","value":"6XXXX:1"},{"description":{"content":"Format is in \"YYY-MM-DD HH:MM AM/PM\"
\n","type":"text/plain"},"key":"time","value":"2019-08-30 06:55 PM"},{"key":"task","value":"modify"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/index.php?api_key={{api_key}}&method=sms.schedule&groupid=6XXXX:1&task=delete","description":"Through 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\nYour 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
The API parameter specifications are described in the following sections.
\nEnter your scheduled SMS ID
\n","type":"text/plain"},"key":"groupid","value":"6XXXX:1"},{"key":"task","value":"delete"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/index.php?method=sms&message=Welcome to Kaleyra API&to={{to}}&api_key={{api_key}}&sender={{sender_id}}&unicode=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:
\nPut Unicode=1 if you want to send message in Unicode format. Even if its English, credits will be charged as per Unicode characters.
\nPut Unicode=0 if you don`t want to send Unicode message.
\nPut Unicode=auto for automatic detection of Unicode SMS. Based on language, system will detect language and charge accordingly.
\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.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe advanced parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}","index.php"],"host":["{{global_baseurl}}"],"query":[{"key":"method","value":"sms"},{"description":{"content":"Enter your message
\n","type":"text/plain"},"key":"message","value":"Welcome to Kaleyra API"},{"description":{"content":"Enter mobile number
\n","type":"text/plain"},"key":"to","value":"{{to}}"},{"key":"api_key","value":"{{api_key}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"unicode","value":"1"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=sms&message=Welcome to Kaleyra API&to={{to}}&sender={{sender_id}}&port=82XX","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.
\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.
\n\n\nNOTE: The API tries to hit the application(port) for 10 seconds, if unsuccessful the message is delivered on the native inbox
\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.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe advanced parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"sms"},{"description":{"content":"Enter your message
\n","type":"text/plain"},"key":"message","value":"Welcome to Kaleyra API"},{"description":{"content":"Enter mobile number
\n","type":"text/plain"},"key":"to","value":"{{to}}"},{"key":"sender","value":"{{sender_id}}"},{"description":{"content":"Enter port number
\n","type":"text/plain"},"key":"port","value":"82XX"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/index.php?method=sms.xml&api_key={{api_key}}&xml=\nThis API enables you to send an SMS using XML programming language.
\nThe API parameter specifications are described in the following sections.
\nThe Optional parameters in the HTTP API are tabulated below:
\n\n\nNOTE: If message,sender and dlrurl is specified within both SMS tag and XML tag, the former overrides the later.
\n
In case of special characters in the content within any of the XML tags, enclose it within CDATA as in following examples.
\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<api>\n<campaign>campaign</campaign>\n<dlrurl><![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]></dlrurl>\n<time>2014-12-2604:00pm</time>\n<unicode>0</unicode>\n<flash>0</flash>\n<sender>senderid</sender>\n<message><![CDATA[smstext]]></message>\n<sms><to>9190********</to></sms>\n<sms><to>9191********</to></sms>\n</api>\n<api>\n<campaign>campaign</campaign>\n<time>2014-12-26 04:00pm</time>\n<unicode>0</unicode>\n<flash>0</flash>\n<sms>\n<to>9190********</to>\n<sender>senderid</sender>\n<message>smstext</message>\n<custom>2</custom>\n<dlrurl>\n<![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]>\n</dlrurl> \n</sms>\n<sms>\n<to>9191********</to>\n<sender>senderid</sender>\n<message><![CDATA[smstext]]></message>\n<custom>2</custom>\n<dlrurl>\n<![CDATA[http://domain.com/receive?msgid={msgid}&sid={sid}&status={status}&custom1={custom1}]]>\n</dlrurl> \n</sms>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}","index.php"],"host":["{{global_baseurl}}"],"query":[{"key":"method","value":"sms.xml"},{"key":"api_key","value":"{{api_key}}"},{"key":"xml","value":"\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\nSMS can be sent using the JSON API by posting values to the preceding URL by the POST method with URL encoded JSON data.
\n
If you wish to send SMS globally, the Base URL is listed below.
\n\n\nhttps://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX
\n
In case of special characters in the content within any of the JSON tags, enclose it within CDATA as in following examples.
\n{\n\"message\": \"test json\",\n\"sender\": \"AAAAAA\",\n\"sms\":[\n{\n\"to\": \"95XXXXXXXX\",\n\"msgid\": \"1\",\n\"message\": \"test sms\",\n\"custom1\": \"11\",\n\"custom2\": \"22\",\n\"sender\": \"AAAAAA\"\n},\n{\n\"to\": \"99XXXXXXXX\",\n\"msgid\": \"2\",\n\"custom1\": \"1\",\n\"custom2\": \"2\" \n}],\n\"unicode\": 1,\n\"flash\": 1,\n\"dlrurl\": \"http://www.example.com/dlr.php\" \n}\n\"message\": \"test json\",\n\"sms\":[\n{\n\"to\": \"95XXXXXXXX\",\n\"msgid\": \"1\",\n\"message\": \"test sms\",\n\"custom1\": \"11\",\n\"custom2\": \"22\",\n\"sender\": \"AAAAAA\" },\n{\n\"to\": \"99XXXXXXXX\",\n\"msgid\": \"2\",\n\"message\": \"json test sms\",\n\"custom1\": \"1\",\n\"custom2\": \"2\"\n}],\n\"unicode\": 1,\n\"flash\": 1,\n\"dlrurl\": \"http://www.example.com/dlr.php\"\n}\nThe API parameter specifications are described in the following sections.
\nIf message, sender and dlrurl is specified within both SMS tag and JSON tag, the former overrides the later.
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"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}"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?method=groups.add&api_key={{api_key}}&app=1&task=save&data[name]=Name of Group","description":"This 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.
\nThe API parameter specifications are described in the following sections.
\nThe Optional parameter in the HTTP API is tabulated below:
\n{\n\"status\": \"ERROR\",\n\"message\": \"Group name already exists.\",\n\"data\": []\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>A401A</status>\n<message>Method Not Implemented</message>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"method","value":"groups.add"},{"key":"api_key","value":"{{api_key}}"},{"key":"app","value":"1"},{"key":"task","value":"save"},{"description":{"content":"Mention the group name
\n","type":"text/plain"},"key":"data[name]","value":"Name of Group"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?method=groups.register&api_key={{api_key}}&number={{phone_number}}&name=Name of Group&action=add&fullname={{name}}&email={{emailid}}","description":"Through this API, you can add contacts to the SMS group you have created.
\nThe API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\n{\n \"status\": \"ERROR\",\n \"code\": \"A424\",\n \"message\": \"Group Name does not exist!\"\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>ERROR</status>\n<code>A424</code>\n<message>Group Name does not exist!</message>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"method","value":"groups.register"},{"key":"api_key","value":"{{api_key}}"},{"key":"number","value":"{{phone_number}}"},{"description":{"content":"Mention the group name.
\n","type":"text/plain"},"key":"name","value":"Name of Group"},{"key":"action","value":"add"},{"key":"fullname","value":"{{name}}"},{"key":"email","value":"{{emailid}}"}],"variable":[]}},"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":"{{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 }]}","description":"Through this API, you can add a single contact or multiple contacts to a group using JSON / XML data.
\n\n\nYou need to create a group in your account to add multiple contacts to an existing valid group before using the API
\n
The API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\n{\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}\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<contacts>\n<number>95xxxxxxxx</number>\n<fullname>xyz</fullname>\n<email>x@email.com</email>\n</contacts>\n<contacts> \n<number>99xxxxxxxx</number>\n<fullname>xyz1</fullname>\n<email>y@email.com</email>\n</contacts>\n</xmlapi>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"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 }]}"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=groups.xml&group_name=Name of Group&action=add&xml=\nThrough this API, you can add a single contact or multiple contacts to a group using JSON / XML data.
\n\n\nYou need to create a group in your account to add multiple contacts to an existing valid group before using the API
\n
The API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\n{\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}\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<xmlapi>\n<contacts>\n<number>95xxxxxxxx</number>\n<fullname>xyz</fullname>\n<email>x@email.com</email>\n</contacts>\n<contacts> \n<number>99xxxxxxxx</number>\n<fullname>xyz1</fullname>\n<email>y@email.com</email>\n</contacts>\n</xmlapi>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"groups.xml"},{"description":{"content":"Mention the group name.
\n","type":"text/plain"},"key":"group_name","value":"Name of Group"},{"key":"action","value":"add"},{"key":"xml","value":"\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
\nIn your account, there must be an existing group and numbers under that group to send any message to a group. \nThe following URL enables you to integrate the URL through which you can send customized messages to the group:
\n\n\nhttps://api-alerts.kaleyra.com/v4/?api_key=Af59xxxxxxxxxx&method=groups&name=MyGroupName&sender=AAAAAA&message=Dear {name}, Your email is {email}
\n
In 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\n\nResponse formats would be same for simple message to a group or a customized one.
\n
If you wish to send SMS globally, the Base URL is listed below.
\n\n\nhttps://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX
\n
The API parameter specifications are described in the following sections.
\n{\n\"status\": \"ERROR\",\n\"code\": \"A421\",\n\"message\": \"Group is empty/Invalid group\"\n}\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"groups"},{"key":"name","value":"GroupName"},{"key":"sender","value":"{{sender_id}}"},{"description":{"content":"Type your message
\n","type":"text/plain"},"key":"message","value":"Welcome to Kaleyra API"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=account.credits","description":"Through 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
\nIn your account, there must be an existing group and numbers under that group to send any message to a group. \nThe following URL enables you to integrate the URL through which you can send customized messages to the group:
\n\n\nhttps://api-alerts.kaleyra.com/v4/?api_key=Af59xxxxxxxxxx&method=groups&name=MyGroupName&sender=AAAAAA&message=Dear {name}, Your email is {email}
\n
In 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\n\nResponse formats would be same for simple message to a group or a customized one.
\n
If you wish to send SMS globally, the Base URL is listed below.
\n\n\nhttps://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX
\n
The API parameter specifications are described in the following sections.
\n{\n\"status\": \"ERROR\",\n\"code\": \"A421\",\n\"message\": \"Group is empty/Invalid group\"\n}\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"account.credits"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method={{credit_usage}}&from=2019-01-01&to=2019-01-30&format=json","description":"Through this API, user will be able to check the credits usage in his/her account.
\n\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\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"{{credit_usage}}"},{"description":{"content":"Past 6 months data will be available
\n
Format is \"YYYY-MM-DD\"
\n","type":"text/plain"},"key":"from","value":"2019-01-01"},{"description":{"content":"Format is \"YYYY-MM-DD\"
\n","type":"text/plain"},"key":"to","value":"2019-01-30"},{"key":"format","value":"json"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=sms.status&id=6XXXX:1","description":"To 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\nIf using POST method for pulling messages status, then statuses for maximum 500 messages can be pulled at a time.
\n
The API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\n{\n\"status\": \"A417\",\n\"message\": \"Invalid Message ID/Mobile. No details found\"\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>A416</status>\n<message>Invalid Message ID/Mobile</message>\n</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.,
\nAPI 1: To trigger this API for global application, follow the API below:
\n\n\n\n
API 2: An optional API is provided with same parameters, listed below:
\n\n\n\n
The only difference between the above mentioned API are the response in the delivery status of the SMS.\n\nIn the API where,\nmethod=hlr, the delivery status is \"DELIVERED\"\n\nwhereas in the API where,\nmethod=lookup, the delivery status is \"AWAITED DLR\"\nThe API parameter specifications are described in the following sections.
\n{\n\"status\":\"A400\",\n\"message\":\"Api Not Implemented\"\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>E608</status>\n<message>No Valid mobile numbers found</message>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}","index.php"],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"lookup"},{"key":"to","value":"{{phone_number}}"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=dip.lookup&to={{phone_number}}&format=json","description":"Through 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.,
\nThe following information can be accessed using this API:
\n\n\n\n\nThis API supports GET/ POST methods.
\n
The API parameter specifications are described in the following sections.
\n{\n\"status\":\"A400\",\n\"message\":\"Api Not Implemented\"\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>E608</status>\n<message>No Valid mobile numbers found</message>\n</api>\nEnter Mobile number
\n","type":"text/plain"},"key":"to","value":"{{phone_number}}"},{"key":"format","value":"json"}],"variable":[]}},"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":"{{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}","description":"Through this API, you'll be able to perform LookUp to access HLR information for single or multiple numbers using XML/JSON data.
\nhttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.json&to=92xxxxxxxx&json=%3A%2F%2Fdomain.net%2F.......\nhttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.xml&to=92xxxxxxxx&xml=%3A%2F%2Fdomain.net%2F.......\nhttp%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\nThe API parameter specifications are described in the following sections.
\nThe Optional parameter in HTTP API is tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"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}"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=lookup.xml&to={{phone_number}}&xml=\nThrough this API, you'll be able to perform LookUp to access HLR information for single or multiple numbers using XML/JSON data.
\nhttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.json&to=92xxxxxxxx&json=%3A%2F%2Fdomain.net%2F.......\nhttps://api-alerts.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX&method=lookup.xml&to=92xxxxxxxx&xml=%3A%2F%2Fdomain.net%2F.......\nhttp%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\nThe API parameter specifications are described in the following sections.
\nThe Optional parameter in HTTP API is tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"lookup.xml"},{"key":"to","value":"{{phone_number}}"},{"key":"xml","value":"\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.
\nThe API parameter specifications are described in the following sections.
\nThe Optional parameters in the HTTP API are tabulated below:
\n{\n\"status\": \"E500\",\n\"message\": \"Please provide url to redirect\"\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>E500</status>\n<message>Please provide url to redirect</message>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"txtly.create"},{"key":"url","value":"txtly_url"},{"description":{"content":"Mention the txtly token.
\n","type":"text/plain"},"key":"token","value":"Yxxxzzxxx"},{"description":{"content":"Mention the txtly title.
\n","type":"text/plain"},"key":"title","value":"ABC"},{"key":"advanced","value":"1"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=txtly&app=1","description":"Through 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.
\nThe API parameter specifications are described in the following sections.
\nThe Optional parameter in the HTTP API is tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"txtly"},{"key":"app","value":"1"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=txtly.logs&id=351xx&app=1","description":"Through 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.
\nThe API parameter specifications are described in the following sections.
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"txtly.logs"},{"description":{"content":"Enter your TXTLY id
\n","type":"text/plain"},"key":"id","value":"351xx"},{"key":"app","value":"1"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=txtly&task=delete&id=351xx&app=1","description":"This 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.
\n\n\nUser must have a Txtly ID to delete the associated Txtly URL from the database.
\n
The API parameter specifications are described in the following sections.
\nThe Optional parameters in the HTTP API are tabulated below:
\n{\n\"status\": \"ERROR\",\n\"message\": \"Id entered not exits with this api user\", \"data\": []\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>ERROR</status>\n<message>Id entered not exits with this api user</message>\n<data></data>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"txtly"},{"key":"task","value":"delete"},{"description":{"content":"Enter your txtly id
\n","type":"text/plain"},"key":"id","value":"351xx"},{"key":"app","value":"1"}],"variable":[]}},"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":"{{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","description":"This 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.
\n\n\nUser must have a Txtly ID to delete the associated Txtly URL from the database.
\n
The API parameter specifications are described in the following sections.
\nThe Optional parameters in the HTTP API are tabulated below:
\n{\n\"status\": \"ERROR\",\n\"message\": \"Id entered not exits with this api user\", \"data\": []\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>ERROR</status>\n<message>Id entered not exits with this api user</message>\n<data></data>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"email"},{"key":"format","value":"JSON"},{"key":"subject","value":"Welcome to Kaleyra API"},{"description":{"content":"To recipient email ID
\n","type":"text/plain"},"key":"to[0][email]","value":"{{emailid}}"},{"key":"to[0][name]","value":"Test API "},{"description":{"content":"From email ID
\n","type":"text/plain"},"key":"from[email]","value":"{{emailid}}"},{"description":{"content":"Your message
\n","type":"text/plain"},"key":"text","value":"Hi \nhow are you today"},{"key":"from[name]","value":"{{name}}"},{"key":"files[]","value":"_logo.png"}],"variable":[]}},"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":"{{global_baseurl}}/{{version}}/?api_key={{api_key}}&method=email&format=xml&subject=Kaleyraemail&to[0][email]={{emailid}}&to[0][name]={{name}}&from[email]={{emailid}}","description":"This 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.
\n\n\nUser must have a Txtly ID to delete the associated Txtly URL from the database.
\n
The API parameter specifications are described in the following sections.
\nThe Optional parameters in the HTTP API are tabulated below:
\n{\n\"status\": \"ERROR\",\n\"message\": \"Id entered not exits with this api user\", \"data\": []\n}\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<api>\n<status>ERROR</status>\n<message>Id entered not exits with this api user</message>\n<data></data>\n</api>\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"email"},{"key":"format","value":"xml"},{"key":"subject","value":"Kaleyraemail"},{"description":{"content":"To recipient email ID
\n","type":"text/plain"},"key":"to[0][email]","value":"{{emailid}}"},{"description":{"content":"Recipient name
\n","type":"text/plain"},"key":"to[0][name]","value":"{{name}}"},{"description":{"content":"From email ID
\n","type":"text/plain"},"key":"from[email]","value":"{{emailid}}"}],"variable":[]}},"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":"{{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","description":"You can send an email with media and attachments through this API.
\nThe API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"email"},{"key":"format","value":"JSON"},{"key":"subject","value":"Welcome to Kaleyra API"},{"description":{"content":"To recipient email ID
\n","type":"text/plain"},"key":"to[0][email]","value":"{{emailid}}"},{"key":"to[0][name]","value":"Test API "},{"description":{"content":"From email ID
\n","type":"text/plain"},"key":"from[email]","value":"{{emailid}}"},{"description":{"content":"Your message
\n","type":"text/plain"},"key":"text","value":"Hi \nhow are you today"},{"key":"from[name]","value":"{{name}}"},{"key":"files[]","value":"_logo.png"}],"variable":[]}},"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":"{{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= ","description":"Through this API, you can apply CSS styles to such HTML content based emails and your outgoing mail will adopt these styles across all recipients.
\nThe API parameter specifications are described in the following sections.
\nThe optional parameters in the HTTP API are tabulated below:
\nThe mandatory parameters in the HTTP API are tabulated below:
\n","urlObject":{"path":["{{version}}",""],"host":["{{global_baseurl}}"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"method","value":"email"},{"key":"format","value":"xml"},{"key":"subject","value":"Kaleyraemail"},{"description":{"content":"To recipient email ID
\n","type":"text/plain"},"key":"to[0][email]","value":"{{email ID}}"},{"key":"to[0][name]","value":"{{name}}"},{"description":{"content":"From email ID
\n","type":"text/plain"},"key":"from[email]","value":"{{emailid}}"},{"key":"from[name]","value":"{{name}}"},{"key":"files[]","value":"_logo.png"},{"description":{"content":"Enter your template ID
\n","type":"text/plain"},"key":"template[id]","value":"zYkNxxxx"},{"key":"html","value":" "}],"variable":[]}},"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\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":"https://api-promo.kaleyra.com/v4/?api_key={{api_key}}&message={{hello}}&sender={{sender_id}}&to={{to}}&method=sms","description":"https://api-global.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX
\n
This is an example page that explains the usage of promo base url.
\n","urlObject":{"protocol":"https","path":["v4",""],"host":["api-promo","kaleyra","com"],"query":[{"key":"api_key","value":"{{api_key}}"},{"key":"message","value":"{{hello}}"},{"key":"sender","value":"{{sender_id}}"},{"key":"to","value":"{{to}}"},{"key":"method","value":"sms"}],"variable":[]}},"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.
\nThe base url to trigger the API is mentioned below:
\n\n\nhttps://api-promo.kaleyra.com/v4/?api_key=Ad9e5XXXXXXXXXXXXX
\n
Note: You can use all SMS API mentioned in the Alerts section with the Promo base url.
\n","_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":[""]}}]}