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

На данной странице описаны ресурсы сообщений и чатов, а также указаны параметры событий (/event/) сообщений.

Table of Contents

Сообщения

Ресурс управления сообщениями внутреннего номера. С помощью ресурса /message/ можно:

Отправить сообщение — POST /extension/{extension_id}/message/send/
Получить сообщения (статистика) — GET /extension/{extension_id}/message/, либо конкретное сообщение по id — GET /extension/{extension_id}/message/{message_id}
Пометить сообщение (прочитано или нет) — PUT /extension/{extension_id}/message/{message_id}
Удалить сообщение — DELETE /extension/{extension_id}/message/{message_id}

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

Expand

title	Развернуть

Имя	Тип	Описание
chat_id	string	Идентификатор чата
dst_num	string	Номер получателя сообщения
extension_id	integer	Идентификатор внутреннего номера
flow	string	Направление сообщения (out, in)
id	string	Идентификатор Уникальный идентификатор сообщения
init_time_gmt	string	Время получения или отправки сообщения
read	boolean	Значение true – если сообщения прочитано, false – если нет
src_num	string	Номер отправителя сообщения
status	string	Статус сообщения
text	string	Текст сообщения

События сообщений

События сообщений настраиваются аналогично другим событиям внутреннего номера (message-in, message-out).

Событие message-in

Имя	Тип	Описание
extension_name	string	Имя вызываемого внутреннего номера (в виде xxx*yyy@domain)
did_number	string	Публичный номер вызываемого абонента, на котором выполнена настройка приема сообщений
src_number	string	Номер отправителя сообщения
extension_id	integer	Идентификатор внутреннего номера
chat_id	string	Идентификатор чата
message_id	string	Уникальный идентификатор сообщения
text	string	Текст сообщения

Событие message-out

Имя	Тип	Описание
extension_name	string	Имя вызываемого внутреннего номера (в виде xxx*yyy@domain)
src_number	string	Публичный номер абонента (DID), на котором выполнена настройка приема сообщений
extension_id	int	Идентификатор внутреннего номера
chat_id	string	Идентификатор чата
message_id	string	Уникальный идентификатор сообщения
dst_number	string	Номер получателя сообщения
text	string	Текст сообщения

Событие message-out-status аналогично событию message-out, за исключением

Имя	Тип	Описание
extension_name	string	Имя вызываемого внутреннего номера (в виде xxx*yyy)
status	string	статус отправки сообщения, может быть либо sent, либо failed
chat_id	string	Идентификатор чата
message_id	string	Уникальный идентификатор сообщения

Сообщения и SIP MESSAGE

При входящем сообщении (message-in) на оборудование внутренних номеров типа ‘phone’ дублируется SIP MESSAGE, и его можно прочитать на устройстве, если устройство внутреннего номера типа ‘phone’ поддерживает SIP MESSAGE.
Поддерживаются исходящие SIP MESSAGE с оборудования внутренних номеров типа ‘phone’.
В чаты не попадает обмен SIP MESSAGE внутри АТС.

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

Expand

title	GET /extension/{extension_id}/message/

GET /extension/{extension_id}/message/

Запросить сообщения внутреннего номера

Параметры URL

Имя	Тип
extension_id	string

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

Имя	Тип
start_datetime	string
src_num	string
dst_num	string
end_datetime	string
per_page	integer
page	integer
order	string

Параметры ответа

Имя	Тип
chat_id	string
dst_num	string
extension_id	integer
flow	string
id	string
init_time_gmt	string
read	boolean
src_num	string
status	string
text	string

Expand

title	POST /extension/{extension_id}/message/send/

POST /extension/{extension_id}/message/send/

Отправить сообщение

Параметры URL

Имя	Тип
extension_id	string

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

Имя	Тип
dst_num	string
src_num	string
text	string

Параметры ответа

Имя	Тип
chat_id	string
id	string
status	string

Expand

title	GET /extension/{extension_id}/message/{message_id}

GET /extension/{extension_id}/message/{message_id}

Получить(прочитать) сообщение

Параметры URL

Имя	Тип
extension_id	string
message_id	string

Параметры ответа

Имя	Тип
chat_id	string
dst_num	string
extension_id	long
flow	string
id	string
init_time_gmt	string
read	boolean
src_num	string
status	string
text	string

