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 6 Next »

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

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

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



Ресурсы /message/

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

Отправить cообщение методом POST /extension/{extension_id}/message/send/

Получить сообщение методом GET /extension/{extension_id}/message/

Пометить сообщение (прочитано или нет) PUT /extension/{extension_id}/message/{message_id}

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

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


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

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Текст сообщения

Ресурсы /chat/

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

Получить список сообщения из чата методом GET /extension/{extension_id}/chat/


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

а также удалить все сообщения из чата.

GET /extension/{extension_id}/chat/

Параметры URL

Name

Type

Description

extension_id

string

Нужно указать обязательно.

remote_numberstring

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

Name

Type

Description

extension_id

string

Нужно указать обязательно.

remote_numberstring
per_pageinteger
pageinteger

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

Имя

Тип

Описание

count_new

integer


idstring

last_message_id

string


last_message_init_time_gmt

string


last_message_textstring
remote_numberstring
  • No labels