{"id":73,"date":"2022-10-10T08:36:58","date_gmt":"2022-10-10T05:36:58","guid":{"rendered":"http:\/\/192.168.200.3:8082\/?page_id=73"},"modified":"2026-06-17T13:29:25","modified_gmt":"2026-06-17T10:29:25","slug":"platform-http-api","status":"publish","type":"page","link":"https:\/\/docs.cpaas.mittoapi.net\/?page_id=73","title":{"rendered":"Platform HTTP API"},"content":{"rendered":"\n

Interaction format<\/h2>\n\n\n\n

API requests are made over the HTTP protocol. Input and output data structures are transmitted in the request and response body in JSON format.<\/p>\n\n\n\n

Authorization<\/h2>\n\n\n\n

Most HTTP API calls require authentication and authorization procedures that link API calls to required applications in your account.<\/p>\n\n\n\n

To do this, each request must contain a header or an X-Authorization argument with a connection token in the AccessKey token format.<\/p>\n\n\n\n

For example, the headline:<\/p>\n\n\n\n

POST \/apps\/activate HTTP\/1.1\nHost: https:\/\/cpaas.mittoapi.net\/api\nX-Authorization: AccessKey d8ac9959r12b43545XXXXX<\/code><\/pre>\n\n\n\n
or<\/pre>\n\n\n\n
Authorization: Basic d8ac9959r12b43545XXXXX (or Basic base64encoded(username:password))\nand also\nAuthorization: Bearer d8ac9959r12b43545XXXXX<\/code><\/pre>\n\n\n\n
X-Authorization is transmitted depending on the HTTP connection settings:<\/p>\n\n\n\n
AccessKey d8ac9959r12b43545XXXXX — by default<\/td><\/tr>
Basic d8ac9959r12b43545XXXXX (or Basic base64encoded(username:password))<\/td><\/tr>
Bearer d8ac9959r12b43545XXXXX<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
either by parameter:<\/p>\n\n\n\n
POST https:\/\/cpaas.mittoapi.net\/api\/apps\/activate?X-Authorization=AccessKey d8ac9959r12b43545XXXXX<\/code><\/pre>\n\n\n\n
Request example using CURL:<\/strong><\/p>\n\n\n\n
curl --location --request POST 'https:\/\/cpaas.mittoapi.net\/api\/apps\/activate' \\\n--header 'X-Authorization: AccessKey d8ac9959r12b43545XXXXX'<\/code><\/pre>\n\n\n\n
curl --location --request POST 'https:\/\/cpaas.mittoapi.net\/api\/apps\/activate?X-Authorization=AccessKey%d8ac9959r12b43545XXXXX'<\/code><\/pre>\n\n\n\n
Response format<\/h2>\n\n\n\n
The JSON scheme of any response contains a string type status parameter with the following values:<\/p>\n\n\n\n
Status Value<\/th>Description<\/th><\/tr><\/thead>
ok<\/td>No errors<\/td><\/tr>
invalidAccessKeyError<\/td>Invalid AccessKey<\/td><\/tr>
requiredJsonError<\/td>The request body requires JSON<\/td><\/tr>
invalidSchemeError<\/td>Invalid JSON scheme<\/td><\/tr>
invalidDataError<\/td>Input data error<\/td><\/tr>
prohibitedForAppError<\/td>Prohibited for this application<\/td><\/tr>
prohibitedForServiceError<\/td>Prohibited for this service<\/td><\/tr>
rpcError<\/td>Communication error<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
For example:<\/p>\n\n\n\n
{\n    \u2026\n    \"status\": \"ok\"\n    ...\n}<\/code><\/pre>\n\n\n\n
Some GET requests support paginated output. The following parameters are used to control the paginated output<\/p>\n\n\n\n
Parameter<\/th>Description<\/th><\/tr><\/thead>
page<\/td>Requested page number<\/td><\/tr>
per_page<\/td>Number of elements per page<\/td><\/tr>
disable_pagination<\/td>Disable paginated output<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
For example,<\/p>\n\n\n\n
GET https:\/\/cpaas.mittoapi.net\/api\/media?page=1&per_page=10<\/code><\/pre>\n\n\n\n
Request example using CURL:<\/strong><\/p>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/media?page=1&per_page=10' \\\n--header 'X-Authorization: AccessKey d8ac9959r12b43545XXXXX'\n\ncurl --location --request POST 'https:\/\/cpaas.mittoapi.net\/api\/media?page=1&per_page=10%3FX-Authorization%3DAccessKey%20d8ac9959r12b43545XXXXX'<\/code><\/pre>\n\n\n\n
The response to such a request will contain a pagination json object<\/p>\n\n\n\n
{\n    \u2026\n    \"pagination\": {\n        \"totalItems\": 2,\n        \"currentPage\": 1,\n        \"totalPages\": 1\n    }\n    ....\n}<\/code><\/pre>\n\n\n\n
Where<\/p>\n\n\n\n
Parameter<\/th>Description<\/th><\/tr><\/thead>
totalItems<\/td>Total number of elements<\/td><\/tr>
currentPage<\/td>Page sequence number<\/td><\/tr>
totalPages<\/td>Total number of pages<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Request format<\/h2>\n\n\n\n
Media Library Management<\/h2>\n\n\n\n
A media library is a hierarchical storage of various user files, resembling a file system. Media library storage objects are files and folders. Files can be divided into folders. The library is accessed using Personal Account or this API.<\/p>\n\n\n\n
Parameter<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
totalItems<\/td>Total number of elements<\/td><\/tr>
currentPage<\/td>Page sequence number<\/td><\/tr>
totalPages<\/td>Total number of pages<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Getting a list of all objects<\/h2>\n\n\n\n
Request<\/strong>:<\/p>\n\n\n\n
GET https:\/\/cpaas.mittoapi.net\/api\/media<\/code><\/pre>\n\n\n\n
Request example using CURL:<\/strong><\/p>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/media?X-Authorization=AccessKey%20d8ac9959r12b43545XXXXX'\n\ncurl --location 'https:\/\/cpaas.mittoapi.net\/api\/media' \\\n--header 'X-Authorization: AccessKey d8ac9959r12b43545XXXXX'<\/code><\/pre>\n\n\n\n
Response<\/strong>:<\/p>\n\n\n\n
{\n        \"status\":  \"ok\",\n        \"pagination\": {\n            \"totalItems\":  2,\n            \"currentPage\":  1,\n            \"totalPages\":  1\n        },\n        \"media\": [\n            {\n                \"createdDateTime\":  \"2020-02-12 18:09:10\",\n                \"id\":  65,\n                \"name\":  \"Hymns\",\n                \"isFolder\":  1\n            },\n            {\n                \"createdDateTime\":  \"2020-03-04 13:17:47\",\n                \"id\":  74,\n                \"name\":  Sound.mp3\",\n                \"isFolder\":  0\n            }\n        ]\n    }<\/code><\/pre>\n\n\n\n
media \u2014 an array of media library objects containing the following parameters:<\/p>\n\n\n\n
Parameter<\/th>Description<\/strong><\/th><\/tr><\/thead>
id<\/td>Unique identifier of the media resource<\/td><\/tr>
name<\/td>Name<\/td><\/tr>
createdDateTime<\/td>Date\\time of upload<\/td><\/tr>
isFolder<\/td>Indicates that this object is a folder. 1 \u2014 yes, 0 \u2014 no<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Getting a specific object<\/h2>\n\n\n\n
Request<\/strong>:<\/p>\n\n\n\n
GET https:\/\/cpaas.mittoapi.net\/api\/media\/id<\/code><\/pre>\n\n\n\n
where id is the unique identifier of the media resource<\/p>\n\n\n\n
Example of requests using CURL:<\/strong><\/p>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/media\/id?X-Authorization=AccessKey%20d8ac9959r12b43545XXXXX'\n\ncurl --location 'https:\/\/cpaas.mittoapi.net\/api\/media\/id' \\\n--header 'X-Authorization: AccessKey d8ac9959r12b43545XXXXX'<\/code><\/pre>\n\n\n\n
Response<\/strong>:<\/p>\n\n\n\n
A list of attached files is returned for folders<\/p>\n\n\n\n
{\n        \"status\": \"ok\",\n        \"pagination\": {\n            \"totalPages\": 1,\n            \"totalItems\": 2,\n            \"currentPage\": 1\n        },\n        \"media\": [\n            {\n                \"isFolder\": 0,\n                \"name\": \"Audio1.mp3\",\n                \"createdDateTime\": \"2020-02-12 18:19:05\",\n                \"id\": 67\n            },\n            {\n                \"isFolder\": 0,\n                \"name\": \"Audio2.mp3\",\n                \"createdDateTime\": \"2020-02-12 18:19:18\",\n                \"id\": 68\n            }\n        ]\n    }    <\/code><\/pre>\n\n\n\n
For files, the requested file is returned.<\/p>\n\n\n\n
Folder creation<\/h2>\n\n\n\n
Request:<\/strong><\/p>\n\n\n\n
POST https:\/\/cpaas.mittoapi.net\/api\/media<\/code><\/pre>\n\n\n\n
Request body:<\/p>\n\n\n\n
    {\n        \"name\": \"asdasd\"\n    }<\/code><\/pre>\n\n\n\n
Example of requests using CURL:<\/strong><\/p>\n\n\n\n
curl --location 'hhttps:\/\/cpaas.mittoapi.net\/api\/media' \\\n--header 'X-Authorization: AccessKey d0a72c04168758df39XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n   \"name\": \"Folder1\"\n}'\n\ncurl --location 'https:\/\/cpaas.mittoapi.net\/api\/media?X-Authorization=AccessKey%20d0a72c04168758df39XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n   \"name\": \"Folder2\"\n}'<\/code><\/pre>\n\n\n\n
Parameter<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
name<\/td>Folder name<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Response:<\/strong><\/p>\n\n\n\n
{\n    \"status\": \"ok\",\n     \"media\": {\n      \"name\": \"asdasd\",\n      \"createdDateTime\": \"2020-04-06 18:44:45\",\n      \"isFolder\": 1,\n      \"id\": 111\n     }\n} <\/code><\/pre>\n\n\n\n
File Upload<\/h2>\n\n\n\n
Request:<\/strong><\/p>\n\n\n\n
Place the file in the root folder:<\/p>\n\n\n\n
POST https:\/\/cpaas.mittoapi.net\/api\/media<\/code><\/pre>\n\n\n\n
Place the file in the specified folder:<\/p>\n\n\n\n
POST https:\/\/cpaas.mittoapi.net\/api\/media\/folder_id<\/code><\/pre>\n\n\n\n
The file is passed in the request body via Content-Type: multipart\/form-data<\/p>\n\n\n\n
Example of requests using CURL:<\/strong><\/p>\n\n\n\n
Place the file in the root folder:<\/p>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/media?X-Authorization=AccessKey%20d0a72c04168758df39XXXXX' \\\n--form '=@\"\/home\/Downloads\/les.mp3\"'<\/code><\/pre>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/media' \\\n--header 'X-Authorization: AccessKey d0a72c04168758df39XXXXX' \\\n--form '=@\"\/home\/Downloads\/les.mp3\"'<\/code><\/pre>\n\n\n\n
Place the file in the specified folder:<\/strong><\/p>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/media\/12826?X-Authorization=AccessKey%20d0a72c04168758df39XXXXX' \\\n--form '=@\"\/home\/Downloads\/les.mp3\"'<\/code><\/pre>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/media\/12826' \\\n--header 'X-Authorization: AccessKey d0a72c04168758df39XXXXX' \\\n--form '=@\"\/home\/Downloads\/les.mp3\"'<\/code><\/pre>\n\n\n\n
Response:<\/strong><\/p>\n\n\n\n
{\n    \"status\": \"ok\",\n    \"media\": {\n     \"name\": \"test\",\n     \"createdDateTime\": \"2020-04-06 18:44:45\",\n     \"isFolder\": 0,\n     \"id\": 112\n    }\n}<\/code><\/pre>\n\n\n\n
Object rename<\/h2>\n\n\n\n
Request<\/h2>\n\n\n\n
PUT https:\/\/cpaas.mittoapi.net\/api\/media\/id<\/code><\/pre>\n\n\n\n
 where id is the unique identifier of the media resource<\/p>\n\n\n\n
Request body:<\/p>\n\n\n\n
{\n   \"name\": \"Test\"\n}<\/code><\/pre>\n\n\n\n
Example of requests using CURL:<\/strong><\/p>\n\n\n\n
curl --location --request PUT 'https:\/\/cpaas.mittoapi.net\/api\/media\/12826' \\\n--header 'X-Authorization: AccessKey d0a72c04168758df39XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n   \"name\": \"Test\"\n}'<\/code><\/pre>\n\n\n\n
curl --location --request PUT 'https:\/\/cpaas.mittoapi.net\/api\/media\/12826?X-Authorization=AccessKey%20d0a72c04168758df39XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n   \"name\": \"Test\"\n}'<\/code><\/pre>\n\n\n\n
Response:<\/strong><\/p>\n\n\n\n
{\n    \"status\": \"ok\",\n    \"media\": {\n      \"name\": \"Test\",\n      \"createdDateTime\": \"2020-04-06 18:44:45\",\n      \"isFolder\": 1,\n      \"id\": 111\n    }\n} <\/code><\/pre>\n\n\n\n
Deleting an object<\/h2>\n\n\n\n
Request:<\/strong><\/p>\n\n\n\n
DELETE https:\/\/cpaas.mittoapi.net\/api\/media\/id<\/code><\/pre>\n\n\n\n
where id is the unique identifier of the media resource<\/p>\n\n\n\n
Example of requests using CURL:<\/strong><\/p>\n\n\n\n
curl --location --request DELETE 'https:\/\/cpaas.mittoapi.net\/api\/media\/12826' \\\n--header 'X-Authorization: AccessKey d0a72c04168758df39XXXXX'<\/code><\/pre>\n\n\n\n
curl --location --request DELETE 'https:\/\/cpaas.mittoapi.net\/api\/media\/12826?X-Authorization=AccessKey%20d0a72c04168758df39XXXXX'<\/code><\/pre>\n\n\n\n
Response:<\/strong><\/p>\n\n\n\n
{\n    \"status\": \"ok\"\n}<\/code><\/pre>\n\n\n\n
Application Management<\/h2>\n\n\n\n
Application activation<\/h2>\n\n\n\n
Performs activation of a pre-created application.<\/p>\n\n\n\n
Request:<\/strong><\/p>\n\n\n\n
POST https:\/\/cpaas.mittoapi.net\/api\/apps\/activate<\/code><\/pre>\n\n\n\n
Request body:<\/p>\n\n\n\n
{\n  \"reference\": \"123456789\",\n  \"sourceAddr\": \"XXXXXXXXXXX\",\n  \"destAddr\": \"XXXXXXXXXXX\",\n  \"gender\": 1,\n  \"volume\": 1,\n  \"language\": \"xx-XX\",\n  \"rate\": 1,\n  \"scenarioData\": \"text=Hello, how are you?\"\n}<\/code><\/pre>\n\n\n\n
Example of requests using CURL:<\/strong><\/p>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/apps\/activate?X-Authorization=AccessKey%20d0a72c04168758df39XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n   \"reference\": \"123456789\",\n   \"sourceAddr\": \"7XXXXXXXXXX\",\n   \"destAddr\": \"7XXXXXXXXXX\",\n   \"scenarioData\": \"text=\u0418\u0432\u0430\u043d \u0418\u0432\u0430\u043d\u043e\u0432\u0438\u0447\",\n   \"language\": \"ru-RU\",\n   \"sex\": 1,\n   \"volume\": 2,\n   \"rate\": 4\n}'<\/code><\/pre>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/apps\/activate' \\\n--header 'X-Authorization: AccessKey d0a72c04168758df39XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n   \"reference\": \"123456789\",\n   \"sourceAddr\": \"7XXXXXXXXXX\",\n   \"destAddr\": \"7XXXXXXXXXX\",\n   \"scenarioData\": \"text=\u0418\u0432\u0430\u043d \u0418\u0432\u0430\u043d\u043e\u0432\u0438\u0447\",\n   \"language\": \"ru-RU\",\n   \"sex\": 1,\n   \"volume\": 2,\n   \"rate\": 4\n}'<\/code><\/pre>\n\n\n\n
Parameter<\/strong><\/th>Type<\/strong><\/th>Description<\/th><\/tr><\/thead>
reference
(optional)<\/td>		string<\/td>The user parameter with which the callback will be called based on the results of the application execution<\/td><\/tr>
sourceAddr<\/td>string<\/td>Outgoing number<\/td><\/tr>
destAddr<\/td>string<\/td>Recipient’s phone number<\/td><\/tr>
scenarioData
(optional)<\/td>		string<\/td>Script variables for this application. It is a set of parameter=value pairs separated by — &.<\/td><\/tr>
gender
(optional)<\/td>		int<\/td>Gender. 2 \u2014 female, 1 \u2014 male<\/td><\/tr>
volume
(optional)<\/td>		int<\/td>Voice volume (0-2)<\/td><\/tr>
rate
(optional)<\/td>		int<\/td>The speed of speaking the text (0-4). (0 is the slowest)<\/td><\/tr>
language
(optional)<\/td>		string<\/td>The synthesis language.
Available languages:
en-US \u2013 English (US)
en-IN \u2013 English (Indian)
en-IE \u2013 English (Ireland)
en-UA \u2013 English (Australian)
en-GB-WLS \u2013 English (Welsh)
en-NZ \u2013 English (New Zealand)
en-ZA \u2013 English (South African)
ar-AE \u2013 Arabic (gulf)
nl-NL \u2013 Dutch
nl-BE \u2013 Dutch (Belgain)
da-DK \u2013 Danish
is-IS \u2013 Icelandic
es-ES \u2013 Spanish (European)
es-US \u2013 Spanish (US)
es-MX \u2013 Spanish (Mexican)
it-IT \u2013 Italian
ca-ES \u2013 Catalan
cmn-CN \u2013 Chinese (Mandarin)
yue-CN \u2013 Chinese (Cantonese)
ko-KR \u2013 Korean
de-DE \u2013 German
de-AT \u2013 German (Austrian)
nb-NO \u2013 Norwegian
pl-PL \u2013 Polish
pt-PT \u2013 Portuguese (European)
pt-BR \u2013 Portuguese (Brazillian)
ro-RO \u2013 Romanian
ru-RU \u2013 Russian
tr-TR \u2013 Turkish
cy-GB \u2013 Welsh
fi-FI \u2013 Finnish
fr-FR \u2013 French
fi-CA \u2013 French (Canadian)
fr-BE \u2013 French (Belgian)
sv-SE \u2013 Swedish
ja-JP \u2013 Japanese<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Response:<\/strong><\/p>\n\n\n\n
{\n    \"status\": \"ok\"\n}<\/code><\/pre>\n\n\n\n
If there is an error in sourceAddr:<\/strong><\/p>\n\n\n\n
{
    \"status\": \"invalidDataError\",
    \"error\": \"Field sourceAddr must not contain Cyrillic\"
}<\/code><\/pre>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
status<\/strong><\/td>string<\/td>Request status<\/td><\/tr>
error<\/strong><\/td>string<\/td>The sourceAddr field must not contain Cyrillic characters.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Example of a scenario with a variable that is set in the request:<\/p>\n\n\n\n
\"\"<\/a><\/figure>\n\n\n\n
Launching the application with repeats<\/h2>\n\n\n\n
Starting the application with repeats is a process that initiates a call, automatically retrying in case of an unsuccessful outcome, such as a busy line, no answer, failed call, or successful response. The repeat settings allow you to define conditions and parameters for each scenario.<\/p>\n\n\n\n
Example:<\/strong><\/p>\n\n\n\n
If a call to the subscriber fails due to a busy line (repeatBusy), the system automatically retries after the set interval (repeatBusyInt) until the number of attempts (repeatBusyCount) is exhausted.<\/p>\n\n\n\n
Request:<\/strong><\/p>\n\n\n\n
POST https:\/\/cpaas.mittoapi.net\/api\/apps\/activate<\/code><\/pre>\n\n\n\n
Request body:<\/strong><\/p>\n\n\n\n
{\n  \"reference\": \"123456789\",\n  \"sourceAddr\": \"XXXXXXXXXXX\",\n  \"destAddr\": \"XXXXXXXXXXX\",\n\n  \"scenarioData\": \"text=Hello, how are you?\",\n\n  \"isRepeat\": 1,\n  \"repeatBusy\": 1,\n  \"repeatBusyCount\": 10,\n  \"repeatBusyInt\": 30,\n  \"repeatAnswered\": 1,\n  \"repeatAnsweredCount\": 10,\n  \"repeatAnsweredInt\": 35,\n  \"repeatFailed\": 1,\n  \"repeatFailedCount\": 10,\n  \"repeatFailedInt\": 1,\n  \"repeatNoAnswer\": 1,\n  \"repeatNoAnswerCount\": 10,\n  \"repeatNoAnswerInt\": 150\n}<\/code><\/pre>\n\n\n\n
Example of requests using CURL:<\/strong><\/p>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/apps\/activate' \\\n--header 'X-Authorization: AccessKey d0a72c04168758df39XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n   \"reference\": \"123456789\",\n   \"sourceAddr\": \"7XXXXXXXXXX\",\n   \"destAddr\": \"7XXXXXXXXXX\",\n   \"scenarioData\": \"text=\u041f\u0440\u0438\u0432\u0435\u0442, \u043a\u0430\u043a \u0434\u0435\u043b\u0430?\",\n   \"isRepeat\": 1,\n   \"repeatBusy\": 1,\n   \"repeatBusyCount\": 10,\n   \"repeatBusyInt\": 30,\n   \"repeatAnswered\": 1,\n   \"repeatAnsweredCount\": 10,\n   \"repeatAnsweredInt\": 35,\n   \"repeatFailed\": 1,\n   \"repeatFailedCount\": 1,\n   \"repeatFailedInt\": 1,\n   \"repeatNoAnswer\": 1,\n   \"repeatNoAnswerCount\": 10,\n   \"repeatNoAnswerInt\": 150\n}'<\/code><\/pre>\n\n\n\n
curl --location 'https:\/\/cpaas.mittoapi.net\/api\/apps\/activate?X-Authorization=AccessKey%20d0a72c04168758df39XXXXX' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n   \"reference\": \"123456789\",\n   \"sourceAddr\": \"7XXXXXXXXXX\",\n   \"destAddr\": \"7XXXXXXXXXX\",\n\n   \"scenarioData\": \"text=\u041f\u0440\u0438\u0432\u0435\u0442, \u043a\u0430\u043a \u0434\u0435\u043b\u0430?\",\n  \n   \"isRepeat\": 1,\n   \"repeatBusy\": 1,\n   \"repeatBusyCount\": 10,\n   \"repeatBusyInt\": 30,\n   \"repeatAnswered\": 1,\n   \"repeatAnsweredCount\": 10,\n   \"repeatAnsweredInt\": 35,\n   \"repeatFailed\": 1,\n   \"repeatFailedCount\": 1,\n   \"repeatFailedInt\": 1,\n   \"repeatNoAnswer\": 1,\n   \"repeatNoAnswerCount\": 10,\n   \"repeatNoAnswerInt\": 150\n}'<\/code><\/pre>\n\n\n\n
Parameters<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
reference<\/td>string<\/td>The user parameter with which the callback will be called based on the results of the application execution<\/td><\/tr>
sourceAddr<\/td>string<\/td>Outgoing number<\/td><\/tr>
destAddr<\/td>string<\/td>Recipient’s phone number<\/td><\/tr>
scenarioData<\/td>string<\/td>Script variables for this application. It is a set of parameter=value pairs separated by \u2014 &.<\/td><\/tr>
isRepeat<\/td>int<\/td>Repeat permission:
0 \u2014 repeats are not made
1 \u2014 repeats are made<\/sup><\/sub><\/td><\/tr>
repeatBusy<\/td>int<\/td>Repeat on busy number<\/td><\/tr>
repeatAnswered<\/td>int<\/td>Repeat on successful answer<\/td><\/tr>
repeatFailed<\/td>int<\/td>Repeat on failed call<\/td><\/tr>
repeatNoAnswer<\/td>int<\/td>Repeat on no answer<\/td><\/tr>
repeatBusyCount,
repeatAnsweredCount,
repeatFailedCount,
repeatNoAnswerCount<\/td>		int<\/td>Number of repeats<\/td><\/tr>
repeatBusyInt,
repeatAnsweredInt,
repeatFailedInt,
repeatNoAnswerInt<\/td>		int<\/td>Repeat call interval (in seconds)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Response<\/h2>\n\n\n\n
{\n    \"status\": \"ok\",\n    \"requestId\": \"37b873131de218352d63f980cb71b41b\"\n}<\/code><\/pre>\n\n\n\n
During application execution, callbacks can be configured over the HTTP\/HTTPS protocol. Callback is configured for two types of events \u2014 Start of execution (Start callback) and end of execution (End callback). Basic authorization is supported. Parameters are passed to the request URL.<\/p>\n\n\n\n
See the callback versions and what methods are used in them here<\/a>.<\/p>\n\n\n\n
\"\"<\/a><\/figure>\n\n\n\n
Example,
GET www.host.ru?type=startCallback&reference=324234<\/p>\n\n\n\n
Parameters passed to the startCallback<\/p>\n\n\n\n
Parameter<\/th>Description<\/strong><\/th><\/tr><\/thead>
reference<\/td>User parameter passed in the activation request<\/td><\/tr>
type<\/td>The type of callback request, in this case \u2014 startCallback<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Parameters passed to endCallback<\/p>\n\n\n\n
Parameter<\/th>Description<\/th><\/tr><\/thead>
reference<\/td>User parameter passed in the activation request<\/td><\/tr>
type<\/td>The type of callback request, in this case \u2014 endCallback<\/td><\/tr>
state<\/td>Application execution result<\/td><\/tr>
error<\/td>Error code, or 0 \u2014 in case of successful execution<\/td><\/tr>
duration<\/td>Duration of the call<\/td><\/tr>
appKey<\/td>The API key of the application<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
where, state is the result of script execution<\/p>\n\n\n\n
<\/th>Value<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
STATE_OK<\/td>2<\/td>Application completed successfully<\/td><\/tr>
STATE_ERR<\/td>5<\/td>Error as a result of execution<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
error \u2014 error code<\/p>\n\n\n\n
<\/th>Value<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
ERR_NO_ANSWER<\/td>16<\/td>The subscriber did not pick up the phone, attempts to dial are exhausted<\/td><\/tr>
ERR_BUSY<\/td>17<\/td>The subscriber is busy, dial-up attempts have been exhausted<\/td><\/tr>
ERR_ALERTING<\/td>19<\/td>The subscriber is unavailable<\/td><\/tr>
ERR_CONGESTION<\/td>34<\/td>Overload of communication channels<\/td><\/tr>
ERR_PLAY<\/td>1001<\/td>File playback error, file not found, invalid format<\/td><\/tr>
ERR_TTS<\/td>1002, 1017<\/td>TTS Conversion Error<\/td><\/tr>
ERR_ASR<\/td>1003<\/td>ASR Conversion error<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Script execution error codes<\/h2>\n\n\n\n
Error value<\/th>Error<\/th>Description<\/th><\/tr><\/thead>
1001<\/td>SCENARIO_NOT_FOUND<\/td>An internal script execution error
indicates that the script that should have been executed does not exist or cannot be found<\/sub><\/td><\/tr>
1002<\/td>SCENARIO_JSON_PARSER_ERROR<\/td>An internal Json script parsing error
can occur if the script has incorrect syntax or structure<\/sub><\/td><\/tr>
1003<\/td>SCENARIO_VAR_ID_ERROR<\/td>An internal error in parsing script variables
may indicate problems with variable identification (not used)<\/sub><\/td><\/tr>
1004<\/td>SCENARIO_VAR_NAME_ERROR<\/td>Indicates problems with variable names in the script
may be caused by an incorrect or missing variable name (not used)<\/sub><\/td><\/tr>
1005<\/td>TRUNK_NOT_FOUND<\/td>The trunk cannot be found according to the specified routing rules
may be caused by incorrect routing settings or the absence of the required trunk<\/sub><\/td><\/tr>
1006<\/td>REDIRECT_TRUNK_NOT_FOUND<\/td>The trunk cannot be found according to the specified routing rules when forwarding a call
may occur due to errors in the forwarding settings<\/sub><\/td><\/tr>
1007<\/td>MODIFIERS_ERROR<\/td>The error of the call modifiers
indicates that the values of sourceAddr, destAddr, trunk Data were incorrectly changed for this call<\/sub><\/td><\/tr>
1008<\/td>REDIRECT_MODIFIERS_ERROR<\/td>Call modifiers error during forwarding
the values of source Addr, dest Addr, trunk Data were incorrectly changed for call forwarding<\/sub><\/td><\/tr>
1009<\/td>CHANNEL_CREATION_ERROR<\/td>An error that occurs when creating a communication channel transmitted from Asterisk
may be caused by problems with the configuration or resources of the system<\/sub><\/td><\/tr>
1010<\/td>REDIRECT_CHANNEL_CREATION_ERROR<\/td>An error when creating a forwarding channel
indicates problems with creating a channel for a forwarded call<\/sub><\/td><\/tr>
1011<\/td>REDIRECT_BRIDGE_CREATION_ERROR<\/td>An error creating a conference bridge during forwarding transmitted from Asterisk
a bridge cannot be created to connect multiple call participants<\/sub><\/td><\/tr>
1012<\/td>REDIRECT_ADDING_SOURCE_CHANNEL_TO_BRIDGE_ERROR<\/td>Error when adding a forwarded call channel to the bridge, transmitted from Asterisk
the original channel cannot be correctly added to the bridge<\/td><\/tr>
1013<\/td>REDIRECT_ADDING_DEST_CHANNEL_TO_BRIDGE_ERROR<\/td>Error when adding the channel to which calls are forwarded to the bridge transmitted from Asterisk<\/td><\/tr>
1014<\/td>INCOMING_CALL_ANSWER_ERROR<\/td>Occurs if the call was dropped before the script execution started, because the channel no longer existed
when the incoming call was answered with an error from Asterisk<\/sub><\/td><\/tr>
1015<\/td>PLAYBACK_START_ERROR<\/td>The error when playing to the channel comes from Asterisk<\/td><\/tr>
1016<\/td>RECORD_START_ERROR<\/td>The error when writing from the channel comes from Asterisk<\/td><\/tr>
1017<\/td>TTS_FAULT<\/td>A speech synthesis error transmitted from the app-TTS
application
may be caused by problems with speech synthesis or incorrect data for synthesis<\/sub><\/td><\/tr>
1018<\/td>WRONG_DATA_IN_REQUEST<\/td>Request data parsing error
indicates incorrect or missing data in the request<\/sub><\/td><\/tr>
1019<\/td>NUMBER_NOT_FOUND_IN_POOL_BY_ENDING<\/td>Selecting a number from the pool at the end of the number for FlashCall
it may be caused by the absence of the corresponding number in the pool<\/sub><\/td><\/tr>
1020<\/td>INTERFACE_NAME_EMPTY_ERROR<\/td>Error when selecting a trunk
indicates incorrect or missing trunk configuration data<\/sub><\/td><\/tr>
1021<\/td>REDIRECT_INTERFACE_NAME_EMPTY_ERROR<\/td>An error when selecting a trunk for forwarding due to the absence of an interface name
indicates incorrect or missing trunk configuration data<\/sub><\/td><\/tr>
0<\/td>Call sent to void<\/td>The completion of a normal scenario
indicates that the call has completed normally, without any problems or errors<\/sub><\/td><\/tr>
1<\/td>Unallocated<\/td>It can happen when the requested resource does not exist or is currently unavailable<\/td><\/tr>
4-5<\/td>Vendor specific 4-5<\/td>Vendor-specific error
the specific error value depends on the hardware or service provider<\/sub><\/td><\/tr>
6<\/td>Channel unaccessible<\/td>The channel is unavailable
indicates that the communication channel required for the call is unavailable<\/sub><\/td><\/tr>
9-13<\/td>Vendor specific 9-13<\/td>Vendor-specific error
the specific error value depends on the hardware or service provider<\/sub><\/td><\/tr>
16<\/td>Normal Clearing<\/td>Normal termination
the call is completed on the initiative of one of the parties (subscriber or operator) without errors<\/sub><\/td><\/tr>
17<\/td>Line busy<\/td>The user is busy
the number of the called party is busy and the call cannot be completed<\/sub><\/td><\/tr>
18<\/td>No user response<\/td>No response from the user
the called party does not answer the call during the set waiting time<\/sub><\/td><\/tr>
19<\/td>No answer<\/td>The user was notified, but did not answer
the subscriber was notified of an incoming call (for example, the phone rang), but did not accept it<\/sub><\/td><\/tr>
20<\/td>Subscriber absent<\/td>Missing subscriber
indicates that the called subscriber is temporarily unavailable<\/sub><\/td><\/tr>
21<\/td>Call Rejected<\/td>The call is rejected
the called party intentionally rejected the incoming call<\/sub><\/td><\/tr>
22<\/td>Number changed<\/td>The number has been changed<\/td><\/tr>
27<\/td>Destination out of order<\/td>The purpose of the call is out of service
the end equipment or network of the called party is not working or unavailable<\/sub><\/td><\/tr>
28<\/td>Invalid number format<\/td>Incorrect number format
the entered phone number has an incorrect format and cannot be recognized by the network<\/sub><\/td><\/tr>
29<\/td>Facility rejected<\/td>Feature rejected
the requested service or feature is not supported or rejected by the network<\/sub><\/td><\/tr>
31<\/td>Normal unspecified<\/td>The usual unspecified
the call ended for the usual reason, which was not explicitly stated<\/sub><\/td><\/tr>
32<\/td>(Reserved)<\/td>Reserved for future use<\/td><\/tr>
34<\/td>No circuit available<\/td>Circuit\/channel overload
there is an overload in the network and the call cannot be processed<\/sub><\/td><\/tr>
36<\/td>Out of order<\/td>Faulty
indicates that the equipment or line is not working properly<\/sub><\/td><\/tr>
38<\/td>Network out of order<\/td>The network is not working
there has been a network outage, which makes it impossible to end the call<\/sub><\/td><\/tr>
43<\/td>Access disconnect<\/td>Disabling access
indicates that network access has been disabled<\/sub><\/td><\/tr>
58<\/td>Bearer capability not available<\/td>Load-bearing capacity is not available<\/td><\/tr>
98<\/td>Blacklist<\/td>Indicates that the call was blocked because the number is on the blacklist<\/td><\/tr>
99<\/td>Vad avtoinformator error<\/td>Indicates that the call was processed by the auto-informer<\/td><\/tr>
100<\/td>InvalidIe contents<\/td>Invalid IE content (Information Element)
indicates an error in the information passed in the element<\/sub><\/td><\/tr>
102<\/td>Recover on timer expiry<\/td>Recovery after the timer expires<\/td><\/tr>
127<\/td>Failure<\/td>Interaction\/not specified<\/td><\/tr>
199<\/td>Transaction abort<\/td>Abort a transaction
the transaction was aborted for some reason<\/sub><\/td><\/tr>
200
<\/td>		No translation for address of such nature<\/td>It may be due to the fact that the address is invalid, non-existent or not recognized by the system<\/td><\/tr>
201<\/td>No translation for this specific address<\/td>There is no conversion for this particular address
indicates that there is no routing or conversion for the specified address<\/sub><\/td><\/tr>
212<\/td>Hop counter violation<\/td>Violation of the traffic counter
indicates that the allowed number of clicks in the network has been exceeded<\/sub><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Balance check<\/h2>\n\n\n\n
Request<\/h2>\n\n\n\n
GET https:\/\/cpaas.mittoapi.net\/api\/balance<\/p>\n\n\n\n
Displays a personal account and its balance in JSON format. The personal account is displayed as the one on which the application is located, the key for which is specified in the request authorization<\/p>\n\n\n\n
Response<\/h2>\n\n\n\n
     {\n        \"personalAccountId\": \"0000000000\",\n        \"balance\": \"100.0\"\n     }<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
Interaction format API requests are made over the HTTP protocol. Input and output data structures are transmitted in the request and response body in JSON format. Authorization Most HTTP API calls require authentication and authorization procedures that link API calls to required applications in your account. To do this, each request must contain a header …  Platform HTTP API<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":9,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"tpl\/http-content.php","meta":[],"acf":[],"_links":{"self":[{"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=\/wp\/v2\/pages\/73"}],"collection":[{"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=73"}],"version-history":[{"count":67,"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=\/wp\/v2\/pages\/73\/revisions"}],"predecessor-version":[{"id":4346,"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=\/wp\/v2\/pages\/73\/revisions\/4346"}],"up":[{"embeddable":true,"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=\/wp\/v2\/pages\/9"}],"wp:attachment":[{"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=73"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}