81  /  166

im.message.add

Просмотров: 23957
Дата последнего изменения: 19.11.2021
Александр Суворов
Сложность урока:
3 уровень - средняя сложность. Необходимо внимание и немного подумать.
1
2
3
4
5

Отправка сообщения в чат

 Ревизия Получить информацию о текущей ревизии API (версии платформы) – im.revision.get : 18

Обратите внимание! Метод указан с использованием функции restCommand - это метод отправки данных в Битрикс24, данный метод есть в примере ЭхоБота, и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод BX24.callMethod или bitrix24-php-sdk.

Параметры

Параметр Пример Обязат. Описание Ревизия
DIALOG_ID chat13
или
256		 Да Идентификатор диалога. Формат:
chatXXX – чат получателя, если сообщение для чата
или XXX – идентификатор получателя, если сообщение для приватного диалога		 18
MESSAGE Текст сообщения Да Текст сообщения 18
SYSTEM N Нет Отображать сообщения в виде системного сообщения или нет, необязательное поле, по умолчанию 'N' 18
ATTACH Нет Вложение 18
URL_PREVIEW Y Нет Преобразовывать ссылки в rich-ссылки, необязательное поле, по умолчанию 'Y' 18
KEYBOARD Нет Клавиатура 18
MENU Нет Контекстное меню 18


Вызов метода и ответ

PHP

$result = restCommand('im.message.add', Array(

    'DIALOG_ID' => 'chat13',
    'MESSAGE' => 'Текст сообщения',
    'SYSTEM' => 'N',
    'ATTACH' => '',
    'URL_PREVIEW' => 'Y',
    'KEYBOARD' => '',
    'MENU' => '',

), $_REQUEST["auth"]);

Пример ответа

{
	"result": 11
}
Результат выполнения: идентификатор сообщения MESSAGE_ID или ошибка.



Пример ответа при возникновении ошибки

{
    "error": "USER_ID_EMPTY",
    "error_description": "Идентификатор получателя не задан в случае отправки сообщения в чат один-на-один"
}

Описание ключей:

  • error – код возникшей ошибки
  • error_description – краткое описание возникшей ошибки

Возможные коды ошибок

Код Описание
USER_ID_EMPTY Идентификатор получателя не задан в случае отправки сообщения в чат один-на-один
CHAT_ID_EMPTY Идентификатор чата получателя не задан в случае отправки сообщения в чат
ACCESS_ERROR Недостаточно прав для отправки сообщения
MESSAGE_EMPTY Не передан текст сообщения
ATTACH_ERROR Весь переданный объект вложения не прошел валидацию
ATTACH_OVERSIZE Превышен максимально допустимый размер вложения (30 Кб)
KEYBOARD_ERROR Весь переданный объект клавиатуры не прошел валидацию
KEYBOARD_OVERSIZE Превышен максимально допустимый размер клавиатуры (30 Кб)
MENU_ERROR Весь переданный объект меню не прошел валидацию
MENU_OVERSIZE Превышен максимально допустимый размер меню (30 Кб)
PARAMS_ERROR Что-то пошло не так


Ссылки по теме:

Как работать с набираемыми клавиатурами
Как работать с вложениями
Форматирование сообщений
Работа с контекстным меню

Описание курса


Курсы разработаны в компании «1С-Битрикс»