Отправить сообщение

Сообщение во внутренний чат

POST https://do.freshoffice.ru/chat/send

Сообщение уходит от имени владельца токена одному или нескольким коллегам. Каждый получатель получает своё личное сообщение — так же, как если бы пользователь написал ему сам в чате.

Request Body

Name Type Description
user_ids* Array of Int Коды получателей из списка пользователей, не больше 20
text* String Текст сообщения, не больше 2000 символов. Обычный текст: HTML не выполняется, переводы строк сохраняются
{
  "status": "success",
  "error": "",
  "code": "0",
  "rows": 0,
  "pages": 0,
  "page": 0,
  "value": "[{\"user_id\":12,\"message_id\":48211,\"delivered_live\":true}]"
}

В value — результат по каждому получателю:

  • user_id — код получателя
  • message_id — код сохранённого сообщения (0 — не отправлено, причина в error)
  • delivered_live — true: сообщение сразу появилось в открытом чате получателя; false: сообщение сохранено, получатель увидит его при обновлении чата

Примечание

Ограничения
Не больше 20 получателей за один вызов.
Получатели — только включённые пользователи вашей компании. Если хотя бы один код неизвестен, не отправляется ничего.
Отправить сообщение самому себе нельзя.

Пример

curl --location --request POST 'https://do.freshoffice.ru/chat/send' \
--header 'Authorization: Bearer XXXXXX.XXXXXXXX.XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_ids" : [12, 17],
    "text" : "Коллеги, напоминаю про задачи по Саклау — срок вчера."
}'
Предыдущая
Следующая