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

Owned by Dmitri Savolainen
Last updated: Aug 28, 2020 by Asia Khalitova (Unlicensed)
1 min read

Мы обновили документацию, актуальная версия страницы доступна по ссылке: Голосовая почта (/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

Поля голосовых сообщений

Поля ресурса "Голосовая почта" совпадают с полями ресурса CDR, но в отличие от CDR, поля record_uuid и record_file_size никогда не принимают значения null.

Имя

Тип

Описание

client_owner_id

integer

Идентификатор клиента-владельца сообщения

dealer_owner_id

integer

Идентификатор дилера-владельца сообщения

dest_domain

string

Домен назначения вызова

dest_number

string

Номер назначения вызова

did_domain

string

Домен внешнего номера

did_number

string

Внешний номер

duration

integer

Длительность вызова

ext_number_reg

string

Зарегистрированный внешний номер

extension_group_owner_id

integer

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

extension_id

integer

Идентификатор добавочного

extension_name

string

Имя добавочного

extension_type

string

Тип добавочного

flow

string

Направление вызова. Может принимать значение "in" или "out"

from_domain

string

Исходный домен звонящего

from_screen_name

string

Исходное отображаемое имя звонящего

from_username

string

Исходное имя пользователя звонящего

hangup_cause

string

Причина окончания вызова

hangup_time_gmt

string

Время окончания вызова

init_time_gmt

string

Время инициализации вызова

record_file_size

integer

Размер файла сообщения в байтах

record_uuid

string

Идентификатор сообщения голосовой почты

result

string

Результат вызова

source_domain

string

Домен источника вызова

source_number

string

Номер источника вызова

start_time_gmt

string

Время начала вызова

to_domain

string

Исходный домен назначения

to_username

string

Исходный имя пользователя назначения

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

GET /client/{client_id}/voicemail/

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

Параметры URL

Имя

Тип

client_id

string

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

Имя

Тип

start_datetime

string

end_datetime

string

extension_group_id

integer

order

string

extension_id

integer

Поля ответа

Имя

Тип

to_username

string

source_number

string

result

string

duration

integer

hangup_time_gmt

string

dealer_owner_id

integer

to_domain

string

record_file_size

integer

from_username

string

start_time_gmt

string

ext_number_reg

string

hangup_cause

string

extension_group_owner_id

integer

init_time_gmt

string

dest_domain

string

record_uuid

string

from_domain

string

source_domain

string

extension_type

string

did_domain

string

from_screen_name

string

extension_name

string

flow

string

dest_number

string

extension_id

integer

did_number

string

client_owner_id

integer

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

Поля ответа

Имя

Тип

to_username

string

source_number

string

result

string

duration

integer

hangup_time_gmt

string

dealer_owner_id

integer

to_domain

string

record_file_size

integer

from_username

string

start_time_gmt

string

ext_number_reg

string

hangup_cause

string

extension_group_owner_id

integer

init_time_gmt

string

dest_domain

string

record_uuid

string

from_domain

string

source_domain

string

extension_type

string

did_domain

string

from_screen_name

string

extension_name

string

flow

string

dest_number

string

extension_id

integer

did_number

string

client_owner_id

integer

GET /extension_group/{ext_group_id}/voicemail/{record_uuid}

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

Параметры URL

Имя

Тип

record_uuid

string

ext_group_id

string

DELETE /extension_group/{ext_group_id}/voicemail/{record_uuid}

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

Параметры URL

Имя

Тип

record_uuid

string

ext_group_id

string

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

GET /extension/{extension_id}/voicemail/

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

Параметры URL

Имя

Тип

extension_id

string

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

Имя

Тип

start_datetime

string

order

string

end_datetime

string

Поля ответа

Имя

Тип

client_owner_id

integer

dealer_owner_id

integer

dest_domain

string

dest_number

string

did_domain

string

did_number

string

duration

integer

ext_number_reg

string

extension_group_owner_id

integer

extension_id

integer

extension_name

string

extension_type

string

flow

string

from_domain

string

from_screen_name

string

from_username

string

hangup_cause

string

hangup_time_gmt

string

init_time_gmt

string

record_file_size

integer

record_uuid

string

result

string

source_domain

string

source_number

string

start_time_gmt

string

to_domain

string

to_username

string

GET /extension/{extension_id}/voicemail/{record_uuid}

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

Параметры URL

Имя

Тип

record_uuid

string

extension_id

string

Похожие разделы