Голосовая почта (/voicemail/)

_{Протестировать методы API можно на странице}_{интерактивного обозревателя API}_{и без написания кода}
_{Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см.}_{Создание и авторизация приложений}₎

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

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

1 Описание структур данных
2 Получение списка голосовых сообщений
3 Пример
4 Ресурсы раздела "Клиент"
5 Ресурсы раздела "Группа внутренних номеров”
6 Ресурсы раздела "Внутренний номер”

Описание структур данных

Поля ресурса "Голосовая почта" совпадают с полями ресурса “Информация о составных частях вызова (/cdr/)”, но, в отличие от CDR, поля record_uuid и record_file_size никогда не принимают значения “null”.

Имя	Тип	Описание

Имя	Тип	Описание
ani_number	string	Номер из списка входящих номеров клиента
application	string	Приложение, характеризующее тип вызова. Может иметь значение callcenter, callback, intercept или null
call_uuid	string	Уникальный идентификатор вызова
client_owner_id	long	Идентификатор клиента-владельца сообщения
dest_domain	string	Домен назначения вызова
dest_number	string	Номер назначения вызова
did_domain	string	Домен внешнего номера
did_number	string	Внешний номер
duration	long	Длительность вызова
ext_number_reg	string	Зарегистрированный внешний номер
extension_group_owner_id	long	Идентификатор группы внутренних номеров, владеющей сообщением
extension_id	long	Идентификатор внутреннего номера
extension_name	string	Имя внутреннего номера
extension_type	string	Тип внутреннего номера
flow	string	Направление вызова. Может принимать значение in или out
from_domain	string	Исходный домен вызывающего абонента
from_screen_name	string	Исходное отображаемое имя вызывающего абонента
from_username	string	Исходное имя пользователя вызывающего абонента
hangup_cause	string	Причина окончания вызова
hangup_disposition	string	Используется для определения инициатора разрыва соединения: callee_bye: трубку положила принимающая сторона; caller_bye: трубку положила вызывающая сторона; caller_cancel: вызывающая сторона отказалась ждать ответа; callee_refuse: принимающая сторона отказалась отвечать (была занята, отсутствовала регистрация и т.п.); internal_cancel: вызов завершен сервером (обычно по тайм-ауту вызова или если данный вызовов был принят другим внутренним номером); '' (пустой вариант): не удалось определить
hangup_time_gmt	string	Время окончания вызова
init_time_gmt	string	Время инициализации вызова
record_file_size	long	Размер файла сообщения в байтах
record_uuid	string	Идентификатор сообщения голосовой почты
result	string	Результат вызова
source_domain	string	Домен источника вызова
source_number	string	Номер источника вызова
start_time_gmt	string	Время начала вызова
to_domain	string	Исходный домен назначения
to_username	string	Исходное имя пользователя назначения
storage_url	string	Ссылка на файл с записью voicemail

Получение списка голосовых сообщений

Интервал получения и удаления списка сообщений голосовой почты указывается параметрами запроса start_datetime и end_datetime. Интервал времени должен находится в пределах двух месяцев. Для получения данных за больший период следует делать несколько запросов. При получении списка возможно указать параметр запроса order, который задает направление, в котором результирующий список будет отсортирован по полю init_time_gmt.

Параметры запроса

Имя	Тип	Обязательный	Значение по умолчанию

Имя	Тип	Обязательный	Значение по умолчанию
start_datetime	YYYY-MM-DD HH:MM:SS	да
end_datetime	YYYY-MM-DD HH:MM:SS	да
order	asc or desc	нет	desc

Пример

Получим список голосовых сообщений клиента за период:

Ответ системы:

[]

Ресурсы раздела "Клиент"

GET /client/{client_id}/voicemail/

Получить список голосовых сообщений за период

Параметры URL

Имя	Тип

Имя	Тип
client_id	string

Параметры запроса

Имя	Тип

Имя	Тип
start_datetime	string
end_datetime	string
extension_group_id	integer
order	string
extension_id	integer

Поля ответа

Имя	Тип

Имя	Тип
ani_number	string
application	string
call_uuid	string
client_owner_id	long
dest_domain	string
dest_number	string
did_domain	string
did_number	string
duration	long
ext_number_reg	string
extension_group_owner_id	long
extension_id	long
extension_name	string
extension_type	string
flow	string
from_domain	string
from_screen_name	string
from_username	string
hangup_cause	string
hangup_disposition	string
hangup_time_gmt	string
init_time_gmt	string
record_file_size	long
record_uuid	string
result	string
source_domain	string
source_number	string
start_time_gmt	string
to_domain	string
to_username	string
storage_url	string

GET /client/{client_id}/voicemail/{record_uuid}

Получить файл голосового сообщения

Параметры URL

Имя	Тип

Имя	Тип
record_uuid	string
client_id	string

DELETE /client/{client_id}/voicemail/{record_uuid}

Удалить голосовое сообщение

Параметры URL

Имя	Тип

Имя	Тип
record_uuid	string
client_id	string

Ресурсы раздела "Группа внутренних номеров”

GET /extension_group/{ext_group_id}/voicemail/

Получить список голосовых сообщений за период

Параметры URL

Имя	Тип

Имя	Тип
ext_group_id	string

Параметры запроса

Имя	Тип

Имя	Тип
end_datetime	string
start_datetime	string
order	string
extension_id	integer

Поля ответа

Имя	Тип

Имя	Тип
ani_number	string
application	string
call_uuid	string
client_owner_id	long
dest_domain	string
dest_number	string
did_domain	string
did_number	string
duration	long
ext_number_reg	string
extension_group_owner_id	long
extension_id	long
extension_name	string
extension_type	string
flow	string
from_domain	string
from_screen_name	string
from_username	string
hangup_cause	string
hangup_disposition	string
hangup_time_gmt	string
init_time_gmt	string
record_file_size	long
record_uuid	string
result	string
source_domain	string
source_number	string
start_time_gmt	string
to_domain	string
to_username	string
storage_url	string

Описание структур данных

Получение списка голосовых сообщений

Пример

Ресурсы раздела "Клиент"

Ресурсы раздела "Группа внутренних номеров”

Ресурсы раздела "Внутренний номер”