...
...
...
| Warning |
|---|
Мы обновили документацию, актуальная версия страницы доступна по ссылке: События внутреннего номера (/extension/.../event/) |
С помощью ресурса можно оповещать сторонние приложения о событиях на добавочном. Количество отслеживаемых событий лимитировано, лимит может быть получено через ресурс лимитов.
...
В случае, когда методом запроса является GET, данные будут содержаться в заголовке запроса, если же методом запроса является POST, данные будут содержаться в теле запроса. В обоих случаях данные находятся в формате application/x-www-form-urlencoded.
Имя | Тип | Описание |
|---|---|---|
EventType |
| Тип события. Может принимать значния dial-in, dial-out, hangup или answer в зависимости от типа события. |
CallID |
| Уникальный идентификатор вызова. Не меняется при переадресациях. Можно использовать для идентификации принадлежности различных событий одному вызову. |
CallerIDNum |
| Номер вызывающего абонента |
CallerIDName |
| Имя вызывающего абонента (если есть). |
| CalledDID | string | Публичный номер вызываемого абонента (если есть) |
| CalledExtension | string | Имя вызываемого добавочного (в виде xxx*yyy@domain) |
| CalledExtensionID | int | Идентификатор добавочного CalledExtension. Удобен для последующих вызовов API, ожидающих идентификатор |
| CallStatus | string | Статус вызова. Для event_type 'dial-in' и 'dial-out' :
Для event_type 'answer' :
Для event_type 'hangup':
|
| CallFlow | string | Направление вызова:
|
| CallerExtension | string | добавочный, с которого произведен вызов (в виде xxx*yyy@domain) |
| CallerExtensionID | int | Идентификатор добавочного CallerExtension. Удобен для последующих вызовов API, ожидающих идентификатор |
| CalledNumber | string | вызываемый номер |
| RecID | string | Если на добавочном включена запись разговоров, то тут содержится ее идентификатор. Эквивалентно record_uuid в REST API. По нему можно получить файл записи. Имеет смысл только в событии "hangup" |
| CallAPIID | string | Уникальный идентификатор вызова для управления им (например, обрыв, перевод, парковка). |
| Diversion | string | номер из одноименного поля протокола SIP при поступлении звонка на АТС (rfc5806). Опционально (присутствуют только при наличии в заголовках SIP). Обычно показывает номер, с которого была сделана переадресация до прихода вызова в АТС. |
| EventTime | int | время генерации события: микросекунды c 1 января 1970 года. |
| Duration | int | Для события "hangup" содержит время разговора в микросекундах |
| Transfered | string | Поле может отсутствовать. При налиичии в событиях CallFlow=out позволяет отличать вызовы, инициированные добавочным, от вызовов, переадресованных с добавочного:
|
| Bridged | string | Присутствует в событиях очередей (CallFlow='in') и голосовых меню (IVR):
|
| CallBackID | string | Присутствует при инициации вызова. Может быть полезен для определения принадлежности множества событий к одной инициации вызова. |
| SubCallID | string | В отличии от параметра "CallID", одинакового для всего вызова, позволяет выделить в звонке составную часть. Например, если в пределах одного вызова звонок приходил на один добавочный несколько раз (например, несколько раз по кругу, как агент очереди), то этот параметр будет отличаться. Полезен для группировки dial-in, dial-out, answer, hangup составной части вызова. |
| ClientApiID | string | Необязательный параметр. Включает содержимое SIP заголовка "Client-Api-Id" при формировании вызова на стороне клиента. Удобно использовать для соотношения событий со звонками, инициированными оборудованием клиента. Длина SIP заголовка не должна превышать 100 символов: например, "Client-Api-Id: 1234567Az" |
| RemoteNumber | string | Необязательный параметр. Присутствует при входящих вызовах, если "CallerIDNum" не совпадает с номером, с которым устанавливается соединение(например, при трансфере исходящего вызова с одного добавочного на другой). |
| ANI | string | Необязательный параметр. Для исходящих вызовов (CallFlow=out) на номера вне АТС (например, мобильные), позволяет определить, какой номер был установлен для идентификации. |
...