67  /  169

im.chat.user.delete

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

Исключение участников

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

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

Параметры

Параметр Пример Обязат. Описание Ревизия
CHAT_ID 13 Да Идентификатор чата 18
USER_ID 4 Да Идентификатор исключаемого пользователя 18

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

PHP

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

   'CHAT_ID' => 13,
   'USER_ID' => 4

), $_REQUEST["auth"]);

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

{
	"result": true
}

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

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

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

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

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

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


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