HTTP интерфейс call¶
Инициирует звонок на абонента А на номер callback_callee_id c именем звонящего callback_caller_name и номером звонящего callback_caller_id.
После того, как абонент А ответил, инициирует звонок на абонента Б на номер dial_callee_id от имени абонента А (с именем звонящего callback_callee_id и номером звонящего callback_callee_id).
Абонент А слышит процесс набора на своем телефоне.
Аргументы¶
| аргумент | обязательный | описание |
| _login | да | совпадает с логином пользователя/компании к личному кабинету |
| _password | да | совпадает с паролем пользователя/компании к личному кабинету |
| callback_callee_id | да | номер абонента А |
| dial_callee_id | да | номер абонента Б |
| callback_caller_name | нет | имя звонящего, отправляемое в звонке на абонента А |
| callback_caller_id | нет | номер звонящего, отправляемое в звонке на абонента А |
Возвращаемые данные¶
Сервер возвращает ответ в формате JSON API.
В ответе может присутствовать одно из:
- errors.
Массив ошибок, возникших при обработке запроса. - data.
JSON объект, содержащий результаты запроса, если запрос от клиента содержит 1 номер.
Массив JSON объектов, если запрос от клиента содержит несколько номеров.
errors и data не присутствуют в 1 ответе одновременно.
Каждый ответ содержит либо errors, либо data.
В качестве data на данный момент передается null.
В будущем data будет содержать полезные атрибуты.
| атрибут | обязательный | описание |
| code | да | Короткий код ошибки. Может использоваться клиентом для условной обработки ошибки. Не зависит от локали клиента. |
| detail | да | Детали ошибки. Может использоваться клиентом для отображения в содержимом диалогового окна ошибки. Может быть выдано сервером в локали клиента. |
| title | да | Заголовок ошибки. Может использоваться клиентом для отображения в заголовке диалогового окна ошибки. Может быть выдано сервером в локали клиента. |
Примеры¶
Успешный звонок.¶
| запрос | POST "https://имя.вашего.сервера/api/call?_login=LOGIN&_password=PASSWORD&callback_callee_id=100&dial_callee_id=12123388100&callback_caller_id=John" |
| ответ |
{
"data" : null,
} |
Ошибка¶
| запрос | POST "https://имя.вашего.сервера/api/call?_login=LOGIN&_password=PASSWORD&callback_callee_id=100&dial_callee_id=12123388100&callback_caller_id=John" |
| ответ |
{
"errors" : [
{
"code" : "authentication",
"detail" : "Please check your login and password",
"title" : "Authentication error"
}
]
}
|