{"info":{"_postman_id":"2932f8d9-421f-422e-9b5e-3fead623332a","name":"Outbound Dialing (OBD) API","description":"# What can you do with this API?\nThe Outbound Dialing (OBD) API enables you to connect your customer to the agent efficiently. OBD uses HTTP Basic Authentication. You do not need to disclose your username or password to access the OBD API. Through your account dashboard you can generate unlimited secure API keys to access the OBD API, which also means that you will be restricted to only accessing the data enabled on your OBD user profile.\n\n# Base URL for Integration\n> https://obd.kaleyra.com/api/v1/","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Start OBD Call","id":"955388da-4833-4191-a2ac-c5ee37b5750a","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":"27698bc3-cfff-4166-a96c-70d64689051d","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":"ba0603a3-cde0-4440-8613-7ecbefa36c7a","name":"PHP","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":"php","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":"text","header":null,"cookie":[],"responseTime":null,"body":"Array\r\n(\r\n[status] => 200\r\n[message] => OK\r\n)"},{"id":"c73bc21f-f2d5-478e-bd85-3e713f8c61b4","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":"955388da-4833-4191-a2ac-c5ee37b5750a"},{"name":"Check Outbound Call Status","id":"5ee23414-9998-4ae7-9813-e9533d0c5b51","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":"523c8a57-57ec-4247-96d9-adce50dffc41","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":"9320b110-44ed-43e7-90c8-e7e1b45d0e37","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>"},{"id":"e3dfdf87-2905-4220-bc13-081665727f01","name":"PHP","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"method","value":"{{voice.status}}","type":"text"},{"key":"format","value":"php","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":null,"header":null,"cookie":[],"responseTime":null,"body":"Array\r\n(\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":"5ee23414-9998-4ae7-9813-e9533d0c5b51"},{"name":"Check OBD call group status","id":"2a5d4001-7cd2-41e3-82cf-df9db4117aee","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":"125eab1f-cf9d-4101-b9d5-d964c22f6011","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":"55526a6a-c419-4574-92f4-377523354d18","name":"PHP","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":"php","type":"text"},{"key":"groupid","value":"{{id}}","type":"text"}]},"url":"{{base_url}}/{{version}}/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Array\r\n(\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":"fc1bd157-9f8f-4399-8354-21aab501db6d","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":"2a5d4001-7cd2-41e3-82cf-df9db4117aee"}]}