Протестировать методы 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_id | string | id добавочного |
Параметры запроса
Name | Type | Description |
|---|---|---|
| start_datetime | string | начало даты запроса в формате %Y-%m-%d %H:%M:%S |
| src_num | string | фильтр по номеру источника |
| dst_num | string | фильтр по номеру назначения |
| end_datetime | string | конец даты запроса в формате %Y-%m-%d %H:%M:%S |
| per_page | integer | желаемое количество сообщений в ответе на один запрос |
| page | integer | номер страницы (нужен при указании per_page) |
| order | string | asc, либо desc |
Параметры ответа
Name | Type | Description |
|---|---|---|
| chat_id | string | id чата |
| dst_num | string | Номер получателя сообщения |
| extension_id | integer | id добавочного |
| flow | string | Направление (out, in) |
| id | string | id сообщения |
| init_time_gmt | string | Время получения, либо отправки сообщения |
| read | boolean | True если прочитано, False если нет |
| src_num | string | Номер отправителя сообщения |
| status | string | Статус сообщения |
| text | string | Текст сообщения |
POST /extension/{extension_id}/message/send/
Отправить сообщение
Параметры URL
Name | Type | Description |
|---|---|---|
|
|
Параметры запроса
Name | Type | Description |
|---|---|---|
|
| Номер получателя сообщения |
| src_num | string | Номер отправителя сообщения |
| text | string | Текст сообщения для отправки |
Параметры ответа
Name | Type | Description |
|---|---|---|
| string | id чата |
| id | string | id сообщения |
| status | string | Статус отправки сообщения |
DELETE /extension/{extension_id}/message/{message_id}
Удалить сообщение
Параметры URL
Name | Type | Description |
|---|---|---|
|
| id добавочного |
| message_id | string | id сообщения |
GET /extension/{extension_id}/message/{message_id}
Получить(прочитать) сообщение
Параметры URL
Name | Type | Description |
|---|---|---|
| extension_id | string | id добавочного |
| message_id | string | id сообщения |
Параметры ответа
Name | Type | Description |
|---|---|---|
| chat_id | string | id чата |
| string | Номер получателя сообщения |
extension_id | integer | id добавочного |
flow | string | Направление (out, in) |
| id | string | id сообщения |
| init_time_gmt | string | |
| read | boolean | True если прочитано, False если нет |
| src_num | string | Номер отправителя сообщения |
| status | string | Статус сообщения |
| text | string | Текст сообщения |
PUT /extension/{extension_id}/message/{message_id}
Пометить сообщение прочтенным
Параметры URL
Name | Type | Description |
|---|---|---|
| extension_id | string | id добавочного |
| message_id | string | id сообщения |
Параметры запроса
Name | Type | Description |
|---|---|---|
|
| True - установить в "прочитано" |
Параметры ответа
Name | Type | Description |
|---|---|---|
| chat_id | string | id чата |
| dst_num | string | Номер получателя сообщения |
| extension_id | integer | id добавочного |
| flow | string | Направление (out, in) |
| id | string | id сообщения |
| init_time_gmt | string | |
| read | boolean | True если прочитано, False если нет |
| src_num | string | Номер отправителя сообщения |
| status | string | Статус сообщения |
| text | string | Текст сообщения |
Ресурсы /chat/
С помощью ресурса /chat/ можно:
Получить список сообщения из чата методом GET /extension/{extension_id}/chat/
, пометить сообщение (прочитано или нет),
а также удалить все сообщения из чата.
GET /extension/{extension_id}/chat/
Параметры URL
Name | Type | Description |
|---|---|---|
|
| Нужно указать обязательно. |
| remote_number | string |
Параметры запроса
Name | Type | Description |
|---|---|---|
|
| Нужно указать обязательно. |
| remote_number | string | |
per_page | integer | |
| page | integer |
Параметры ответа
Имя | Тип | Описание |
|---|---|---|
|
| |
| string | |
|
| |
|
| |
last_message_text | string | |
remote_number | string |