im.chat.updateColor

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

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

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

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

Обновление цвета чата

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

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

Параметры

Параметр	Пример	Обязат.	Описание	Ревизия
CHAT_ID	13	Да	Идентификатор чата	18
COLOR	MINT	Да	Цвет чата для мобильного приложения (RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE)	18

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

PHP

$result = restCommand('im.chat.updateColor', Array(

   'CHAT_ID' => 13,
   'COLOR' => 'MINT'

), $_REQUEST["auth"]);

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

{
	"result": true
}

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

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

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

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

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

Код	Описание
CHAT_ID_EMPTY	Не передан идентификатор чата
WRONG_COLOR	Цвет не входит в список доступных цветов
WRONG_REQUEST	Цвет уже установлен или указанный чат не существует

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