im.chat.user.add

Просмотров: 17741
Дата последнего изменения: 31.05.2023

Александр Суворов

Сложность урока:

3 уровень - средняя сложность. Необходимо внимание и немного подумать.

Приглашение участников

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

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

Параметры

Параметр	Пример	Обязат.	Описание	Ревизия
CHAT_ID	13	Да	Идентификатор чата	18
USERS	Array(3,4)	Да	Идентификаторы новых пользователей	18
HIDE_HISTORY	N	Нет	Отображение истории переписки для пользователя, которого добавляют в чат этим методом. Y/N - по умолчанию N. Если передать Y то новый пользователь не будет видеть историю.	18

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

PHP

$result = restCommand('im.chat.user.add', Array(

   'CHAT_ID' => 13,
   'USERS' => Array(3,4)
   'HIDE_HISTORY' => N,

), $_REQUEST["auth"]);

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

{
	"result": true
}

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

{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Не передан идентификатор чата"
}

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

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

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

Код	Описание
CHAT_ID_EMPTY	Не передан идентификатор чата
WRONG_REQUEST	У вас недостаточно прав для добавления участника в чат или участник уже состоит в чате

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