Сохранение или обновление черновика
Метод и конечная точка
POST /chat.draftMessage
Описание
Сохраняет или обновляет черновик сообщения для указанной комнаты. Черновики позволяют пользователю сохранять незавершенные сообщения и возвращаться к ним позже.
Параметры
Перечень параметров представлен в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| message.rid | да | string | Идентификатор комнаты |
| message.msg | да | string | Текст черновика |
| message.tmid | нет | string | Идентификатор ветки (thread) |
| message.replyMessages | нет | array | Список ID сообщений, на которые дан ответ |
| message.forwardMessages | нет | array | Список ID пересылаемых сообщений |
| message.threadMessage | нет | string | Текст сообщения ветки |
Запрос
curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.draftMessage' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>' \
-d '{ \
"message": {
"rid": "<ROOM_ID>",
"msg": "<DRAFT_TEXT>",
"tmid": "<THREAD_ID>"
}
}'
Где:
<ENV>— окружение, на котором выполняется запрос;<DEFAULT_DOMAIN>— домен сервера Squadus;<USER_ID>— идентификатор пользователя, от имени которого выполняется запрос;<AUTH_TOKEN>— токен аутентификации пользователя;<ROOM_ID>— идентификатор комнаты;<DRAFT_TEXT>— текст черновика;<THREAD_ID>— идентификатор ветки (опционально).
Ответ
200 — Result of create draft message — Черновик сохранен. Пример вывода:
{
"success": true
}