{"info":{"_postman_id":"0a996405-c5aa-4869-9e8e-2eec92581365","name":"Kaleyra Voice","description":"Kaleyra Voice API facilitates better control on the way you communicate through an API. Dynamically built API enables you to initiate click-to-call, request for number blacklisting, request for call details and create, edit follow ups.\n\n# Voice Documentation\nTo read Voice documentation, click [here](https://voicesupport.kaleyra.com/support/home)\n\n# Base URL\n> https://api-voice.kaleyra.com/v1/\n\n> Error Codes for Voice can be found [here](https://voicesupport.kaleyra.com/support/solutions/articles/3000091787-api-error-codes-for-voice)\n\n> Status codes can be found\n[here](https://voicesupport.kaleyra.com/support/solutions/articles/3000091788-api-operator-status-for-voice)\n\n# Still facing trouble using the API?\nWe have the best support team that works 24*7 providing regional language support in India. You can get in touch with them at support@kaleyra.com and we'll address your concern.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Click-to-Call","id":"c440ac84-d77d-4933-9732-b13d430fa585","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{dial.click-to-call}}","type":"text"},{"key":"format","value":"xml","type":"text","disabled":true},{"key":"caller","value":"{{number}}","type":"text"},{"key":"receiver","value":"{{number}}","type":"text"},{"key":"return","value":"1","type":"text"}]},"url":"{{base_url}}/{{version}}/","description":"Through Click-to-Call, you can connect two users on the call. Let's say the customer can request for a phone call from the company's executive and Kaleyra triggers a bridge call connecting the executive and the customer. You can also bridge the call between the customer and IVR.\n\n> You can choose who the call first connects to and add that number in the \"From\" field. The next connecting call is initiated to the \"To\" number once the \"From\" answers the call.\n\n> Once you use Click-to-Call API, we'll connect the call between the agent and the customer through a bridge number.\n\n# Prerequisites\n1. An active API Key\n2. An Active DID number\n3. Caller and Receiver Number\n\n# API Parameters\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | dial.click2call\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| caller\t| First leg of the call | 10 Digit mobile number\t| True\t|\n| receiver\t| Second leg of the call. | 10 Digit mobile number\t| True\t|\n| format\t| Output response format | Default text. Supports JSON and XML\t| False\t|\n| retry\t| Number of retry to be made if caller(First Leg) doesn't answer the call. Ex Usage:\"&retry=X\"\t| Numeric value, default 0 (max 2)\t| False\t|\n| callback\t| URL that needs to be triggered at first leg answer & at the end of the call, supported with replaceable variables. Ex  Usage:\"&callback=http%3A%2F%2Fcallback%2F%3Fcaller%3D{caller}\"\t| URLencoded API URL \t| False\t|\n| delay\t| Time delay from the API is triggered and call is initiated. Ex Usage: \"&delay=X\"\t| Time in seconds, default 0\t| False\t|\n| return\t| Flag to indicate if Call ID need to be returned on API response. ID is an alphanumeric value with max length 50.Ex Usage: \"&return=X\"\t| Numeric value 1.Default 0\t| False\t|\n| caller_id\t| Phone number to be used as caller ID, can be any number assigned to given account\t| 10 Digit number. Default first active number assigned to the account\t| False\t|\n| meta\t| JSON metadata or additional parameters | Sample JSON\t| False\t|\n| custom | Custom reference ID for call\t| Alpha-numeric ID | False\t|\n\n# Response Data\n| Status | Message |\n|-----|----------|\n| It indicates the success or failure of your request. 200 is success, others are failure | It indicates the success or failure message |\n\n# Callback & Replaceable Variables\nCallback is a functionality to get notified through an API call when a call is answered and completed. One needs to follow below steps to achieve valid callback.\n\n1. Define sample callback API with sample values.\n> https://callback-dot-com/callback/?from=9988xxxx&to=9877xxxx&duration=10&status=ANSWER\n\n2. Carefully find and replace values with respective variables. Note that all the replaced values shall be in URL encoded format only\n> https://callback-dot-com/callback/?from={caller}&to={receiver}&duration={duration}&status={status1}\n\n3. Append callback value with Click2Call API.\n> &callback=http%3A%2F%2Fcallback-dot-com%2Fcallback%2F%3Ffrom%3D%7Bcaller%7D%26to%3D%7Breceiver%7D%26duration%3D%7Bduration%7D%26status%3D%7Bstatus1%7D\n\n# List of variables supported over callback API\nThe following are the variables that are supported over a callback API.\n\n| Parameter | Description |\n|-----------|------------|\n| {caller} | Caller (first leg) number |\n| {receiver} | Receiver (second leg) number |\n| {starttime} | Call start time EPOCH format |\n| {endtime} | Call end time EPOCH format |\n| {duration} | Call duration in seconds for caller (first leg) |\n| {billsec} | Call duration in seconds for receiver (second leg) |\n| {status} | Consolidate status for C2C outcome |\n| {status1} | Call status for caller (first leg) |\n| {status2} | Call status for receiver (second leg) |\n| {recordpath} | Recording file URL |\n| {callerid} | Caller ID used to dial |"},"response":[{"id":"3463b418-3ab9-4472-be69-6896454fd82f","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{dial.click-to-call}}","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"caller","value":"{{caller}}","type":"text"},{"key":"receiver","value":"{{receiver}}","type":"text"},{"key":"return","value":"1","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"status\":\"200\",\r\n  \"message\":\"OK\",\r\n  \"data\":{\r\n    \"id\":\"c2c_5a7d85903dd7xxxx\"\r\n  }\r\n}"},{"id":"51e2abde-0c01-4e4c-8b0a-e51ef2cd6b3c","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{dial.click-to-call}}","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"caller","value":"{{caller}}","type":"text"},{"key":"receiver","value":"{{receiver}}","type":"text"},{"key":"return","value":"1","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n \t<status>200</status> \r\n \t<message>OK</message> \r\n    <data> \r\n        <id> c2c_57XXXXXXXXXXXX</id> \r\n    </data> \r\n</api>"}],"_postman_id":"c440ac84-d77d-4933-9732-b13d430fa585"},{"name":"Click-to-Call Status","id":"95eb3949-488c-4796-82c8-af934ece41dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api_key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{click-to-call}}","type":"text"},{"key":"format","value":"xml","type":"text","disabled":true},{"key":"id","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/","description":"# What can you do with this API?\nThrough this API, you will be able to request for the list of calls that have been connected through your account. \n\n> Last 3 days call logs only will be accessible \n\n\n\n# Prerequisites\n1. An active API Key\n2. Active Kaleyra Voice account\n\n\n# API Parameters\nThe mandatory parameters are needed to use the API. If they are not configured API can not be submitted. Optional parameters may or may not be configured for the API to work.\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | dial.c2cstatus\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON and XML | False\t|\n| fromdate | Results starting from this date | Format: YYYY/MM/DD OR DD/MM/YYYY | False\t|\n| todate | Results up to this date | Format: YYYY/MM/DD OR DD/MM/YYYY | False\t|\n| call to | Called to number | 10-digit mobile number | False\t|\n| limit | Number of result per request | Numeric. Default 50 | False\t|\n| page | Page number from where you want the results | Numeric. Default 1 | False\t|\n| id | Call ID to get specific call data | Valid call ID issued by API | False\t|\n\n# Response Data\n| Response | Description |\n|------------|-----------|\n| status | It indicates the success or failure of your API request. 200 is success, others are failure |\n| message | It indicates the success or failure message |\n| data | All the response is wrapped inside data |\n| dial | Each call’s data is wrapped in dial tag |\n| callfrom | Calling number |\n| callto | Recipient number |\n| billsec | Duration of call for recipient |\n| notes | Notes if any made for the call |\n| provider | Mobile number service provider |\n| location | The location of the caller mobile |\n| credits | Credits charged for the call |\n| uniqid | This is the unique id to each call |\n| duration | Duration of call for caller |\n| date | Date time when the call was initiated |\n| status | Call status for Caller (first leg) |\n| status2 | Call status for Receiver (second leg) |\n\n# Expected Call Status values\n| Status (first leg) | Status2 (second leg) |\n|------------|------------|\n| ANSWER | ANSWER |\n| BUSY | BUSY |\n| CANCEL | CANCEL |\n| FAILED | FAILED |\n| CONGESTION | CONGESTION |\n| NOANSWER | NOANSWER |"},"response":[{"id":"a75546de-b435-484d-8839-1e766cd12579","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{click-to-call}}","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"id","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"200\",\n    \"message\": \"OK\",\n    \"data\": [\n        {\n            \"id\": \"c2c_57XXXXXXXXXX\",\n            \"callfrom\": \"95XXXXXXXX\",\n            \"callto\": \"99XXXXXXXX\",\n            \"agent\": \"agent name\",\n            \"start_time\": \"2015-12-15 11:59:01\",\n            \"end_time\": \"2015-12-15 11:59:59\",\n            \"duration\": \"36\",\n            \"billsec\": \"28\",\n            \"credits\": \"1.200\",\n            \"status\": \"ANSWER\",\n            \"status2\": \"ANSWER\",\n            \"recording\": \"//play.solutionsinfini.com/?id=94XXXXXX\",\n            \"location\": \"KARNATAKA\",\n            \"provider\": \"VODAFONE\"\n        }\n    ]\n}"},{"id":"d17ff188-d0a1-4a48-89d5-c70289fb8793","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{click-to-call}}","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"id","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>200</status>\r\n    <message>OK</message>\r\n    <data>\r\n        <dial>\r\n            <id>c2c_57XXXXXXXXXX</id>\r\n            <callfrom>95XXXXXXXX</callfrom>\r\n            <callto>99XXXXXXXX</callto>\r\n            <agent>agent name</agent>\r\n            <start_time>2015-12-15 11:59:01</start_time>\r\n            <end_time>2015-12-15 11:59:59</end_time>\r\n            <duration>36</duration>\r\n            <billsec>28</billsec>\r\n            <credits>1.200</credits>\r\n            <status>ANSWER</status>\r\n            <status2>ANSWER</status2>\r\n            <recording>//play.solutionsinfini.com/?id=94XXXXXX</recording>\r\n            <location>KARNATAKA</location>\r\n            <provider>VODAFONE</provider>\r\n        </dial>\r\n    </data>\r\n</api>"}],"_postman_id":"95eb3949-488c-4796-82c8-af934ece41dd"},{"name":"Get Call Details","id":"70bdbff7-a0c6-436f-8d85-01206f6a05f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{dial}}","type":"text"}]},"url":"{{base_url}}/{{version}}/","description":"# What can you do with this API?\nThrough this API, you can get the details of the call including dial time.\n\n> This API will only provide the details of the incoming calls which are forwarded to agent numbers.\n\n\n# Prerequisites\n1. Active Kaleyra Voice account\n2. Active API key\n\n# API Parameters\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | dial\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON and XML | False\t|\n| fromdate | Results starting from this date | Format: YYYY/MM/DD OR DD/MM/YYYY | False\t|\n| todate | Results up to this date | Format: YYYY/MM/DD OR DD/MM/YYYY | False\t|\n| call to | Called to number | 10-digit mobile number | False\t|\n| limit | Number of result per request | Numeric. Default 50 | False\t|\n| page | Page number from where you want the results | Numeric. Default 1 | False\t|\n| id | Call ID to get specific call data | Valid call ID issued by API | False\t|\n\n# Response Data\n| Response | Description |\n|------------|-----------|\n| status | It indicates the success or failure of your API request. 200 is success, others are failure |\n| message | It indicates the success or failure message |\n| data | All the response is wrapped inside data |\n| dial | Each call’s data is wrapped in dial tag |\n| id | Unique Record id |\n| parentid | Parent id for the call |\n| callfrom | Calling number |\n| callto | Recipient number |\n| billsec | Duration of call for recipient |\n| starttime | Call start time |\n| endtime | Call end time |\n| duration | Duration of call for caller |\n| notes | Notes if any made for the call |\n| provider | Mobile number service provider |\n| location | The location of the caller mobile |\n| credits | Credits charged for the call |\n| uniqid | This is the unique id to each call |\n| duration | Duration of call for caller |\n| date | Date time when the call was initiated |\n| status | Call status for Caller (first leg) |\n| status2 | Call status for Receiver (second leg) |\n| recording | Recording URL |"},"response":[{"id":"21d1f121-c053-42a3-8fe5-bf31d1529534","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{dial}}","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"id","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \r\n  \"status\": \"200\", \r\n  \"message\": \"OK\", \r\n  \"data\": [ \r\n \t{ \r\n  \t \"id\": \"1838350XXXXXX502e7729b\",\r\n      \"uniqid\": \"153XXXXXX4.26.D0\",\r\n      \"parent_id\": \"XXXXXX20215ba50XXXc542\",\r\n      \"callfrom\": \"95XXXXXXXX\",\r\n      \"callto\": \"99XXXXXXXX\",\r\n      \"start_time\": \"2018-09-21 03:40:19\",\r\n      \"end_time\": \"2018-09-21 03:40:49\",\r\n      \"duration\": \"30\",\r\n      \"billsec\": \"28\",\r\n      \"notes\": \"hello\",\r\n      \"location\": \"KARNATAKA\",\r\n      \"provider\": \"VODAFONE\",\r\n      \"credits\": \"1.200\",\r\n      \"status\": \"ANSWER\",\r\n      \"recording\": \"//play.abc.co/?id=123\",\r\n      \"date\": \"2018-09-21 03:40 AM\",\r\n      \"caller_id\": \"80XXXXXXXX\"\r\n \t}\r\n  ]\r\n}"},{"id":"814ac8ab-428f-4523-8f36-d70a33b5e571","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{dial}}","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"id","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?> \r\n<api> \r\n \t<status>200</status> \r\n \t<message>OK</message> \r\n \t<data> \r\n     \t<dial> \r\n      \t  <id>183XXXXXX05ba502e7729b</id> \r\n          <uniqid>14501XXXXX.953950</uniqid> \r\n          <parent_id>20519XXXXXXXX502e2c542</parent_id> \r\n         \t<callfrom>95XXXXXXXX</callfrom> \r\n \t        <callto>99XXXXXXXX</callto> \r\n          <start_time>2018-09-21 03:40:19</start_time>\r\n          <end_time>2018-09-21 03:40:49</end_time>\r\n          <duration>36</duration>\r\n         \t<billsec>28</billsec> \r\n         \t<notes>hello</notes> \r\n         \t<location>KARNATAKA</location> \r\n         \t<provider>VODAFONE</provider> \r\n         \t<credits>1.200</credits>         <status>ANSWER</status> \r\n          <recording>//play.abc.co/?id=123</recording>\r\n      \t<date>2015-12-15 11:59 AM</date> \r\n        <caller_id>80XXXXXXXX</caller_id> \r\n     \t</dial>\r\n  </data>\r\n</api>"}],"_postman_id":"70bdbff7-a0c6-436f-8d85-01206f6a05f5"},{"name":"Blacklist a Number","id":"05e401c7-2656-4c4e-9068-43c0bba83dca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{block}}","type":"text"},{"key":"number","value":"{{number}}","type":"text"},{"key":"format","value":"xml","type":"text","disabled":true}]},"url":"{{base_url}}/{{version}}/","description":"# What can you do with this API?\nWith this API, you can blacklist a number from an account. Businesses often need to blacklist numbers that consume redundant time in execution of the process. This API helps you achieve the same by blacklisting a single number or pool of numbers.\n> To blacklist multiple numbers, you can add multiple numbers separated by a comma (,).\n\n\n# Prerequisites\n1. Active Kaleyra Voice account\n2. Active API key\n3. Phone number(s) that needs to be blacklisted\n\n# API Parameters\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | block\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON and XML | False |\n| number | Mobile number that needs to be blacklisted | 10 digit mobile number | True |\n\n# Response Data\n| Status | Message |\n|-----|----------|\n| It indicates the success or failure of your request. 200 is success, others are failure | It indicates the success or failure message |"},"response":[{"id":"b1424b14-30b0-42f2-9aad-9c4b39fef11c","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{block}}","type":"text"},{"key":"number","value":"{{number}}","type":"text"},{"key":"format","value":"json","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \r\n  \"status\": \"200\", \r\n  \"message\": \"OK\"\r\n}"},{"id":"6ceb59ff-2e51-44e6-a35f-0d1bf317248c","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{block}}","type":"text"},{"key":"number","value":"{{number}}","type":"text"},{"key":"format","value":"xml","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?> \r\n<api> \r\n \t<status>200</status> \r\n \t<message>OK</message> \r\n</api>"}],"_postman_id":"05e401c7-2656-4c4e-9068-43c0bba83dca"},{"name":"Undo Number Blacklist","id":"991290ff-d2f8-41aa-9802-f4e7f8229242","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{block}}","type":"text"},{"key":"number","value":"{{number}}","type":"text"},{"key":"format","value":"xml","type":"text","disabled":true},{"key":"action","value":"delete","type":"text"}]},"url":"{{base_url}}/{{version}}/","description":"# What can you do with this API?\nThrough this API, you can remove any number/ group from the blacklisted category. Once you do this, the number can call you or reach you out as usual.\n\n# Prerequisites\n1. Active Kaleyra Voice account\n2. Active API key\n3. Phone number(s) that needs to be removed from blacklist\n\n# API Parameters\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | block\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON and XML | False |\n| number | Mobile number that needs to be blacklisted | 10 digit mobile number | True |\n| action | To be used in order to remove a blacklisted number. Ex Usage: \"&action=delete\" | delete | True |\n\n# Response Data\n| Status | Message |\n|-----|----------|\n| It indicates the success or failure of your request. 200 is success, others are failure | It indicates the success or failure message |\n| message | It indicates the success or failure message |"},"response":[{"id":"0642320b-3770-4578-bbde-24974735eda3","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{block}}","type":"text"},{"key":"number","value":"{{number}}","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"action","value":"delete","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?> \r\n<api> \r\n \t<status>200</status> \r\n \t<message>OK</message> \r\n</api>"},{"id":"b3886f74-ef88-4845-9325-ef324c83e916","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{block}}","type":"text"},{"key":"number","value":"{{number}}","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"action","value":"delete","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \r\n  \"status\": \"200\", \r\n  \"message\": \"OK\"\r\n}"}],"_postman_id":"991290ff-d2f8-41aa-9802-f4e7f8229242"},{"name":"Create Call Follow Up","id":"7e48de58-4f7c-406c-a786-be9dfdf19290","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{followup}}","type":"text"},{"key":"phone","value":"{{number}}","type":"text"},{"key":"name","value":"{{name}}","type":"text"},{"key":"format","value":"xml","type":"text","disabled":true},{"key":"follower","value":"{{number}}","type":"text"},{"key":"ontime","value":"{{time}}","type":"text"},{"key":"autocall","value":"1","type":"text"}]},"url":"{{base_url}}/{{version}}/","description":"# What can you do with this API?\nThrough this API, you can create call follow up that reminds you to create an auto call with the customer on the due date. Let's say Agent has to follow up with the customer next month on the same date, all he has to do is use this API to auto generate a call. Once API is created, an auto call is generated to the customer's number on the due date.\n\n# Prerequisites\n1. An active Kaleyra Voice Account\n2. An active API Key\n3. Date and Time of the Follow Up call\n4. Phone Number to be dialed on the day of follow up\n5. Name of the phone receiver (customer)\n\n# API Parameters\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | followup\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format\t| Output response format | Default text. Supports JSON and XML\t| False\t|\n| phone\t| Follow up phone number | 10 digit mobile number\t| True\t|\n| name\t| Follow up name | Follow up name, url encoded\t| True\t|\n| follower\t| Follower phone number | 10 digit mobile number | True\t|\n| ontime\t| Date and time when the follow up is scheduled | dd-mm-yyyy hh-mm\t| True\t|\n| autocall | Initiates a follow up call between follower and follow-up phone number at the ontime mentioned | 1 - Initiates an autocall. 0 - No call is initiated. Default- 0 | False\t|\n| notes | Important Notes corresponding to the followup call | Text, url encoded | False\t|\n\n# Response Data\n| Response | Description |\n|------------|-----------|\n| status | It indicates the success or failure of your API request. 200 is success, others are failure |\n| message | It indicates the success or failure message |\n| data | All the response is wrapped inside data tag |\n| id | Follow up ID, can be used for modification |"},"response":[{"id":"2538835a-27fa-48d1-bc31-952253bc3af5","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{followup}}","type":"text"},{"key":"phone","value":"{{number}}","type":"text"},{"key":"name","value":"{{name}}","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"follower","value":"{{number}}","type":"text"},{"key":"ontime","value":"{{time}}","type":"text"},{"key":"autocall","value":"1","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?> \r\n<api>\r\n  <status>200</status>\r\n  <message>OK</message>\r\n  <data>\r\n    <id>2351</id>\r\n  </data>\r\n</api>"},{"id":"c4551014-58f0-4911-98c0-6b83e1bfafb3","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{followup}}","type":"text"},{"key":"phone","value":"{{number}}","type":"text"},{"key":"name","value":"{{name}}","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"follower","value":"{{number}}","type":"text"},{"key":"ontime","value":"{{time}}","type":"text"},{"key":"autocall","value":"1","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \r\n  \"status\": \"200\", \r\n  \"message\": \"OK\", \r\n  \"data\": {\r\n    \"id\": \"2354\"\r\n  }\r\n}"}],"_postman_id":"7e48de58-4f7c-406c-a786-be9dfdf19290"},{"name":"Edit a Call Follow Up","id":"482eb98c-772b-4230-b235-ac3143f2febc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{followup}}","type":"text"},{"key":"phone","value":"{{number}}","type":"text"},{"key":"name","value":"{{name}}","type":"text"},{"key":"format","value":"xml","type":"text","disabled":true},{"key":"follower","value":"{{number}}","type":"text"},{"key":"ontime","value":"{{time}}","type":"text"},{"key":"autocall","value":"1","type":"text"},{"key":"id","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/","description":"# What can you do with this API?\nOnce the Follow Up auto call is created, you can edit it at any point of time through this API.\n\n# Prerequisites\n1. An active Voice Account\n2. The Follow Up ID of the call that needs to be edited\n3. Date and time of the call\n4. Phone number and Name of the user to whom the auto call is to be initiated\n5. API Key\n\n# API Parameters\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | followup\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format\t| Output response format | Default text. Supports JSON and XML\t| False\t|\n| phone\t| Follow up phone number | 10 digit mobile number\t| True\t|\n| name\t| Follow up name | Follow up name, url encoded\t| True\t|\n| follower\t| Follower phone number | 10 digit mobile number | True\t|\n| id | Follow-up ID which has to be edited | Valid followup ID | True |\n| action | To be used to delete the followup record. Ex usage: \"&action=delete\" | delete | True |\n| ontime\t| Date and time when the follow up is scheduled | dd-mm-yyyy hh-mm\t| True\t|\n| autocall | Initiates a follow up call between follower and follow-up phone number at the ontime mentioned | 1 - Initiates an autocall. 0 - No call is initiated. Default- 0 | False\t|\n| notes | Important Notes corresponding to the followup call | Text, url encoded | False\t|\n\n\n# Response Data\n| Response | Description |\n|------------|-----------|\n| status | It indicates the success or failure of your API request. 200 is success, others are failure |\n| message | It indicates the success or failure message |\n| data | All the response is wrapped inside data tag |\n| id | Follow up ID, can be used for modification |\n\n# Mandatory Parameters"},"response":[{"id":"07dfbb70-cbea-48a9-8300-0c05d25ac610","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{followup}}","type":"text"},{"key":"phone","value":"{{number}}","type":"text"},{"key":"name","value":"{{name}}","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"follower","value":"{{number}}","type":"text"},{"key":"ontime","value":"{{time}}","type":"text"},{"key":"autocall","value":"1","type":"text"},{"key":"id","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \r\n \"status\": \"200\", \r\n \"message\": \"Follow-up updated successfully\", \r\n \"data\": { \r\n \t\"id\": \"2360\" \r\n }\r\n}"},{"id":"360035de-8114-4a3e-bc41-9aabf3efc2d7","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{followup}}","type":"text"},{"key":"phone","value":"{{number}}","type":"text"},{"key":"name","value":"{{name}}","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"follower","value":"{{number}}","type":"text"},{"key":"ontime","value":"{{time}}","type":"text"},{"key":"autocall","value":"1","type":"text"},{"key":"id","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?> \r\n<api> \r\n \t<status>200</status> \r\n \t<message>Follow-up updated successfully</message> \r\n \t<data> \r\n     \t<id>2360</id> \r\n \t</data> \r\n</api>"}],"_postman_id":"482eb98c-772b-4230-b235-ac3143f2febc"},{"name":"Get Call Follow Up Report","id":"fdb24df2-9fe6-4e4c-8a26-a12346cadc10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{followup.reports}}","type":"text"},{"key":"format","value":"json","type":"text","disabled":true}]},"url":"{{base_url}}/{{version}}/","description":"# What can you do with this API?\nThrough this API, you can get a consolidated report of the Follow Up calls that have been connected through the account.\n\n> This API is valid only if the user has a call follow up created before\n\n\n# Prerequisites\n1. An active Voice Account\n2. API Key\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | followup.reports\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format\t| Output response format | Default text. Supports JSON and XML\t| False\t|\n| follower | Follower number to filter | Numeric 10 digit | False\t|\n| number | Follow-up number to filter | Numeric 10 digit | False\t|\n| fromdate | Results starting from this date | Format: YYYY/MM/DD OR DD/MM/YYYY | False\t|\n| todate | Results up to this date | Format: YYYY/MM/DD OR DD/MM/YYYY | False\t|\n\n# Response Data\n| Response | Description |\n|------------|-----------|\n| status | It indicates the success or failure of your API request. 200 is success, others are failure |\n| message | It indicates the success or failure message |\n| data | All the response is wrapped inside data tag |\n| followup | Each follow up data is contained in follow up tag |\n| id | Followup id |\n| Phone | Followup phone number |\n| name | Follow-up name |\n| follower | Follower number |\n| note | Notes corresponding to followup |\n| ontime | Time when the follow up is scheduled |"},"response":[{"id":"9f04ae07-3bee-4d9e-ac9c-e772fb199d49","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{followup.reports}}","type":"text"},{"key":"format","value":"json","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{ \r\n  \"status\": \"200\", \r\n  \"message\": \"OK\", \r\n  \"data\": [ \r\n \t{ \r\n   \t\"id\": \"1864\", \r\n   \t\"phone\": \"87XXXXXXXX\", \r\n   \t\"name\": \"John\", \r\n   \t\"follower\": \"97XXXXXXXX\", \r\n   \t\"note\": \"test call\", \r\n   \t\"ontime\": \"14-10-2015 07:00:00 PM\" \r\n \t} \r\n] \r\n}"},{"id":"f6b07ccb-075f-47b8-ad56-4c15b2c5ea14","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{followup.reports}}","type":"text"},{"key":"format","value":"xml","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?> \r\n<api>\r\n  <status>200</status> \r\n \t<message>OK</message> \r\n \t<data> \r\n     \t<followup> \r\n         \t<id>1864</id> \r\n         \t<phone>87XXXXXXXX</phone>\r\n          <name>John</name> \r\n         \t<follower>88XXXXXXXX</follower> \r\n         \t<note>test call</note> \r\n         \t<ontime>14-10-2015 07:00:00 PM</ontime> \r\n     \t</followup> \r\n \t</data> \r\n</api>"}],"_postman_id":"fdb24df2-9fe6-4e4c-8a26-a12346cadc10"},{"name":"Health status API","id":"ed9cf02f-c30f-44fd-971e-0c646c6e154d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{monitor}}","type":"text"},{"key":"format","value":"xml","type":"text","disabled":true}]},"url":"{{base_url}}/{{version}}/","description":"# What can you do with this API?\nThrough this API, you can get a consolidated report of the health status of incidents from the network servers.\n\n# Prerequisites\n1. An active Voice Account\n2. API Key\n\n# API Parameters\nThe mandatory parameters are needed to use the API. If they are not configured API can not be submitted. Optional parameters may or may not be configured for the API to work.\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | monitor\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON and XML | False\t|\n\n\n# Description Fields\n| Parameter | Description |\n|------------|-----------|\n| status | It indicates the success or failure of your API request. 200 is success, others are failure |\n| message | It indicates the success or failure message |\n| data | Data array contain all the incidents |\n| incidents | Region wise incident listing |\n| region | Server region |\n| region-code | Region codes, for example KA-IN for Karnataka-India |\n| type | Status of the server (Operational, Warning or Critical) |\n| service | It can be incoming, outgoing or all |\n| numbers | User subscribed number(s) |\n\n\n# Response Codes\n| Response | Description | Example Response |\n|------------|-----------|----------- |\n| E542 | Plugin not subscribed for user | User Plugin not found or inactive |\n| E701 | If Incidents not present |No incidents found |\n| 200 |For valid response with data |Message : OK |\n\n> For generic error codes, refer to this page: \nhttps://developers.kaleyra.com/docs/api-error-codes-for-voice"},"response":[{"id":"2f4dd9b0-4a52-42d9-86f0-3afffa2175a8","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{monitor}}","type":"text"},{"key":"format","value":"xml","type":"text"}]},"url":"{{url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"Xml:\r\n<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>200</status>\r\n    <message>OK</message>\r\n    <data>\r\n        <incidents>\r\n            <monitor>\r\n                <region>New Delhi</region>\r\n                <region_code>ND-IN</region_code>\r\n                <type>operational</type>\r\n                <service>all</service>\r\n                <numbers>\r\n                    <monitor>+9111xxxxxx05</monitor>\r\n                </numbers>\r\n            </monitor>\r\n            <monitor>\r\n                <region>Karnataka</region>\r\n                <region_code>KA-IN</region_code>\r\n                <type>operational</type>\r\n                <service>all</service>\r\n                <numbers>\r\n                    <monitor>+9180xxxxxx28</monitor>\r\n                </numbers>\r\n            </monitor>\r\n            <monitor>\r\n                <region>Karnataka</region>\r\n                <region_code>KA-IN</region_code>\r\n                <type>operational</type>\r\n                <service>all</service>\r\n                <numbers>\r\n                    <monitor>+9180xxxxxx56</monitor>\r\n                    <monitor>+9180xxxxxx58</monitor>\r\n                </numbers>\r\n            </monitor>\r\n            <monitor>\r\n                <region>UP-West</region>\r\n                <region_code>UP-IN</region_code>\r\n                <type>operational</type>\r\n                <service>all</service>\r\n                <numbers>\r\n                    <monitor>+9112xxxxxx03</monitor>\r\n                </numbers>\r\n            </monitor>\r\n            <monitor>\r\n                <region>New Delhi</region>\r\n                <region_code>ND-IN</region_code>\r\n                <type>operational</type>\r\n                <service>all</service>\r\n                <numbers>\r\n                    <monitor>+911xxxxxx38</monitor>\r\n                </numbers>\r\n            </monitor>\r\n            <monitor>\r\n                <region>Karnataka</region>\r\n                <region_code>KA-IN</region_code>\r\n                <type>operational</type>\r\n                <service>all</service>\r\n                <numbers>\r\n                    <monitor>+9180xxxxxx89</monitor>\r\n                </numbers>\r\n            </monitor>\r\n            <monitor>\r\n                <region>Haryana</region>\r\n                <region_code>HR-IN</region_code>\r\n                <type>operational</type>\r\n                <service>all</service>\r\n                <numbers>\r\n                    <monitor>+9112xxxxxx10</monitor>\r\n                </numbers>\r\n            </monitor>\r\n            <monitor>\r\n                <region>Tamilnadu</region>\r\n                <region_code>TN-IN</region_code>\r\n                <type>operational</type>\r\n                <service>all</service>\r\n                <numbers>\r\n                    <monitor>+9144xxxxxx26</monitor>\r\n                </numbers>\r\n            </monitor>\r\n        </incidents>\r\n    </data>\r\n</api>\r\n"},{"id":"ad89c678-9879-43d8-8bbf-00c8f50b722a","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{monitor}}","type":"text"},{"key":"format","value":"json","type":"text"}]},"url":"{{url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"200\",\r\n    \"message\": \"OK\",\r\n    \"data\": {\r\n        \"incidents\": [\r\n            {\r\n                \"region\": \"New Delhi\",\r\n                \"region_code\": \"ND-IN\",\r\n                \"type\": \"operational\",\r\n                \"service\": \"all\",\r\n                \"numbers\": [\r\n                    \"+9111xxxxxx05\"\r\n                ]\r\n            },\r\n            {\r\n                \"region\": \"Karnataka\",\r\n                \"region_code\": \"KA-IN\",\r\n                \"type\": \"operational\",\r\n                \"service\": \"all\",\r\n                \"numbers\": [\r\n                    \"+9180xxxxxx28\",\r\n                    \"+9180xxxxxx95\"\r\n                ]\r\n            },\r\n            {\r\n                \"region\": \"Karnataka\",\r\n                \"region_code\": \"KA-IN\",\r\n                \"type\": \"operational\",\r\n                \"service\": \"all\",\r\n                \"numbers\": [\r\n                    \"+9180xxxxxx56\",\r\n                    \"+9180xxxxxx58\"\r\n                ]\r\n            },\r\n            {\r\n                \"region\": \"UP-West\",\r\n                \"region_code\": \"UP-IN\",\r\n                \"type\": \"operational\",\r\n                \"service\": \"all\",\r\n                \"numbers\": [\r\n                    \"+9112xxxxxx03\"\r\n                ]\r\n            },\r\n            {\r\n                \"region\": \"New Delhi\",\r\n                \"region_code\": \"ND-IN\",\r\n                \"type\": \"operational\",\r\n                \"service\": \"all\",\r\n                \"numbers\": [\r\n                    \"+9111xxxxxx38\"\r\n                ]\r\n            },\r\n            {\r\n                \"region\": \"Karnataka\",\r\n                \"region_code\": \"KA-IN\",\r\n                \"type\": \"operational\",\r\n                \"service\": \"all\",\r\n                \"numbers\": [\r\n                    \"+9180xxxxxx89\"\r\n                ]\r\n            },\r\n            {\r\n                \"region\": \"Haryana\",\r\n                \"region_code\": \"HR-IN\",\r\n                \"type\": \"operational\",\r\n                \"service\": \"all\",\r\n                \"numbers\": [\r\n                    \"+9112xxxxxx10\"\r\n                ]\r\n            },\r\n            {\r\n                \"region\": \"Tamilnadu\",\r\n                \"region_code\": \"TN-IN\",\r\n                \"type\": \"operational\",\r\n                \"service\": \"all\",\r\n                \"numbers\": [\r\n                    \"+9144xxxxxx26\"\r\n                ]\r\n            }\r\n        ]\r\n    }\r\n}\r\n"}],"_postman_id":"ed9cf02f-c30f-44fd-971e-0c646c6e154d"},{"name":"Progressive dialer upload API","id":"e7a7fd1d-57ac-4c06-b71b-6fc14eba6ade","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{autodial.add}}","type":"text"},{"key":"number","value":"{{number}}","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"name","value":"unique_name","type":"text"},{"key":"meta","value":"{\"profile\":\"custom1\"}","type":"text"}]},"url":"{{base_url}}/{{version}}/","description":"# What can you do with this API?\nWith this API, you can add numbers to progressive dialer campaign.\n\n# Prerequisites\n1. Active Kaleyra Voice account\n2. Active API key\n3. Phone number that needs to be uploaded\n\n# API Parameters\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | autodial.add\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON and XML | False |\n| name | Unique name identified for given campaign | Alphanumeric | True |\n| number | Mobile number | 10 digit mobile number | True |\n| meta | Json object of extra informations | {\"customname\":\"customvalue\"} | True |\n\n# Response Data\n| Status | Message |\n|-----|----------|\n| It indicates the success or failure of your request. 200 is success, others are failure | It indicates the success or failure message |"},"response":[{"id":"ab83903a-22e1-4339-ba42-e77c8a005afd","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{autodial.add}}","type":"text"},{"key":"number","value":"{{number}}","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"name","value":"unique_name","type":"text"},{"key":"meta","value":"{\"profile\":\"custom1\"}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"\r\n{\r\n    \"status\": \"OK \",\r\n    \"message\": \"Number(s) added Successfully, Total Records(s) - 1, Processed Records(s) - 1\"\r\n}"},{"id":"1e9d1361-87a9-4d93-b195-8a251f96f1ab","name":"XML","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{autodial.add}}","type":"text"},{"key":"number","value":"{{number}}","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"name","value":"unique_name","type":"text"},{"key":"meta","value":"{\"profile\":\"custom1\"}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n     <status>OK </status>\r\n     <message>Number(s) added Successfully, Total Records(s) - 1, Processed Records(s) - 1</message>\r\n</api>"}],"_postman_id":"e7a7fd1d-57ac-4c06-b71b-6fc14eba6ade"},{"name":"Progressive dialer Bulk upload API","id":"2b7e64ac-e9ff-4bd1-baa5-d6c2cf7314ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"data\": [\r\n        {\r\n            \"number\": \"97xxxxxxxx\",\r\n            \"customname\": \"customvalue\"\r\n        },\r\n        {\r\n            \"number\": \"80xxxxxxxx\",\r\n            \"customname\": \"customvalue\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/{{version}}/?method={{autodial.import}}&name={{Uniquename}}&format=json","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"method","value":"{{autodial.import}}"},{"key":"name","value":"{{Uniquename}}"},{"key":"format","value":"json"}]},"description":"# What can you do with this API?\nWith this API, you can add bulk numbers to progressive dialer campaign.\n\n# Prerequisites\n1. Active Kaleyra Voice account\n2. Active API key\n3. Phone number(s) that needs to be uploaded\n\n# API Parameters\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | autodial.add\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON and XML | False |\n| name | Unique name identified for given campaign | Alphanumeric | True |\n\n# Payload Parameters\n\nPayload must be JSON object containing array of elements, published using POST method only.\n\nLimited to 1000 entries per API request. In case more than defined number received over API, only first 1000 entries shall be considered.\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| number | Mobile number | 10 digit mobile number | True |\n| customname | Custom parameter with value like name, amount, etc | {\"customname\":\"customvalue\"} | True |\n\n\n# Response Data\n| Status | Message |\n|-----|----------|\n| It indicates the success or failure of your request. 200 is success, others are failure | It indicates the success or failure message |"},"response":[{"id":"3c9a68b2-2717-4ff2-b197-b6446ebcb3bd","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"data\": [\r\n        {\r\n            \"number\": \"97xxxxxxxx\",\r\n            \"customname\": \"customvalue\"\r\n        },\r\n        {\r\n            \"number\": \"80xxxxxxxx\",\r\n            \"customname\": \"customvalue\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/{{version}}/?method={{autodial.import}}&name={{Uniquename}}&format=json","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"method","value":"{{autodial.import}}"},{"key":"name","value":"{{Uniquename}}"},{"key":"format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"\r\n{\r\n    \"status\": \"OK \",\r\n    \"message\": \"Number(s) added Successfully, Total Records(s) - 2, Processed Records(s) - 2\"\r\n}"},{"id":"b9f1bc72-86d7-469c-88f5-03bb1a8be48b","name":"XML","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"data\": [\r\n        {\r\n            \"number\": \"97xxxxxxxx\",\r\n            \"customname\": \"customvalue\"\r\n        },\r\n        {\r\n            \"number\": \"80xxxxxxxx\",\r\n            \"customname\": \"customvalue\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/{{version}}/?method={{autodial.import}}&name={{Uniquename}}&format=xml","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"method","value":"{{autodial.import}}"},{"key":"name","value":"{{Uniquename}}"},{"key":"format","value":"xml"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n     <status>OK </status>\r\n     <message>Number(s) added Successfully, Total Records(s) - 2, Processed Records(s) - 2</message>\r\n</api>"}],"_postman_id":"2b7e64ac-e9ff-4bd1-baa5-d6c2cf7314ab"},{"name":"Start OBD Call","id":"01f87c33-b80b-42b7-8357-9366398b1000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{voice.call}}","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"numbers","value":"{{phone_number}}","type":"text"},{"key":"play","value":"{{soundfile}}","type":"text"}]},"url":"{{base_url}}/{{version}}/","description":"# What can do with this API?\nThrough this API, you can initiate an outbound call to a single number, multiple numbers or already created groups.\n# Prerequisites\n1. An API Key\n2. Numbers to who the call has to be initiated\n3. A predefined IVR flow/ Valid sound file\n\n# API Parameters\n| Parameter Name\t| Description\t| Expected Value | Is Mandatory? |\n|----------|----------|------------|------------|\n| method\t| Predefined method | voice.call\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON, JSONP, XML and PHP | False |\n| numbers\t| Number(s) for generating OBD call. Multiple numbers separated by \",\". | 10 Digit phone number. Single or multiple(comma separated) (max 200)\t| True\t|\n| group | Contact group ID or group name from where number has to be picked. If given, overrides numbers parameter (above) | Numeric Group ID(comma separated for multiple) or Group Name (single) | False |\n| play\t| Valid sound file reference OR an IVR created in given account. | Sound file ID. (Ex: 123.sound) Format of IVR on second leg: ivr:id (Ex: ivr:1234 or 1234.ivr)\t| True\t|\n| message | Message in text format (English only) to be verbalized over outbound call. Play configuration (above) takes the priority over message | URL encoded text, English only | False |\n| retries | Number of retry to be made if caller(First Leg) doesn't answer the call. Ex Usage: \"&retry=X\" | Numeric value, default 0 (max 2) | False |\n| campaign | Campaign name five given API call | URL encoded text | False |\n| newgroup | Option to enable separate group listing for every API call over application. Default option combines the similar API calls into single group | Numeric value 1.Default 0 | False |\n| scheduletime | Date time value when the call has to be scheduled. Minimum, 15 mins from current time is accepted (max upto 2 month) | EPOCH or datetime in YYYY-MM-DD HH:mm:SS or DD/MM/YYYY HH:MM AM format | False |\n| delay | Numeric time delay (in seconds) to be introduced before initiating the current request | Numeric, max 900 | False |\n| meta | JSON metadata or additional parameters | Sample JSON | False |\n| custom | Custom reference ID for call | Alpha-numeric ID, Comma seperated for multiple numbers | False |\n| callback | Callback URL to be triggered at the end of the call | http://callback.com/?obdid={obdid} | False |\n\n\n# Response Data\n| Response | Description |\n|------------|-----------|\n| status | It indicates the success or failure of your API request. 200 is success, others are failure |\n| message | It indicates the success or failure message |"},"response":[{"id":"b9fb3950-c446-45cb-b4a8-2d3a5a7debfb","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{voice.call}}","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"numbers","value":"{{phone_number}}","type":"text"},{"key":"play","value":"{{soundfile}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>200</status>\r\n    <message>OK</message>\r\n</api>"},{"id":"25fbfa6e-a983-4165-8241-390b286c238c","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"api_key","value":"{{api_key}}","type":"text"},{"key":"method","value":"{{voice.call}}","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"numbers","value":"{{phone_number}}","type":"text"},{"key":"play","value":"{{soundfile}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"status\": \"200\",\r\n  \"message\": \"OK\"\r\n}"}],"_postman_id":"01f87c33-b80b-42b7-8357-9366398b1000"},{"name":"OBD call using JSON data","id":"57be5bf0-f946-470a-8993-729fcfd1718d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{{json}}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/{{version}}/?method={{voice.json}}&format=json","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"method","value":"{{voice.json}}","type":"text"},{"key":"format","value":"json","type":"text"}]},"description":"# What can you do with this API?\nThis API enables you to initiate an outbound call using JSON data to call a similar message to multiple numbers or different messages to different numbers\n\n> Call can be sent using the JSON API by posting values to the preceding URL by the POST method with URL encoded JSON data.\n\n\n# Prerequisites\n1. An API Key\n2. JSON Data\n\n|Parameter Name\t|Description\t| Expected Value\t| Is mandatory?\t|\n|-------|-------|-------|--------|\n| method\t| Predefined method | voice.json\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON, JSONP, XML and PHP | False |\n| group | Contact group ID or group name from where the number has to be picked. If given, overrides numbers parameter (above) | Numeric Group ID(comma separated for multiple) or Group Name (single) | False\t|\n| to | Number(s) for generating OBD call. Multiple numbers separated by \",\" | 10 Digit phone number. Single or multiple(comma separated) | True |\n| play | Valid sound file reference OR an IVR created in given account | Sound file ID. (Ex: 123.sound)      Format of IVR on second leg: ivr:id (Ex: ivr:1234 or 1234.ivr) | True |\n| message | Message in text format (English only) to be verbalized over an outbound call. Play configuration (above) takes the priority over message | URL encoded text, English only | False\t|\n| retries | Number of retry to be made if caller(First Leg) doesn't answer the call. Ex Usage: \"&retry=X\" | Numeric value, default 0 (max 2) | False\t|\n| campaign | Campaign name of the given API call | URL encoded text | False\t|\n| scheduletime | Date time value when the call has to be scheduled. Minimum, 15 mins from current time is accepted (max upto 2 month) | EPOCH or datetime in YYYY-MM-DD HH:mm:SS or DD/MM/YYYY HH:MM AM format | False\t|\n| delay | Numeric time delay (in seconds) to be introduced before initiating the current request | Numeric, max 900 | False\t|\n| custom | Custom reference ID for call | Alpha-numeric ID, Comma separated for multiple numbers | False\t|\n| meta | JSON metadata or additional parameters | {\"param1\":\"value1\"} | False\t|\n| callback | Callback URL to be triggered at the end of the call | http://callback.com/?obdid={obdid} | False\t|\n\n# Example Data\n\n\n## Sending to multiple numbers with the same message\n\n\t{\n\t\"play\": \"123.sound\",\n\t\"campaign\": \"campaign-name\",\n\t\"scheduletime\": \"2019-07-01 10:00:00\",\n\t\"callback\": \"http://www.example.com/xyz\",\n\t\"call\":[\n\t{\n\t\"to\": \"95XXXXXXXX,97XXXXXXXX\",\n\t\"play\": \"1122.sound\",\n\t\"message\": \"test sms\",\n\t\"custom\": \"ABC12\",\n\t\"meta\": {\n\t       \"param1\":\"value1\"\n\t        }\n\t}] \n\t}\n\t\n## Sending to multiple numbers with a different message\n\n\n        {\n\t\"campaign\": \"campaign-name\",\n\t\"scheduletime\": \"2019-07-01 10:00:00\",\n\t\"callback\": \"http://callback.com/xyz\",\n\t\"call\": [\n        {\n\t\"to\": \"97xxxx,86xxxx\",\n\t\"play\": \"1122.sound\",\n\t\"custom\": \"ABC124\",\n\t\"meta\": {\n\t       \"param1\":\"value1\"\n\t      }\n\t},\n\t{\n\t\"group\": \"4477\",\n\t\"play\": \"1122.sound\",\n\t\"custom\": \"ABC124\",\n\t\"meta\": {\n\t       \"param1\":\"value1\",\n\t       \"param2\":\"value2\"\n\t      }\n\t},\n\t{\n\t\"to\": \"96xxxx,85xxxx\",\n\t\"message\": \"this is message\",\n\t\"callback\": \"http://callback.com/xyz/abc\"\n\t}\n\t]\n        }\n\t\n# Response Data\n| Response | Description |\n|------------|-----------|\n| status | It indicates the success or failure of your API request. 200 is success, others are failure |\n| message | It indicates the success or failure message |\n| data | All the response is wrapped inside data |\n| id | Unique call ID, numeric with symbols |\n| mobile | Recipient number |\n| status | Call status code |\n| senttime | Call sent time in YYYY-MM-DD HH:mm:SS format |"},"response":[{"id":"c01d4bac-9e8a-468d-b2bc-03516d3cd85d","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{{json}}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/{{version}}/?method={{voice.json}}&format=json","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"method","value":"{{voice.json}}"},{"key":"format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"status\": \"200\",\r\n    \"message\": \"OK\",\r\n    \"data\": {\r\n        \"0\": {\r\n            \"id\": \"217691534-1\",\r\n            \"mobile\": \"9988XXXXXX\",\r\n            \"status\": \"SENT\"\r\n        },\r\n        \"1\": {\r\n            \"id\": \"217691534-2\",\r\n            \"mobile\": \"9756XXXXXX\",\r\n            \"status\": \"SENT\"\r\n        },\r\n        \"group_id\": 217691534\r\n    }\r\n}"},{"id":"fcd826f9-55e0-498c-bf5d-4a3292a2684c","name":"XML","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{{json}}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/{{version}}/?method={{voice.json}}&format=xml","host":["{{base_url}}"],"path":["{{version}}",""],"query":[{"key":"method","value":"{{voice.json}}"},{"key":"format","value":"xml"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\r\n<api>\r\n    <status>200</status>\r\n    <message>OK</message>\r\n    <data>\r\n        <group_id>217717940</group_id>\r\n        <voice>\r\n            <id>217717940-1</id>\r\n            <mobile>9988XXXXXX</mobile>\r\n            <status>SENT</status>\r\n        </voice>\r\n        <voice>\r\n            <id>217717940-2</id>\r\n            <mobile>9756XXXXXX</mobile>\r\n            <status>SENT</status>\r\n        </voice>\r\n    </data>\r\n</api>"}],"_postman_id":"57be5bf0-f946-470a-8993-729fcfd1718d"},{"name":"Check Obd Call Status","id":"14002870-0129-4c47-8226-c57752289ddc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"voice.status","type":"text"},{"key":"format","value":"xml","type":"text","disabled":true},{"key":"id","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/","description":"# What can do with this API?\nUsing this API, you can check the status of the OBD calls that have been triggered from your account.\n\n# Prerequisites\n1. An active Voice account\n2. API Key\n3. OBD call ID\n4. Phone number to check the status\n\n# API Parameters\n| Parameter Name\t| Description\t| Expected Value | Is Mandatory? |\n|----------|----------|------------|------------|\n| method\t| Predefined method | voice.status\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON, JSONP, XML and PHP | False |\n| id | Outbound call ID | Numeric with symbols, unique Call ID, communicated while making outbound call API request | True |\n| mobile | Phone Number | Numeric | False |\n\n# Response Data\n| Response | Description |\n|------------|-----------|\n| status | It indicates the success or failure of your API request. 200 is success, others are failure |\n| message | It indicates the success or failure message |\n| data | All the response is wrapped inside data |\n| id | Unique call ID, numeric with symbols |\n| mobile | Recipient number |\n| status | Call status code |\n| senttime | Call sent time in YYYY-MM-DD HH:mm:SS format |"},"response":[{"id":"6b1b88b4-61be-4397-aa80-e373b20482ee","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{voice.status}}","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"numbers","value":"{{phone_number}}","type":"text"},{"key":"play","value":"{{soundfile}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"status\": \"200\",\r\n  \"data\": {\r\n      \"0\": {\r\n          \"id\": \"123456-1\",\r\n          \"mobile\": \"99XXXXXXXX\",\r\n          \"status\": \"COMPLETED\",\r\n          \"senttime\": \"2017-08-17 12:09:16\"\r\n      }\r\n  },\r\n  \"message\": \"OK\"\r\n}"},{"id":"f0320c5b-02d5-44e1-b712-6d84f302d625","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{voice.status}}","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"numbers","value":"{{phone_number}}","type":"text"},{"key":"play","value":"{{soundfile}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<api>\r\n<status>200</status>\r\n<message>OK</message>\r\n <data>\r\n <voice>\r\n<id>123456-1</id>\r\n<mobile>99XXXXXXXX</mobile>\r\n<status>COMPLETED</status>\r\n<senttime>2017-08-17 12:09:16</senttime>\r\n</voice>\r\n</data>\r\n</api>"}],"_postman_id":"14002870-0129-4c47-8226-c57752289ddc"},{"name":"Check OBD call group status","id":"80fe05b1-9a60-4399-a936-2fd8e7e94785","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"voice.groupStatus","type":"text"},{"key":"format","value":"xml","type":"text","disabled":true},{"key":"groupid","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/","description":"# What can do with this API?\nUsing this API, you can check the status of the OBD calls that have been triggered from your account.\n\n# Prerequisites\n1. An active Voice account\n2. API Key\n3. OBD call ID\n4. Phone number to check the status\n\n# API Parameters\n| Parameter Name\t| Description\t| Expected Value | Is Mandatory? |\n|----------|----------|------------|------------|\n| method\t| Predefined method | voice.groupstatus\t| True\t|\n| api_key\t| API key generated from your account | Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3\t| True\t|\n| format | Output response format | Default text. Supports JSON, JSONP, XML and PHP | False |\n| groupid | Outbound group ID | Numeric group ID, communicated while making outbound call API request | True |\n| campaign | Campaign name of outbound call | Text | False |\n\n# Response Data\n| Response | Description |\n|------------|-----------|\n| status | It indicates the success or failure of your API request. 200 is success, others are failure |\n| message | It indicates the success or failure message |\n| data | All the response is wrapped inside data |\n| id | Unique call ID, numeric with symbols |\n| mobile | Recipient number |\n| status | Call status code |\n| senttime | Call sent time in YYYY-MM-DD HH:mm:SS format |"},"response":[{"id":"673e7bb4-5ca9-4c69-b810-19b74f8433a1","name":"XML","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"voice.groupStatus","type":"text"},{"key":"format","value":"xml","type":"text"},{"key":"groupid","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"<api>\r\n<status>200</status>\r\n<message>OK</message>\r\n <data>\r\n <voice>\r\n<id>123456-1</id>\r\n<mobile>99XXXXXXXX</mobile>\r\n<status>COMPLETED</status>\r\n<senttime>2017-08-17 12:09:16</senttime>\r\n</voice>\r\n</data>\r\n</api>"},{"id":"b51aa08f-c6c6-4d5d-a485-0c4387325396","name":"JSON","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"method","value":"voice.groupStatus","type":"text"},{"key":"format","value":"json","type":"text"},{"key":"groupid","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"status\": \"200\",\r\n  \"data\": {\r\n      \"0\": {\r\n          \"id\": \"123456-1\",\r\n          \"mobile\": \"99XXXXXXXX\",\r\n          \"status\": \"COMPLETED\",\r\n          \"senttime\": \"2017-08-17 12:09:16\"\r\n      }\r\n  },\r\n  \"message\": \"OK\"\r\n}"}],"_postman_id":"80fe05b1-9a60-4399-a936-2fd8e7e94785"}],"event":[{"listen":"prerequest","script":{"id":"d9221307-1585-4751-8aac-0e23ae2cf7f3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ef1c6be1-914c-45a9-802a-0896a4f1516c","type":"text/javascript","exec":[""]}}]}