Skip to main content

Отправка сообщения (для ботов)

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

POST /chat.postMessage

Описание​

Отправляет сообщение от имени бота. Позволяет указать alias (псевдоним) и avatar (аватар). Требует наличия роли "bot" у пользователя.

Параметры​

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

НазваниеОбязательныйТип данныхОписание
roomIdнет*stringИдентификатор комнаты
channelнет*stringНазвание канала
textнетstringТекст сообщения
aliasнетstringПсевдоним отправителя
emojiнетstringЭмодзи статуса
avatarнетstringURL аватара отправителя
attachmentsнетarrayВложения к сообщению

* Должен быть указан один из параметров: roomId или channel.

Запрос​

curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.postMessage' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>' \
-d '{ \
"roomId": "<ROOM_ID>",
"text": "<MESSAGE_TEXT>",
"alias": "<ALIAS>",
"avatar": "<AVATAR_URL>"
}'

Где:

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

Ответ​

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

{
"success": true,
"_id": "msg_123456",
"rid": "GENERAL",
"msg": "Hello, everyone!",
"ts": "2026-06-24T10:00:00.000Z",
"u": {
"_id": "7w9BMr9r78W4RNe8x",
"username": "john.doe"
}
}