Инициация вызова (/callback/)

Мы обновили документацию, актуальная версия страницы доступна по ссылке: Инициация вызова (/callback/)

Ресурс инициации вызова позволяет с помощью API инициировать вызов между номерами. После успешного API-запроса, системой вызываются все номера-источники вызова, а после поднятия трубки одним из них начинает вызваться номер назначения.


Имя

Тип

Обязательный

Значение по умолчаниюОписание

allow_public_transfer

boolean

нет

falseРазрешать перевод вызова при звонке на внешний номер

src_num

array [string]

да


Массив номеров-источников вызова, например, список добавочных и/или мобильных номеров. Тут не могут быть указаны добавочные типа "очередь", "ivr". Номера из массива вызываются без учета правил входящего вызова.

call_duration

integer

нет

Системное значениеМаксимальная продолжительность разгвора в секундах

caller_id_number

string

нет


Номер звонящего. Если значение не будет задано, будет использован номер добавочного, от имени которого инициируется вызов.

caller_id_name

string

нет


Имя звонящего. Если значение не будет задано, будет использовано имя добавочного, от имени которого инициируется вызов.
src_caller_id_numberstringнет
Номер звонящего, который будет передан на номера из src_num. Если значение не будет задано, будет использован параметр caller_id_number. Если caller_id_number не задан, будет использован номер добавочного, от имени которого инициируется вызов.
src_caller_id_namestringнет
Имя звонящего, которое будет передано на номера из src_num. Если значение не будет задано, будет использован параметр caller_id_name. Если caller_id_name не задан, будет использовано имя добавочного, от имени которого инициируется вызов.

dst_ani

stringнет

Номер из списка внешних номеров клиента, который будет передан в качестве АОНа при вызове dst_num

В случае указания номера не из списка did будет проигнорирован.

dst_num

string

да


Номер назначения вызова. В отличии от src_num, тут отрабатывают все правила входящего вызова для номера и могут быть указыны очереди, ivr

announce_sound_id

integer

нет



Идентификатор звука, который проиграется при поднятии трубки номером-источником до того, как начнет вызываться номер назначения
dst_announce_sound_idinteger

нет


Идентификатор звука, который проиграется при поднятии трубки на вызываемой стороне, будет слышен всем участникам разговора

wait_for_pickup

integer

нет


Системное значение

Максимальное время ожидания снятия трубки в секундах.

Сначала ожидается снятие трубки номерами-источниками, затем ожидается снятие трубки на номере-назначениии dst-num. Если на dst-num проиграется early-media то с момента проигрывания early-media возобновится таймер времени ожидания wait_for_pickup

Если за время wait_for_pickup трубка не снята- вызов не будет совершен (в случае передачи параметров transfer_after_* рекомендуется дожидаться истечения таймеров wait_for_pickup)


dst_dtmfstringнет
Последовательность DTMF-тонов, которые будут переданы номеру dst_num, как только вызов dst_num будет отвечен. Допустимы цифры 0123456789*#, а также символы W и w. W – пауза длиной в одну секунду, w – пауза длинной в полсекунды.
call_api_idstringда
Возвращается в ответ на запрос callback. Используется для возможности последующего управления вызовом
call_idstringда

Возвращается в ответ на запрос callback и является его идентификатором. По нему можно фильтровать события, относящиеся к данному callback, получать отчеты по его результатам.

Является синонимом call_uuid для ресурса истории вызов.

transfer_after_dst_hangupstringнет
Номер, куда система переведет вызов если сторона инициации вызова src_num останется последней в разговоре.
transfer_after_src_hangupstringнет
Номер, куда система переведет вызов если сторона назначения dst_num останется последней в разговоре.

Результат callback

После инициации вызова, используя параметр ответа "call_id", запросом на ресурс call_history можно получить его результат через
GET /client/{client_id}/call_history/{call_uuid}
указав "call_id" в качестве "{call_uuid}"

Ресурсы раздела "Добавочный"

POST /extension/{extension_id}/callback/

Инициировать вызов. Указанный в пути extension_id должен быть идентификатором добавочного типа phone.

Параметры URL

Имя

Тип

extension_id

string

Параметры JSON

Имя

Тип

Обязательный

allow_public_transfer

boolean

нет

src_num

array [string]

да

call_duration

integer

нет

caller_id_number

string

нет

caller_id_name

string

нет

src_caller_id_numberstring

нет

src_caller_id_namestring

нет

dst_num

string

да

announce_sound_id

integer

нет

wait_for_pickup

integer

нет

dst_dtmfstringнет

Поля ответа

Имя

Тип

call_api_id

stringz

call_id

string