...
| Table of Contents | ||
|---|---|---|
|
Ресурсы /message/
Ресурс управления сообщениями добавочного. С помощью ресурса /message/ можно:
...
| Table of Contents | ||||
|---|---|---|---|---|
|
Ресурсы /chat/
С помощью ресурса /chat/ можно:
...
Table of Contents maxLevel 4 minLevel 4
GET /extension/{extension_id}/message/
Запросить сообщения добавочного
...
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 |
|---|---|---|
| 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}
Получить(прочитать) сообщение
...
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}
Пометить сообщение прочтенным
...
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 | Текст сообщения |
GET /extension/{extension_id}/chat/
Получить список чатов
Параметры запроса
...
Имя | Тип | Описание |
|---|---|---|
|
| Счетчик непрочитанных сообщений |
| string | id чата |
|
| id последнего сообщения |
|
| время получения, либо отправки, последнего сообщения |
last_message_text | string | текст последнего сообщения |
remote_number | string | номер собеседника в чате |
GET /extension/{extension_id}/chat/{chat_id}
Получить информацию о последних сообщениях чата
...
Имя | Тип | Описание |
|---|---|---|
|
| Счетчик непрочитанных сообщений |
| string | id чата |
|
| id последнего сообщения |
|
| время получения, либо отправки, последнего сообщения |
last_message_text | string | текст последнего сообщения |
remote_number | string | номер собеседника в чате |
DELETE /extension/{extension_id}/chat/{chat_id}
Удалить чат
Параметры URL
Name | Type | Description |
|---|---|---|
|
| id добавочного |
chat_id |
| id чата |
GET /extension/{extension_id}/chat/{chat_id}/messages/
Получить список сообщений чата
...
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 | Текст сообщения |
PUT /extension/{extension_id}/chat/{chat_id}/messages/
Установить сообщения чата в "прочитано"
...
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 | Текст сообщения |
DELETE /extension/{extension_id}/chat/{chat_id}/messages/
Удалить сообщения чата
Параметры URL
...