Expand

title	PUT /extension/{extension_id}/message/{message_id}

PUT /extension/{extension_id}/message/{message_id}

Пометить сообщение прочтенным

Параметры URL

Имя	Тип
extension_id	string
message_id	string

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

Имя	Тип
read	boolean

Параметры ответа

Имя	Тип
chat_id	string
dst_num	string
extension_id	long
flow	string
id	string
init_time_gmt	string
read	boolean
src_num	string
status	string
text	string

Expand

title	DELETE /extension/{extension_id}/message/{message_id}

DELETE /extension/{extension_id}/message/{message_id}

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

Параметры URL

Имя	Тип
extension_id	string
message_id	string

Чаты

С помощью ресурса /chat/ можно:

Получить список чатов — GET /extension/{extension_id}/chat/
Получить информацию о последних сообщениях чата — GET /extension/{extension_id}/chat/{chat_id}
Удалить чат — DELETE /extension/{extension_id}/chat/{chat_id}
Получить список сообщений чата — GET /extension/{extension_id}/chat/{chat_id}/messages/
Пометить прочитанными сообщения чата — PUT /extension/{extension_id}/chat/{chat_id}/messages/
Удалить все сообщения чата — DELETE /extension/{extension_id}/chat/{chat_id}/messages/

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

Expand

title	Развернуть

Имя	Тип	Описание
count_new	long	Счетчик непрочитанных сообщений
id	string	Идентификатор чата
last_message_id	string	Идентификатор последнего сообщения
last_message_init_time_gmt	string	Время получения или отправки последнего сообщения
last_message_text	string	Текст последнего сообщения
remote_number	string	Номер собеседника в чате

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

Expand

title	GET /extension/{extension_id}/chat/

GET /extension/{extension_id}/chat/

Получить список чатов

Параметры URL

Имя	Тип
extension_id	string

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

Имя	Тип
remote_number	string
per_page	integer
page	integer
order	string

Параметры ответа

Имя	Тип
count_new	long
id	string
last_message_id	string
last_message_init_time_gmt	string
last_message_text	string
remote_number	string

Expand

title	GET /extension/{extension_id}/chat/{chat_id}

GET /extension/{extension_id}/chat/{chat_id}

Получить информацию о последних сообщениях чата

Параметры URL

Имя	Тип
extension_id	string
chat_id	string

Параметры ответа

Имя	Тип
count_new	long
id	string
last_message_id	string
last_message_init_time_gmt	string
last_message_text	string
remote_number	string

Expand

title	DELETE /extension/{extension_id}/chat/{chat_id}

DELETE /extension/{extension_id}/chat/{chat_id}

Удалить чат

Параметры URL

Имя	Тип
extension_id	string
chat_id	string

Expand

title	GET /extension/{extension_id}/chat/{chat_id}/messages/

GET /extension/{extension_id}/chat/{chat_id}/messages/

Получить список сообщений чата

Параметры URL

Имя	Тип
extension_id	string
chat_id	string

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

Имя	Тип
start_datetime	string
src_num	string
dst_num	string
end_datetime	string
per_page	integer
page	integer
order	string

Параметры ответа

Имя	Тип
chat_id	string
dst_num	string
extension_id	long
flow	string
id	string
init_time_gmt	string
read	boolean
src_num	string
status	string
text	string

Expand

title	PUT /extension/{extension_id}/chat/{chat_id}/messages/

PUT /extension/{extension_id}/chat/{chat_id}/messages/

Установить сообщения чата в "прочитано"

Параметры URL

Имя	Тип
extension_id	string
chat_id	string

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

Имя	Тип
read	boolean

Параметры ответа

Имя	Тип
id	string
read	boolean

Expand

title	DELETE /extension/{extension_id}/chat/{chat_id}/messages/

DELETE /extension/{extension_id}/chat/{chat_id}/messages/

Удалить сообщения чата

Параметры URL

Имя	Тип
extension_id	string
chat_id	string

Versions Compared

Old Version 4

New Version Current

Key

Сообщения

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

События сообщений

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

Чаты

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

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

Page Comparison

Versions Compared

Old Version 4

New Version Current

Key

Сообщения

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

События сообщений

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

Чаты

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

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