Project

General

Profile

HTTP API call

Initiates a call to a subscriber A number callback_callee_id with the caller name callback_caller_name and caller ID callback_caller_id.
After subscriber A answeres, initiates a call to a subscriber B number dial_callee_id on behalf of the subscriber A (with caller name callback_callee_id and caller ID callback_callee_id).
A subscriber A hears the dialing process on his phone.

Arguments

argument mandatory description
_login yes coincides with the user / company login to the personal account
_password yes matches the user / company password to the personal account
callback_callee_id yes subscriber A number
dial_callee_id yes subscriber B number
callback_caller_name no caller name which is sent in a call to a subscriber A
callback_caller_id no caller ID which is sent in a call to a subscriber A

Returned data

Server returns response in JSON API format.
Response will contain one of:

  • errors.
    Array of errors, occured when processing the request.
  • data.
    JSON object, which contains request results, in case if request from client contains 1 number.
    Array of JSON objects, in case if request from client contains several numbers.

errors and data will not be present in 1 response simultaneously.
Each response contains either errors, or data.

Currently data is always null.
Soon data will contain more useful attributes.

errors can contain following attributes:
attribute mandatory description
code yes Short error code.
Can be used by a client for conditional error handling.
It doesn't depend on a client's locale.
detail yes Error details.
Can be used by a client to display inside contents of a error dialog.
Can be returned by the server in a locale of a client.
title yes Error title.
Can be used by a client to display in the header of the error dialog.
Can be returned by the server in a locale of a client.

Example

Successful call

request POST "https: //your.server.name/api/call?callback_callee_id=100&dial_callee_id=12123388100&callback_caller_id=John&_login=LOGIN&_password=PASSWORD"
response
{
   "data": null,
} 

Error

request POST "https: //your.server.name/api/call?callback_callee_id=100&dial_callee_id=12123388100&callback_caller_id=John&_login=LOGIN&_password=PASSWORD"
response
{
    "errors" : [
        {
            "code" : "authentication",
            "detail" : "Please check your login and password",
            "title" : "Authentication error" 
        }
    ]
}

Русский перевод

Also available in: PDF HTML TXT