Это старая версия документа!
API реализуемое на стороне провайдера IP-телефонии.
Содержит информацию об активном вызове. Событие формируется при первом появлении информации о вызове или смене его состояния.
{ "time":string, "entire_id":string, "call_id":string, "state":string, "from":object(Caller), "to":object(Caller), "status":string, "record":string, "line_number":string }
Наименование поля | Описание |
---|---|
time string | Дата и время возникновения вызова в формате RFC3339. |
entire_id string | Глобальный идентификатор группы вызовов (в формате провайдера). Объединяет все вызовы, которые формируются в процессе переадресации звонка. |
call_id string | Глобальный идентификатор текущего вызова (в формате провайдера). |
state string | Текущие состояние вызова. Принимает следующие значения: Calling - инициация вызова; Connected - соединение двух абонентов; OnHold - вызов на удержании; Finished - вызов завершен. |
from object(Caller) | Данные инициатора вызова. |
to object(Caller) | Данные вызываемого. |
status string | Статус вызова (при наличии) по завершению звонка. Принимает следующие значения: ANSWER - на вызов был ответ; BUSY - получен сигнал «занято»; NOANSWER - на вызов не было ответа; CANCEL - звонящий отменил вызов; CONGESTION - произошла ошибка во время вызова; CHANUNAVAIL - у вызываемого абонента отсутствует регистрация. |
record string | Содержит ссылку на файл записи разговора. |
line_number string | Номер телефона (при наличии), предоставляемого провайдером, на который был совершен звонок. |
Содержит информацию об абоненте. Абонентом может выступать внутренний номер или внешний (например, мобильный номер).
{ "number":string, "extension":string }
Наименование поля | Описание |
---|---|
number string | Номер телефона абонента (внутренний или внешний). |
extension string | Идентификатор внутреннего абонента. Может использоваться в качестве аргумента при вызове методов удаленных процедур. Для внешнего абонента содержит пустую строку. |
{ "time":"2017-03-15T17:05:34", "entire_id":"askozia-1489583124.183", "call_id":"askozia-1489583124.183", "state":"Finished", "from":{ "extension":"SIP/34", "number":"34" }, "to":{ "extension":"SIP/40", "number":"40" }, "status":"NOANSWER" }
Содержит подробную информацию о завершенном вызове.
{ "call_id":string, "started":string, "answered":string, "finished":string, "status":string, "from":object(Caller), "to":object(Caller), "call_flow":string, "conversation":integer, "duration":integer, "record_file":string }
Наименование поля | Описание |
---|---|
call_id string | Глобальный идентификатор вызова (в формате провайдера). |
started string | Дата и время начала вызова в формате RFC3339. |
answered string | Дата и время ответа на вызов в формате RFC3339. |
finished string | Дата и время завершения вызова в формате RFC3339. |
status string | Статус завершения вызова (в формате провайдера). |
from object(Caller) | Данные инициатора вызова. |
to object(Caller) | Данные вызываемого. |
call_flow string | Идентификатор маршрута, по которому исполнялся вызов на момент завершения. |
conversation integer | Продолжительность разговора в секундах (время от начала разговора и до его завершения). Если вызов находился на удержании (hold), то время удержания будет вычтено. |
duration integer | Продолжительность вызова в секундах. |
record_file string | Ссылка на файл записи разговора. |
Сообщает о подключении к вызову стороннего абонента. Абонент с правами супервизора может подключиться к произвольному звонку с целью подслушать или вмешаться в разговор.
{ "time":string, "entire_id":string, "call_id":string, "from":object(Caller), "to":object(Caller), "spy":object(Caller), "action":string }
Наименование поля | Описание |
---|---|
time string | Дата и время возникновения вызова в формате RFC3339. |
entire_id string | Глобальный идентификатор группы вызовов (в формате провайдера). Объединяет все вызовы, которые формируются в процессе переадресации звонка. |
call_id string | Глобальный идентификатор текущего вызова (в формате провайдера). |
from object(Caller) | Данные инициатора вызова. |
to object(Caller) | Данные вызываемого. |
spy object(Caller) | Данные подключившегося абонента (супервизора). |
action string | Действие выполняемое абонентом. Принимает следующие значения: Joined - подключился к вызову; Leave - отключился. |
{ "time":"2017-03-15T17:05:34", "entire_id":"askozia-1489583124.183", "call_id":"askozia-1489583124.183", "from":{ "extension":"SIP/34", "number":"34" }, "to":{ "extension":"SIP/40", "number":"40" }, "spy":{ "extension":"SIP/51", "number":"51" }, "action":"Joined" }
Сообщает об изменении статус регистрации на АТС добавочного номера.
{ "time":string, "extension":string, "number":string, "online":bool }
Наименование поля | Описание |
---|---|
time string | Дата и время возникновения события в формате RFC3339. |
extension string | Идентификатор внутреннего абонента. |
number string | Добавочный номер абонента. |
online bool | Статус регистрации добавочного номера. |
{ "time":"2017-03-15T17:05:34", "extension":"SIP/34", "number":"34", "online":true }
Инициирует вызов. Система сперва выполняет вызов инициатора. После установления соединения с инициатором выполняется попытка дозвона по заданному номеру телефона.
{ "from":object(Caller), "to_number":string }
Наименование поля | Описание |
---|---|
from object(Caller) | Данные инициатора вызова. Заполняется только поле «extension». |
to_number string | Номер вызываемого абонента (внутренний или внешний). |
{ "from":{ "extension":"SIP/34" }, "to_number":"40" }
{ "result":string }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
Принудительно завершает вызов.
{ "call_id":string }
Наименование поля | Описание |
---|---|
call_id string | Глобальный идентификатор вызова (в формате провайдера). |
{ "result":string }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
{ "call_id":"askozia-1489583124.183" }
Завершает разговор между текущими абонентами и переводит вызов на другой внутренний номер.
{ "call_id":string, "method":string, "to_number":string, "whom":object(Caller) }
Наименование поля | Описание |
---|---|
call_id string | Глобальный идентификатор вызова (в формате провайдера). |
method string | Метод перевода звонка: blind - без консультативный («слепой») перевод вызова; attended - консультативный (с удержанием) перевод звонка. |
to_number string | Номер вызываемого абонента (внутренний). |
whom object(Caller) | (Не обязательный) Данные абонента, которого нужно перевести. Заполняется только поле «extension». По умолчанию переводиться инициатор вызова. |
{ "result":string }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
{ "call_id":"askozia-1489583124.183", "method":"blind", "to_number":"28", "whom":{ "extension":"SIP/34" } }
Возвращает список активных вызовов.
Не имеет параметров.
{ "result":string, "no":integer, "total":integer, "data":{ "time":string, "entire_id":string, "call_id":string, "state":string, "from":object(Caller), "to":object(Caller), "line_number":string } }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
no integer | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. |
total integer | Общее количество сообщений с данными активных вызовов, которые будут отправлены. |
data array[object(Call)] | Информация о вызове. Подробное описание полей в разделе provider.v1.calls |
Возвращает данные о состоянии регистрации добавочных номеров.
Не имеет параметров.
{ "result":string, "no":integer, "total":integer, "data":{ "extension":string, "number":string, "online":bool } }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
no integer | Номер текущего сообщения отправленного в очередь. Каждое сообщение пронумеровано в интервале 1..[total]. |
total integer | Общее количество сообщений с данными активных вызовов, которые будут отправлены. |
data.extension string | Идентификатор внутреннего абонента. |
data.number string | Добавочный номер абонента. |
data.online bool | Статус регистрации добавочного номера. |
Присоединяет супервизора к звонку в режиме разговора или подслушивания.
{ "call_id":string, "method":string, "spy":object(Caller) }
Наименование поля | Описание |
---|---|
call_id string | Глобальный идентификатор вызова (в формате провайдера). |
method string | Метод присоединения к звонку: listen - подслушивание разговора; whisper - режим шепота коллеге (подключаемого слышит только внутренний абонент); interfere - вмешаться в разговор (слышат оба абонента). |
spy object(Caller) | Данные абонента, которого нужно подключить к разговору. Заполняется только поле «extension». |
{ "result":string }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
{ "call_id":"askozia-1489583124.183", "method":"listen", "spy":{ "extension":"SIP/34" } }
Отключает супервизора от звонка.
{ "call_id":string, "spy":object(Caller) }
Наименование поля | Описание |
---|---|
call_id string | Глобальный идентификатор вызова (в формате провайдера). |
spy object(Caller) | Данные абонента, которого нужно отключить. Заполняется только поле «extension». |
{ "result":string }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
{ "call_id":"askozia-1489583124.183", "spy":{ "extension":"SIP/34" } }
Воспроизводит запись разговора с помощью телефона абонента. Для абонента операция выглядит как входящий звонок.
{ "record":string, "listener":object(Caller) }
Наименование поля | Описание |
---|---|
record string | Cсылка на файл записи разговора. |
listener object(Caller) | Данные абонента, который будет прослушивать разговор. Заполняется только поле «extension». |
{ "result":string }
Наименование поля | Описание |
---|---|
result string | Результат выполнения команды. Содержит «Success» в случае успеха и описание ошибки в ином случае. |
{ "record":"/storage/usbdisk1/askoziapbx/callrecordings/40/askozia-1501854278.119_28_40_2017-08-04-17-44-38.gsm", "listener":{ "extension":"SIP/34" } }