{"id":323,"date":"2022-10-11T20:05:21","date_gmt":"2022-10-11T17:05:21","guid":{"rendered":"http:\/\/192.168.200.3:8082\/?page_id=323"},"modified":"2025-02-10T07:06:16","modified_gmt":"2025-02-10T04:06:16","slug":"flash-call-api","status":"publish","type":"page","link":"https:\/\/docs.cpaas.mittoapi.net\/?page_id=323","title":{"rendered":"Flash\u0421all 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 the 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 title
POST \/apps\/activate HTTP\/1.1
Host: https:\/\/cpaas.mittoapi.net\/api
X-Authorization: AccessKey d8ac9959r12b43545XXXXX,<\/p>\n\n\n\n

either by parameter
POST https:\/\/cpaas.mittoapi.net\/api\/apps\/activate?X-Authorization=AccessKey d8ac9959r12b43545XXXXX<\/p>\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<\/strong><\/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        \u201cstatus\u201d: \u201cok\u201d\n        ....\n    }<\/code><\/pre>\n\n\n\n
FlashCall requests<\/h2>\n\n\n\n
POST https:\/\/cpaas.mittoapi.net\/api\/apps\/flash\/calls\/flash
HTTP Basic
Authorization: token<\/p>\n\n\n\n
Parameters in the body, json<\/p>\n\n\n\n
    {\n        \"number\": \"791791367878\",\n        \"code\": 1234,\n        \"timeout\": 60000, \n    } <\/code><\/pre>\n\n\n\n
Parameter<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
number<\/td>Phone number in e.164 format<\/td><\/tr>
code<\/td>Code, 4e characters<\/td><\/tr>
timeout<\/td>Maximum call time in ms<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Answer:<\/h2>\n\n\n\n
In case of successful sending, RequestId is returned \u2014 the ID of the message on the partner’s side, which is then returned to the callback.<\/p>\n\n\n\n
Example of a successful response:<\/h2>\n\n\n\n
    {\n        \"requestId\": XXXXXX\n        \"from\": \"79179136787\"\n    }<\/code><\/pre>\n\n\n\n
Example of an unsuccessful response:<\/h2>\n\n\n\n
    {\n        \"errorCode\" : 1,\n        \"errorReason\" : \"Authentication required\"\n    }<\/code><\/pre>\n\n\n\n
Description of error codes<\/h2>\n\n\n\n
errorCode<\/strong><\/th>errorReason<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
1 \u041d\u0422\u0422P 401<\/td>Authentication required<\/td>Invalid authentication token<\/td><\/tr>
2 HTTP 400<\/td>Inactive account<\/td>Inactive account. Contact support<\/td><\/tr>
4 HTTP 429<\/td>Too many requests<\/td>Too many requests in a short period of time<\/td><\/tr>
5 HTTP 401<\/td>Inactive token<\/td>Inactive token<\/td><\/tr>
6 HTTP 403<\/td>Insufficient funds<\/td>Low balance, unable to complete the request<\/td><\/tr>
10 HTTP 400<\/td>Invalid request<\/td>Incorrectly formed request<\/td><\/tr>
11 HTTP 400<\/td>Invalid number<\/td>Invalid number format. The number must be in the format (E.164).<\/td><\/tr>
16 HTTP 400<\/td>Sender not allowed<\/td>Sender id is invalid for this type of request<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Getting statuses<\/h2>\n\n\n\n
Getting statuses should be configured via Callback<\/p>\n\n\n\n
Parameters in the callback<\/h2>\n\n\n\n
Parameter<\/strong><\/th>Description<\/strong><\/th><\/tr><\/thead>
requestId<\/td>The unique identifier of the request on the partner’s side<\/td><\/tr>
number<\/td>Subscriber’s number<\/td><\/tr>
status<\/td>Status (shown in the table below)<\/td><\/tr>
timestamp<\/td>The time of the status change in unixtime format<\/td><\/tr>
appKey<\/td>The API key of the application<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Statuses comparison<\/h2>\n\n\n\n
Statuses that a Partner can return<\/strong><\/th>Description of the Partner status<\/strong><\/th>The corresponding status is Message_state<\/strong><\/th><\/tr><\/thead>
ANSWERED<\/td>The call came, the caller picked up the phone<\/td>DELIVERED<\/td><\/tr>
TERMINATED<\/td>The call came, the subscriber did not pick up the phone (the call was interrupted after the ttl or by command)<\/td><\/td><\/tr>
BUSY_HERE<\/td>The call came, the caller dropped the call<\/td><\/td><\/tr>
REJECTED<\/td>The call cannot be made, for example, if the number is still occupied by another call or another SIP error<\/td>UNDELIVERED<\/td><\/tr>
UNAVAILABLE<\/td>The subscriber is unavailable, the phone is turned off<\/td><\/td><\/tr>
FORBIDDEN<\/td>It is returned when the anti-fraud is triggered<\/td><\/td><\/tr><\/tbody><\/table><\/figure>\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 the required applications in your account. To do this, each request must contain a …  Flash\u0421all API<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"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\/323"}],"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=323"}],"version-history":[{"count":14,"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=\/wp\/v2\/pages\/323\/revisions"}],"predecessor-version":[{"id":4252,"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=\/wp\/v2\/pages\/323\/revisions\/4252"}],"wp:attachment":[{"href":"https:\/\/docs.cpaas.mittoapi.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=323"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}