Протестировать методы API можно на странице интерактивного обозревателя и без написания кода
...
Warning |
---|
Мы обновили документацию, актуальная версия страницы доступна по ссылке: Сообщения (/message/) и чаты (/chat/) |
На данной странице описаны ресурсы сообщений (message) и чатов (chat), а также указаны параметры событий (events) сообщений.
...
Table of Contents | ||||
---|---|---|---|---|
|
Чаты /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/
Подробное описание ресурса:
Table of Contents maxLevel 4 minLevel 4
Событие message-in
События сообщений настраиваются аналогично другим событиям телефонного добавочного (message-in, message-out).
...
Имя | Тип | Описание |
---|---|---|
extension_name |
| Имя вызываемого добавочного (в виде xxx*yyy@domain) |
src_number |
| Публичный номер абонента (DID), в котором выполнена настройка приема сообщений. |
extension_id | int | Идентификатор (id) добавочного extension name |
dst_number | string | Вызываемый номер |
text |
| Текст сообщения |
Чаты /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/
...
сообщения |
...
Удалить все сообщения чата методом DELETE /extension/{extension_id}/chat/{chat_id}/messages/
Подробное описание ресурса:
Table of Contents maxLevel 4 minLevel 4
GET /extension/{extension_id}/message/
...
При входящем сообщении (message-in) на оборудование добавочных типа phone дублируется SIP MESSAGE и его можно прочитать на устройстве, если устройство добавочного типа phone поддерживает SIP MESSAGE.
Исходящие сообщения с устройств на данный момент не поддерживаются.Поддерживаются исходящие SIP MESSAGE сообщения с оборудования добавочных типа phone
В чаты не попадают обмен SIP MESSAGE внутри АТС