Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

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

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

На данной странице описаны ресурсы сообщений (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}

Событие 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

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

Ресурсы /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/

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

GET /extension/{extension_id}/message/

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

Параметры URL

Name

Type

Description

extension_idstringid добавочного


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

Name

Type

Description

start_datetimestringначало даты запроса в формате  %Y-%m-%d %H:%M:%S
src_numstringфильтр по номеру источника
dst_numstringфильтр по номеру назначения
end_datetimestringконец даты запроса в формате  %Y-%m-%d %H:%M:%S
per_pageintegerжелаемое количество сообщений в ответе на один запрос
pageintegerномер страницы (нужен при указании per_page)
orderstringasc, либо desc


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

Name

Type

Description

chat_idstringid чата
dst_numstringНомер получателя сообщения
extension_idintegerid добавочного
flowstringНаправление (out, in)
idstringid сообщения
init_time_gmtstringВремя получения, либо отправки сообщения
readbooleanTrue если прочитано, False если нет
src_numstringНомер отправителя сообщения
statusstringСтатус сообщения
textstringТекст сообщения

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

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


Параметры URL

Name

Type

Description

extension_id

string

id добавочного


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

Name

Type

Description

dst_num

string

Номер получателя сообщения

src_numstringНомер отправителя сообщения
textstringТекст сообщения для отправки


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

Name

Type

Description

chat_id

string

id чата

idstringid сообщения
statusstringСтатус отправки сообщения

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

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


Параметры URL

Name

Type

Description

extension_id

string

id добавочного

message_idstringid сообщения

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

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


Параметры URL

Name

Type

Description

extension_idstringid добавочного
message_idstringid сообщения


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

Name

Type

Description

chat_idstringid чата

dst_num

stringНомер получателя сообщения
extension_idintegerid добавочного
flowstringНаправление (out, in)
idstringid сообщения
init_time_gmtstringВремя получения, либо отправки сообщения
readbooleanTrue если прочитано, False если нет
src_numstringНомер отправителя сообщения
statusstringСтатус сообщения
textstringТекст сообщения


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

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


Параметры URL

Name

Type

Description

extension_idstringid добавочного
message_idstringid сообщения


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

Name

Type

Description

read

boolean

True - установить в "прочитано"


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

Name

Type

Description

chat_idstringid чата
dst_numstringНомер получателя сообщения
extension_idintegerid добавочного
flowstringНаправление (out, in)
idstringid сообщения
init_time_gmtstringВремя получения, либо отправки сообщения
readbooleanTrue если прочитано, False если нет
src_numstringНомер отправителя сообщения
statusstringСтатус сообщения
textstringТекст сообщения


GET /extension/{extension_id}/chat/

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


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

Name

Type

Description

extension_id

string

id добавочного

remote_numberstringФильтр по номеру
per_pageintegerжелаемое количество сообщений в ответе на один запрос
pageintegerномер страницы (нужен при указании per_page)


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

Имя

Тип

Описание

count_new

integer

Счетчик непрочитанных сообщений
idstringid чата

last_message_id

string

id последнего сообщения

last_message_init_time_gmt

string

время получения, либо отправки, последнего сообщения
last_message_textstringтекст последнего сообщения
remote_numberstringномер собеседника в чате

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

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


Параметры URL

Name

Type

Description

extension_id

string

id добавочного

chat_id

string

id чата


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

Имя

Тип

Описание

count_new

integer

Счетчик непрочитанных сообщений
idstringid чата

last_message_id

string

id последнего сообщения

last_message_init_time_gmt

string

время получения, либо отправки, последнего сообщения
last_message_textstringтекст последнего сообщения
remote_numberstringномер собеседника в чате

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_datetimestringначало даты запроса в формате  %Y-%m-%d %H:%M:%S
src_numstringфильтр по номеру источника
dst_numstringфильтр по номеру назначения
end_datetimestringконец даты запроса в формате  %Y-%m-%d %H:%M:%S
per_pageintegerжелаемое количество сообщений в ответе на один запрос
pageintegerномер страницы (нужен при указании per_page)
orderstringasc, либо desc


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

Name

Type

Description

chat_idstringid чата
dst_numstringНомер получателя сообщения
extension_idintegerid добавочного
flowstringНаправление (out, in)
idstringid сообщения
init_time_gmtstringВремя получения, либо отправки сообщения
readbooleanTrue если прочитано, False если нет
src_numstringНомер отправителя сообщения
statusstringСтатус сообщения
textstringТекст сообщения

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

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


Параметры URL

Name

Type

Description

extension_idstringid добавочного
chat_idstringid чата


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

Name

Type

Description

read

boolean

True - установить в "прочитано"


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

Name

Type

Description

chat_idstringid чата
dst_numstringНомер получателя сообщения
extension_idintegerid добавочного
flowstringНаправление (out, in)
idstringid сообщения
init_time_gmtstringВремя получения, либо отправки сообщения
readbooleanTrue если прочитано, False если нет
src_numstringНомер отправителя сообщения
statusstringСтатус сообщения
textstringТекст сообщения

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

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


Параметры URL

Name

Type

Description

extension_id

string

id добавочного

chat_id

string

id чата

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

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

Исходящие сообщения с устройств на данный момент не поддерживаются.


  • No labels