Skip to main content

Получение списка черновиков

Метод и конечная точка​

GET /chat.draftMessage

Описание​

Возвращает список всех черновиков текущего пользователя. Поддерживает пагинацию и сортировку.

Параметры​

Перечень параметров представлен в таблице.

НазваниеОбязательныйТип данныхОписание
offsetнетnumberСмещение для пагинации
countнетnumberКоличество результатов на страницу
sortнетstringПоле для сортировки

Запрос​

curl -X 'GET' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.draftMessage?offset=0&count=20&sort=_updatedAt' \
-H 'accept: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>'

Где:

  • <ENV> — окружение, на котором выполняется запрос;
  • <DEFAULT_DOMAIN> — домен сервера Squadus;
  • <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
  • <AUTH_TOKEN> — токен аутентификации пользователя.

Ответ​

200 — Result of getting list of draft messages — Список черновиков. Пример вывода:

{
"success": true,
"drafts": [
{
"rid": "GENERAL",
"msg": "Draft message content",
"tmid": null,
"replyMessages": [],
"forwardMessages": []
}
],
"total": 1
}