Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Протестировать методы API можно на странице интерактивного обозревателя и без написания кода

...

Warning

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

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

Table of Contents
maxLevel2

...

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

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

...

Удалить сообщение DELETE /extension/{extension_id}/message/{message_id}

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

Table of Contents
maxLevel3
minLevel3

...

Чаты /chat/

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

...

Table of Contents
maxLevel4
minLevel4

Событие message-in

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


Имя

Тип

Описание

extension_name

string

Имя вызываемого добавочного (в виде xxx*yyy@domain)

did_number

string

Публичный номер вызываемого абонента, в котором выполнена настройка приема сообщений.
src_number

string

Номер вызывающего абонента
extension_idintИдентификатор (id) добавочного extension name
text

string

Текст сообщения

Событие message-out

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

Имя

Тип

Описание

extension_name

string

Имя вызываемого добавочного (в виде xxx*yyy@domain)

src_number

string

Публичный номер абонента (DID), в котором выполнена настройка приема сообщений.
extension_idintИдентификатор (id) добавочного extension name
dst_numberstringВызываемый номер
text

string

Текст сообщения

GET /extension/{extension_id}/message/

...

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