Views: 2387
Last Modified: 23.03.2022

Excludes participants

 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
USER_ID 4 Yes Excluded user ID 18

Called method and response

PHP

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

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

), $_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 code
  • error_description – error brief description

Possible error codes

Code Description
CHAT_ID_EMPTY Chat ID not passed
USER_ID_EMPTY User ID not passed
WRONG_REQUEST You have insufficient access permissions for adding participants to chat or participant is already included into chat



Courses developed by Bitrix24
Course description


Back to top ↑