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