API реализуемое на стороне провайдера IP-телефонии.
Информация об активном вызове. Публикуется при первом наступлении события или смене состояния.
{ "call_id":string, "state":string, "from":object(Caller), "to":object(Caller) }
Наименование поля | Тип | Описание |
---|---|---|
call_id | string | Глобальный идентификатор вызова (в формате провайдера). |
state | string | Текущие состояние вызова. Принимает следующие значения: Calling - инициация вызова; Connected - соединение двух абонентов; OnHold - вызов на удержании; Finished - вызов завершен. |
from | object(Caller) | Данные инициатора вызова. |
to | object(Caller) | Данные вызываемого. |
Содержит информацию об абоненте. Абонентом может выступать как внутренний номер и так и внешний (например, мобильный номер). При этом внутреннему абоненту может быть установлен в соответствие внешний номер, если вызов проходит через АТС пользователя API.
{ "number":string, "extension":string }
Наименование поля | Тип | Описание |
---|---|---|
number | string | Номер абонента (внутренний или мобильный). |
extension | string | Идентификатор внутреннего абонента. Может использоваться в качестве аргумента при вызове удаленных процедур. Для внешнего абонента содержит пустую строку. |
{ "call_id":"askozia-1445526019", "state":"Calling", "from":{ "extension":"SIP\140", "number":"140" }, "to":{ "extension":"SIP\112", "number":"112" } }
Инициирует исходящей вызов. Система сперва выполняет вызов инициатора. После установления соединения с инициатором выполняется попытка дозвона по заданному номеру телефона.
{ "from":object(Caller), "to_number":string }
Наименование поля | Тип | Описание |
---|---|---|
from | object(Caller) | Данные инициатора вызова. Если поле Caller.number указано, то выполняется вызов на мобильный номер инициатора. |
to_number | string | Номер вызываемого абонента (внутренний или мобильный). |
{ "result":string }
Наименование поля | Тип | Описание |
---|---|---|
result | string | Результат выполнения команды. |
Устанавливает активный вызов на удержание. Повторное выполнение команды снимает вызов с удержания.
{ "call_id":string }
Наименование поля | Тип | Описание |
---|---|---|
call_id | string | Глобальный идентификатор вызова (в формате провайдера). |
{ "result":string }
Наименование поля | Тип | Описание |
---|---|---|
result | string | Результат выполнения команды. |
Принудительно завершает вызов.
{ "call_id":string }
Наименование поля | Тип | Описание |
---|---|---|
call_id | string | Глобальный идентификатор вызова (в формате провайдера). |
cause | string | (Опция) Причина завершения вызова. |
{ "result":string }
Наименование поля | Тип | Описание |
---|---|---|
result | string | Результат выполнения команды. |
Переводит одного из абонентов активного вызова на другой номер телефона. Для другого абонента вызов считается завершенным.
{ "call_id":string, "which":object(Caller), "to_number":string }
Наименование поля | Тип | Описание |
---|---|---|
call_id | string | Глобальный идентификатор вызова (в формате провайдера). |
which | object(Caller) | Данные абонента, который будет переведен. |
to_number | string | Номер вызываемого абонента (внутренний или мобильный). |
{ "result":string }
Наименование поля | Тип | Описание |
---|---|---|
result | string | Результат выполнения команды. |