Мы обновили документацию, актуальная версия страницы доступна по ссылке: Сообщения (/message/) и чаты (/chat/)

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

Сообщения /message/

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

Отправить cообщение методом 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}

Чаты /chat/

С помощью ресурса /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/

Подробное описание ресурса:

Событие message-in

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

Имя	Тип	Описание
extension_name	`string`	Имя вызываемого добавочного (в виде xxx*yyy@domain)
did_number	`string`	Публичный номер вызываемого абонента, в котором выполнена настройка приема сообщений.
src_number	`string`	Номер вызывающего абонента
extension_id	`int`	Идентификатор (id) добавочного extension name
text	`string`	Текст сообщения

Событие message-out

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

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

GET /extension/{extension_id}/message/

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

Параметры URL

Name	Type	Description
extension_id	string	id добавочного

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

Name	Type	Description
start_datetime	string	начало даты запроса в формате %Y-%m-%d %H:%M:%S
src_num	string	фильтр по номеру источника
dst_num	string	фильтр по номеру назначения
end_datetime	string	конец даты запроса в формате %Y-%m-%d %H:%M:%S
per_page	integer	желаемое количество сообщений в ответе на один запрос
page	integer	номер страницы (нужен при указании per_page)
order	string	asc, либо desc

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

Name	Type	Description
chat_id	string	id чата
dst_num	string	Номер получателя сообщения
extension_id	integer	id добавочного
flow	string	Направление (out, in)
id	string	id сообщения
init_time_gmt	string	Время получения, либо отправки сообщения
read	`boolean`	True если прочитано, False если нет
src_num	string	Номер отправителя сообщения
status	string	Статус сообщения
text	string	Текст сообщения

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

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

Параметры URL

Name	Type	Description
`extension_id`	`string`	id добавочного

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

Name	Type	Description
`dst_num`	`string`	Номер получателя сообщения
src_num	`string`	Номер отправителя сообщения
text	`string`	Текст сообщения для отправки

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

Name	Type	Description
`chat_id`	`string`	id чата
id	`string`	id сообщения
status	`string`	Статус отправки сообщения

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

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

Параметры URL

Name	Type	Description
`extension_id`	`string`	id добавочного
message_id	`string`	id сообщения

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

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

Параметры URL

Name	Type	Description
extension_id	string	id добавочного
message_id	string	id сообщения

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

Name	Type	Description
chat_id	string	id чата
`dst_num`	string	Номер получателя сообщения
`extension_id`	integer	id добавочного
`flow`	string	Направление (out, in)
id	string	id сообщения
init_time_gmt	string	Время получения, либо отправки сообщения
read	`boolean`	True если прочитано, False если нет
src_num	string	Номер отправителя сообщения
status	string	Статус сообщения
text	string	Текст сообщения

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

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

Параметры URL

Name	Type	Description
extension_id	string	id добавочного
message_id	string	id сообщения

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

Name	Type	Description
`read`	`boolean`	True - установить в "прочитано"

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

Name	Type	Description
chat_id	string	id чата
dst_num	string	Номер получателя сообщения
extension_id	integer	id добавочного
flow	string	Направление (out, in)
id	string	id сообщения
init_time_gmt	string	Время получения, либо отправки сообщения
read	`boolean`	True если прочитано, False если нет
src_num	string	Номер отправителя сообщения
status	string	Статус сообщения
text	string	Текст сообщения

GET /extension/{extension_id}/chat/

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

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

Name	Type	Description
`extension_id`	`string`	id добавочного
remote_number	`string`	Фильтр по номеру
`per_page`	integer	желаемое количество сообщений в ответе на один запрос
page	integer	номер страницы (нужен при указании per_page)

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

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

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

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

Параметры URL

Name	Type	Description
`extension_id`	`string`	id добавочного
`chat_id`	`string`	id чата

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

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

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

Удалить чат

Параметры URL

Name	Type	Description
`extension_id`	`string`	id добавочного
`chat_id`	`string`	id чата

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

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

Параметры URL

Name	Type	Description
`extension_id`	`string`	id добавочного
`chat_id`	`string`	id чата

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

Name	Type	Description
start_datetime	string	начало даты запроса в формате %Y-%m-%d %H:%M:%S
src_num	string	фильтр по номеру источника
dst_num	string	фильтр по номеру назначения
end_datetime	string	конец даты запроса в формате %Y-%m-%d %H:%M:%S
per_page	integer	желаемое количество сообщений в ответе на один запрос
page	integer	номер страницы (нужен при указании per_page)
order	string	asc, либо desc

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

Name	Type	Description
chat_id	string	id чата
dst_num	string	Номер получателя сообщения
extension_id	integer	id добавочного
flow	string	Направление (out, in)
id	string	id сообщения
init_time_gmt	string	Время получения, либо отправки сообщения
read	`boolean`	True если прочитано, False если нет
src_num	string	Номер отправителя сообщения
status	string	Статус сообщения
text	string	Текст сообщения

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

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

Параметры URL

Name	Type	Description
extension_id	string	id добавочного
`chat_id`	string	id чата

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

Name	Type	Description
`read`	`boolean`	True - установить в "прочитано"

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

Name	Type	Description
chat_id	string	id чата
dst_num	string	Номер получателя сообщения
extension_id	integer	id добавочного
flow	string	Направление (out, in)
id	string	id сообщения
init_time_gmt	string	Время получения, либо отправки сообщения
read	`boolean`	True если прочитано, False если нет
src_num	string	Номер отправителя сообщения
status	string	Статус сообщения
text	string	Текст сообщения

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

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

Параметры URL

Name	Type	Description
`extension_id`	`string`	id добавочного
`chat_id`	`string`	id чата

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

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

Поддерживаются исходящие SIP MESSAGE сообщения с оборудования добавочных типа phone

В чаты не попадают обмен SIP MESSAGE внутри АТС