Пересылка сообщений

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

POST /chat.forwardMessages

Описание

Пересылает одно или несколько сообщений в указанные комнаты.

Параметры

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

Название	Обязательный	Тип данных	Описание
targets	да	array	Список комнат для пересылки (с _id и rid)
forwardsIds	да	array	Список идентификаторов сообщений для пересылки
msg	нет	string	Дополнительный текст к пересылаемым сообщениям

Запрос

curl -X 'POST' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.forwardMessages' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "targets": [
  {
  "_id": "<TARGET_ROOM_ID_1>",
  "rid": "<TARGET_ROOM_RID_1>"
  }
  ],
  "forwardsIds": [
  "<MESSAGE_ID_1>",
  "<MESSAGE_ID_2>"
  ],
  "msg": "<ADDITIONAL_TEXT>"
  }'

Где:

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

Ответ

200 — Result of forward message — Сообщения пересланы. Пример вывода:

{
  "success": true,
  "result": {
    "_id": "forward_123456",
    "success": true
  }
}