86  /  166

im.message.share

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

Создание новых сущностей по сообщению в чате: новый чат, задача, пост в Новостях, событие в календаре

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

Параметры

Параметр Пример Обязат. Описание Ревизия
MESSAGE_ID 289 Да Идентификатор сообщения, по которому будет создана новая сущность 30
DIALOG_ID 'chat74' Да Идентификатор диалога. Формат:
  • chatXXX – чат получателя, если сообщение для чата
  • или
  • XXX – идентификатор получателя, если сообщение для приватного диалога
30
TYPE 'TASK' Да Тип создаваемой сущности:
  • 'CHAT' – по сообщению будет создан новый чат
  • 'TASK' – по сообщению будет создана задача
  • 'POST' – по сообщению будет создан пост в Новостях
  • 'CALEND' – по сообщению будет создано событие в календаре
30

Необходимо передавать сообщение, в котором есть выбор команд бота.


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

JavaScript

B24.callMethod(
  'im.message.share',
  {
    MESSAGE_ID: 289,
    DIALOG_ID: 'chat74',
    TYPE: 'CHAT',
  },
  res => {
    if (res.error())
    {
      console.error(result.error().ex);
    }
    else
    {
      console.log(res.data())
    }
  }
)

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

true

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

{
  "error":"PARAMS_ERROR",
  "error_description":"Incorrect params"
}

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

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

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

Код Описание
MESSAGE_ID_ERROR Параметр MESSAGE_ID не задан или не является числом
DIALOG_ID_EMPTY Параметр DIALOG_ID не задан или не соответствует формату
ACCESS_ERROR Текущий пользователь не имеет прав доступа к чату или диалогу
PARAMS_ERROR Параметр TYPE не задан или не соответвует имеющимся


0
Курсы разработаны в компании «1С-Битрикс»
Доступна новая документация по REST: понятнее описания, больше примеров, удобнее поиск
Перейти