Сообщения (/message/) и чаты (/chat/)

Owned by Asia Khalitova (Unlicensed)
Last updated: Jun 24, 2021 by Dmitri Savolainen
2 min read

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

Сообщения

Ресурс управления сообщениями внутреннего номера. С помощью ресурса /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}

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

Имя

Тип

Описание

Имя

Тип

Описание

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 внутри АТС.

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

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

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

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

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

Чаты

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

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

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