Закрепление сообщения

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

POST /chat.pinMessage

Описание

Закрепляет сообщение в комнате. Закрепленные сообщения отображаются в верхней части чата.

Параметры

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

Название	Обязательный	Тип данных	Описание
messageId	да	string	Идентификатор сообщения

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.pinMessage' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "messageId": "<MESSAGE_ID>"
  }'

Где:

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

Ответ

200 — Result of pin message — Сообщение закреплено. Пример вывода:

{
  "success": true,
  "message": {
    "_id": "msg_123456",
    "rid": "GENERAL",
    "msg": "Important announcement!",
    "pinned": true
  }
}