Мы обновили документацию, актуальная версия страницы доступна по ссылке: Инициация вызова (/callback/) |
Ресурс инициации вызова позволяет с помощью API инициировать вызов между номерами. После успешного API-запроса, системой вызываются все номера-источники вызова, а после поднятия трубки одним из них начинает вызваться номер назначения.
Имя | Тип | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|---|
|
|
| false | Разрешать перевод вызова при звонке на внешний номер |
|
|
| Массив номеров-источников вызова, например, список добавочных и/или мобильных номеров. Тут не могут быть указаны добавочные типа "очередь", "ivr". Номера из массива вызываются без учета правил входящего вызова. | |
|
|
| Системное значение | Максимальная продолжительность разгвора в секундах |
|
|
| Номер звонящего. Если значение не будет задано, будет использован номер добавочного, от имени которого инициируется вызов. | |
|
|
| Имя звонящего. Если значение не будет задано, будет использовано имя добавочного, от имени которого инициируется вызов. | |
src_caller_id_number | string | нет | Номер звонящего, который будет передан на номера из src_num. Если значение не будет задано, будет использован параметр caller_id_number. Если caller_id_number не задан, будет использован номер добавочного, от имени которого инициируется вызов. | |
src_caller | string | нет | Имя звонящего, которое будет передано на номера из src_num. Если значение не будет задано, будет использован параметр caller_id_name. Если caller_id_name не задан, будет использовано имя добавочного, от имени которого инициируется вызов. | |
| string | нет | Номер из списка внешних номеров клиента, который будет передан в качестве АОНа при вызове dst_num В случае указания номера не из списка did будет проигнорирован. | |
|
|
| Номер назначения вызова. В отличии от src_num, тут отрабатывают все правила входящего вызова для номера и могут быть указыны очереди, ivr | |
|
|
| Идентификатор звука, который проиграется при поднятии трубки номером-источником до того, как начнет вызываться номер назначения | |
dst_announce_sound_id | integer |
| Идентификатор звука, который проиграется при поднятии трубки на вызываемой стороне, будет слышен всем участникам разговора | |
|
|
| Системное значение | Максимальное время ожидания снятия трубки в секундах. Сначала ожидается снятие трубки номерами-источниками, затем ожидается снятие трубки на номере-назначениии dst-num. Если на dst-num проиграется early-media то с момента проигрывания early-media возобновится таймер времени ожидания |
dst_dtmf | string | нет | Последовательность DTMF-тонов, которые будут переданы номеру dst_num, как только вызов dst_num будет отвечен. Допустимы цифры 0123456789*#, а также символы W и w. W – пауза длиной в одну секунду, w – пауза длинной в полсекунды. | |
call_api_id | string | да | Возвращается в ответ на запрос callback. Используется для возможности последующего управления вызовом | |
call_id | string | да | Возвращается в ответ на запрос callback и является его идентификатором. По нему можно фильтровать события, относящиеся к данному callback, получать отчеты по его результатам. Является синонимом call_uuid для ресурса истории вызов. | |
| transfer_after_dst_hangup | string | нет | Номер, куда система переведет вызов если сторона инициации вызова src_num останется последней в разговоре. | |
| transfer_after_src_hangup | string | нет | Номер, куда система переведет вызов если сторона назначения dst_num останется последней в разговоре. |
После инициации вызова, используя параметр ответа "call_id", запросом на ресурс call_history можно получить его результат через |
POST /extension/{extension_id}/callback/Инициировать вызов. Указанный в пути extension_id должен быть идентификатором добавочного типа phone.
Имя | Тип |
|---|---|
|
|
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
src_caller | string |
|
src_caller | string |
|
|
|
|
|
|
|
|
|
|
dst_dtmf | string | нет |
Имя | Тип |
|---|---|
|
|
|
|