{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2db2ab94-821b-4acb-88f7-01979c5b2692","name":"Voximplant Kit API documentation","description":"This public collection contains common queries, sample responses, and links to supporting documentation for the Voximplant Kit API.\n\n# Overview\n\nAll API methods support the application/x-www-form-urlencoded format. If required, upload a file to the server in the multipart/form-data format.\n\n# Authentication\n\nThe preferred way of using the Voximplant Kit API is as follows:\n\n- Generate an **API token** in the Administration > Security > API tokens section in Voximplant Kit.\n    \n- Paste the generated API token into the **access_token** parameter in a request body or URL (**YOUR_ACCESS_TOKEN**).\n    \n- Copy your **Account name** in the Administration > Security > API tokens section in Voximplant Kit.\n    \n- Paste the Account name into the **domain** parameter in a request or URL (**YOUR_ACCOUNT_NAME**).\n    \n- Copy your **API hostname** in the Administration > Security > API tokens section in Voximplant Kit.\n    \n- Paste your API hostname into a request URL (**YOUR_ACCOUNT_API_HOST**).\n    \n- **YOUR_ACCOUNT_CTI_API_HOST** is kit-cti-**region**.voximplant.com, where the **region** is your account region in lowercase (us, br, eu, kz, ru, ru2).\n    \n- **YOUR_ACCOUNT_MESSAGING_API_HOST** is kit-im-**region**.voximplant.com, where the **region** is your account region in lowercase (us, br, eu, kz, ru, ru2).\n    \n\n# Completion codes\n\nA completion code indicates the result of a call attempt. Voximplant Kit returns completion codes in callbacks and API responses that contain call attempt information.\n\nThe listed values refer to the **completion_code** field.\n\n## Available completion codes\n\n| Code | Description | Successful |\n| --- | --- | --- |\n| **Other_Error** | Dialing error that does not match other completion codes. | No |\n| **Temporary_Unavailable** | Destination number unavailable. | No |\n| **Request_Terminated** | Call request terminated. | No |\n| **AMD** | Answer machine detected within the configured timeout. | No |\n| **Invalid_Number** | Incorrect destination phone number. | No |\n| **Call_Busy** | Destination number busy. | No |\n| **No_Answer** | No answer within the configured dialing timeout. | No |\n| **Call_Answered** | Call answered. | Yes |\n| **Insufficient_Funds** | Insufficient funds for the call. | No |\n| **Call_Was_Rejected** | Call rejected. | No |\n| **Restricted_By_DNC** | Call restricted by the DNC list. | No |\n| **Abandoned** | No agent available after the customer answers the call. | No |\n| **Lost_By_Agent** | Agent does not answer the distributed call. | No |\n| **Missed_By_Scenario** | Inbound call missed in IVR. | No |\n| **No_Agents** | No agents available. | No |\n| **System_Error** | System error. | No |\n| **Call_Prohibited** | Call prohibited. | No |\n\n## Completion codes by call type\n\n**Inbound call scenario:**\n\n| Code | When returned |\n| --- | --- |\n| **Call_Answered** | The call is answered. |\n| **Abandoned** | The call is distributed to a queue, but no agent is available. |\n| **Lost_By_Agent** | The call is distributed to an agent, but the agent does not answer or rejects the call. |\n| **Missed_By_Scenario** | The inbound call ends in a scenario without reaching the Successful call block and without transfer attempts to an agent. |\n| **System_Error** | Terminated with systemError=true. |\n\n**Outbound call scenario / automated campaign:**\n\n| Code | When returned |\n| --- | --- |\n| **Other_Error** | Unrecognized CallFailed code, except 480, 487, 404, 486, 408, 402, 603, and 403. |\n| **Temporary_Unavailable** | CallFailed: 480. |\n| **Request_Terminated** | CallFailed: 487. |\n| **AMD** | AMD is triggered. |\n| **Invalid_Number** | CallFailed: 404. |\n| **Call_Busy** | CallFailed: 486. |\n| **No_Answer** | CallFailed: 408 or the configured dialing timeout is reached. |\n| **Call_Answered** | The callee answers the call. |\n| **Insufficient_Funds** | CallFailed: 402. |\n| **Call_Was_Rejected** | CallFailed: 603. |\n| **Restricted_By_DNC** | DNC restriction is triggered. |\n| **Abandoned** | The call is sent to a queue or a queue extension, but no agent is available. |\n| **Lost_By_Agent** | The call is sent to an extension, such as a queue, group, or user. For queues, the code is returned only if the task has been distributed to an agent. |\n| **System_Error** | Terminated with systemError=true. |\n| **Call_Prohibited** | CallFailed: 403. |\n\n**Outbound call from softphone:**\n\n| Code | When returned |\n| --- | --- |\n| **Other_Error** | Unrecognized CallFailed code, except 480, 487, 404, 486, 408, 402, 603, and 403. |\n| **Temporary_Unavailable** | CallFailed: 480. |\n| **Request_Terminated** | CallFailed: 487. |\n| **AMD** | AMD is triggered. |\n| **Invalid_Number** | CallFailed: 404. |\n| **Call_Busy** | CallFailed: 486. |\n| **No_Answer** | CallFailed: 408 or the configured dialing timeout is reached. |\n| **Call_Answered** | The callee answers the call. |\n| **Insufficient_Funds** | CallFailed: 402. |\n| **Call_Was_Rejected** | CallFailed: 603. |\n| **Restricted_By_DNC** | DNC restriction is triggered. |\n| **System_Error** | Terminated with systemError=true. |\n| **Call_Prohibited** | CallFailed: 403. |\n\n**PDS campaign:**\n\n| Code | When returned |\n| --- | --- |\n| **Other_Error** | Unrecognized CallFailed code, except 480, 487, 404, 486, 408, 402, 603, and 403. |\n| **Temporary_Unavailable** | CallFailed: 480. |\n| **Request_Terminated** | CallFailed: 487. |\n| **AMD** | AMD is triggered. |\n| **Invalid_Number** | CallFailed: 404. |\n| **Call_Busy** | CallFailed: 486. |\n| **No_Answer** | CallFailed: 408 or the configured dialing timeout is reached. |\n| **Call_Answered** | The callee answers the call. |\n| **Insufficient_Funds** | CallFailed: 402. |\n| **Call_Was_Rejected** | CallFailed: 603. |\n| **Restricted_By_DNC** | DNC restriction is triggered. |\n| **Abandoned** | The call is distributed to a queue, but no agent is available. |\n| **Lost_By_Agent** | The call is distributed to an agent, but the agent does not answer or rejects the call. |\n| **System_Error** | Terminated with systemError=true. |\n| **Call_Prohibited** | CallFailed: 403. |\n\n**Automatic callbacks:**\n\n| Code | When returned |\n| --- | --- |\n| **Other_Error** | Unrecognized CallFailed code, except 480, 487, 404, 486, 408, 402, 603, and 403, when dialing a customer. |\n| **Temporary_Unavailable** | CallFailed: 480 when dialing a customer. |\n| **Request_Terminated** | CallFailed: 487 when dialing a customer. |\n| **AMD** | AMD is triggered when dialing a customer. |\n| **Invalid_Number** | CallFailed: 404 when dialing a customer. |\n| **Call_Busy** | CallFailed: 486 when dialing a customer. |\n| **No_Answer** | CallFailed: 408 or the configured dialing timeout is reached when dialing a customer. |\n| **Call_Answered** | The customer answers the call. |\n| **Insufficient_Funds** | CallFailed: 402. |\n| **Call_Was_Rejected** | CallFailed: 603. |\n| **Restricted_By_DNC** | DNC restriction is triggered. |\n| **Lost_By_Agent** | The agent rejects the call, hangs up before connection with the customer, or does not answer the call. |\n| **No_Agents** | Agents are unavailable for calls, for example, offline. |\n| **System_Error** | Terminated with systemError=true. |\n| **Call_Prohibited** | CallFailed: 403. |\n\n## CallFailed codes\n\nSome completion codes correspond to CallFailed codes:\n\n| Completion code | CallFailed code |\n| --- | --- |\n| **Temporary_Unavailable** | 480 |\n| **Request_Terminated** | 487 |\n| **Invalid_Number** | 404 |\n| **Call_Busy** | 486 |\n| **No_Answer** | 408 |\n| **Insufficient_Funds** | 402 |\n| **Call_Was_Rejected** | 603 |\n| **Call_Prohibited** | 403 |\n| **Other_Error** | Any unrecognized CallFailed code except 480, 487, 404, 486, 408, 402, 603, and 403. |\n\n# Error codes\n\nThe most common response status codes are as follows:\n\n- **200** - Ok. The request succeeded.\n    \n- **400, 422** - Bad or unprocessable request. The server cannot process the request due to client or semantic errors.\n    \n- **401** - Unauthorized request. The client must authenticate itself to get the requested response.\n    \n- **402** - Payment is required. Some API requests may be chargeable.\n    \n- **403** - Forbidden. The client does not have access rights to the content.\n    \n- **404** - Not found. The server cannot find the requested resource (for example, a non-existent queue ID in queue update requests).\n    \n- **429** - Too many requests. Users cannot send too many requests in a given amount of time (rate limit).\n    \n- **5XX** - Voximplant Kit server error.\n    \n\nIf a response status is not Ok (200), its body contains an error code with a detailed description.\n\nExample:\n\n```\n{\n    \"success\": false,\n    \"result\": {\n        \"error\": \"You are not allowed to perform this action.\",\n        \"code\": 403\n    }\n}\n\n ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"24429561","collectionId":"2db2ab94-821b-4acb-88f7-01979c5b2692","publishedId":"2s93m33im7","public":true,"publicUrl":"https://kit-apidoc.voximplant.com","privateUrl":"https://go.postman.co/documentation/24429561-2db2ab94-821b-4acb-88f7-01979c5b2692","customColor":{"top-bar":"FFFFFF","right-sidebar":"15082B","highlight":"662EFF"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/127075b0-ad4c-4002-9d03-f3671e27e26f/TG9nbyBmb3IgZGFyayBiZy5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"8B55FF"}},{"name":"light","logo":"https://content.pstmn.io/452408a0-37c1-4077-912c-56afff6607ec/TG9nbyBmb3Igd2hpdGUgYmcucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"15082B","highlight":"662EFF"}}]}},"version":"8.10.1","publishDate":"2024-09-17T07:37:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/452408a0-37c1-4077-912c-56afff6607ec/TG9nbyBmb3Igd2hpdGUgYmcucG5n","logoDark":"https://content.pstmn.io/127075b0-ad4c-4002-9d03-f3671e27e26f/TG9nbyBmb3IgZGFyayBiZy5wbmc="}},"statusCode":200},"environments":[{"name":"Voximplant Kit","id":"005c0d8a-6105-46b5-8659-642af8feead9","owner":"10165820","values":[{"key":"host","value":"YOUR_ACCOUNT_API_HOST","enabled":true,"type":"default"},{"key":"domain","value":"YOUR_ACCOUNT_NAME","enabled":true,"type":"default"},{"key":"access_token","value":"YOUR_ACCESS_TOKEN","enabled":true,"type":"default"},{"key":"email","value":"","enabled":true,"type":"default"},{"key":"password","value":"","enabled":true,"type":"default"},{"key":"cti_host","value":"YOUR_ACCOUNT_CTI_API_HOST","enabled":true,"type":"default"},{"key":"messaging-host","value":"YOUR_ACCOUNT_MESSAGING_API_HOST","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/0eeced068dbfe89c7e89920dd858a8ae5ef13953a7e56f9072fce7598a347317","favicon":"https://voximplant.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Voximplant Kit","value":"10165820-005c0d8a-6105-46b5-8659-642af8feead9"}],"canonicalUrl":"https://kit-apidoc.voximplant.com/view/metadata/2s93m33im7"}