Views: 1024
Last Modified: 23.03.2022
Chat color updates |
Revision
Get current information about current API revision (platform version) – im.revision.get
: 18 |
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.
Parameters
| Parameter |
Example |
Required |
Description |
Revision |
| CHAT_ID |
13 |
Yes |
Chat ID |
18 |
| COLOR |
MINT |
Yes |
Chat color for mobile app (RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE) |
18 |
|
Called method and response
PHP
$result = restCommand('im.chat.updateColor', Array(
'CHAT_ID' => 13,
'COLOR' => 'MINT'
), $_REQUEST["auth"]);
Response example
{
"result": true
}
Example of response on error
{
"error": "CHAT_ID_EMPTY",
"error_description": "Chat ID not passed"
}
Key description:
error – error codeerror_description – error brief description
Possible error codes
| Code |
Description |
| CHAT_ID_EMPTY |
Chat ID not passed |
| WRONG_COLOR |
Color is not included into the list of available colors |
| WRONG_REQUEST |
Color is already indicated or indicated color doesn't exist |
|