...
Отправить 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}
...
Name | Type | Description |
|---|---|---|
|
| id добавочного |
Параметры запроса
Name | Type | Description |
|---|---|---|
|
| Номер получателя сообщения |
| src_num | string | Номер отправителя сообщения |
| text | string | Текст сообщения для отправки |
...
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 | Текст сообщения |
...
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/{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}/chat/
Получить список чатов
Параметры
...
запроса
Name | Type | Description |
|---|---|---|
|
|
Name
Type
Description
id добавочного | ||
| remote_number | string | Фильтр по номеру |
per_page | integer |
Параметры запроса
| желаемое количество сообщений в ответе на один запрос | ||
| page | integer | номер страницы (нужен при указании per_page) |
Параметры ответа
Имя | Тип | Описание |
|---|---|---|
|
| Счетчик непрочитанных сообщений |
| string | id чата |
|
|
| id последнего сообщения | ||
|
| время получения, либо отправки, последнего сообщения |
last_message_text | string | текст последнего сообщения |
remote_number | string |
per_page| номер собеседника в чате |
GET /extension/{extension_id}/chat/{chat_id}
Получить информацию о последних сообщениях чата
Параметры URL
Name | Type | Description |
|---|---|---|
|
| id добавочного |
chat_id |
| 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/
Получить список сообщений чата
Параметры URL
Name | Type | Description |
|---|---|---|
|
| id добавочного |
chat_id |
| 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 | Текст сообщения |
PUT /extension/{extension_id}/chat/{chat_id}/messages/
Установить сообщения чата в "прочитано"
Параметры URL
Name | Type | Description |
|---|---|---|
| extension_id | string | id добавочного |
chat_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/
DELETE /extension/{extension_id}/chat/{chat_id}/messages/
Удалить сообщения чата
Параметры URL
Name | Type | Description |
|---|---|---|
|
| id добавочного |
chat_id |
| id чата |