Views: 126
Last Modified: 13.05.2022

Chat color update

Attention! restCommand function is used here for illustration purposes only. It is taken from the EchoBot example. You can send a REST command with your own function, or use the BX24.callMethod or bitrix24-php-sdk methods.

Method call

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

   'CHAT_ID' => 13 // Chat ID
   'COLOR' => 'MINT' // Chat color for mobile application - RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN,  AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE
   'BOT_ID' => 39, // Chatbot ID from which the request is sent. May not be specified, if there is only one chatbot  

), $_REQUEST["auth"]);

Return:

true or error.

Possible error codes

Code Description
CHAT_ID_EMPTY Chat ID is unavailable.
WRONG_COLOR Color is not included into available colors list.
WRONG_REQUEST Color is already defined or the existing chat does not exist.




Courses developed by Bitrix24