Views: 628
Last Modified: 23.03.2022

Updates avatar chat

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
AVATAR /* base64 image */ Yes Image in base64 format 18

Called method and response

PHP

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

   'CHAT_ID' => 13,
   'AVATAR' => '/* base64 image */'

), $_REQUEST["auth"]);

Example of response

{
	"result": true
}

Example of response on error

{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Chat ID not passed"
}

Key description:

  • error – error code
  • error_description – error brief description

Possible error codes

Code Description
CHAT_ID_EMPTY Chat ID not passed
AVATAR_ERROR Incorrect image format is not passed
WRONG_REQUEST Chat doesn't exist



Courses developed by Bitrix24