Skip to content

im-chat-leave.md

Latest commit

 

History

History
275 lines (219 loc) · 6.72 KB

im-chat-leave.md

File metadata and controls

275 lines (219 loc) · 6.72 KB
Raw

Leave Chat im.chat.leave

{% note tip "" %}

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

{% endnote %}

Scope: im

Who can execute the method: chat participant

The method im.chat.leave removes the current user from the chat.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || CHAT_ID* integer | Identifier of the chat.

The chat identifier can be obtained using the im.chat.get method || |#

Code Examples

{% include Note on examples %}

{% list tabs %}

  • cURL (Webhook)

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CHAT_ID":2935}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.leave

  • cURL (OAuth)

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CHAT_ID":2935,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.chat.leave

  • JS (TS)

    // This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'im.chat.leave',
    params: {
      CHAT_ID: 2935,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Left chat:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

  • JS (UMD)

    <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function leaveChat() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.chat.leave',
        params: {
          CHAT_ID: 2935,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Left chat:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', leaveChat)
</script>

  • PHP

    try {
    $response = $b24Service
        ->core
        ->call(
            'im.chat.leave',
            [
                'CHAT_ID' => 2935
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error leaving chat: ' . $e->getMessage();
}

  • BX24.js

    BX24.callMethod(
    'im.chat.leave',
    {
        CHAT_ID: 2935,
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);

  • PHP CRest

    require_once('crest.php');

$result = CRest::call(
    'im.chat.leave',
    [
        'CHAT_ID' => 2935
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

  • Go

    // client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "im.chat.leave", b24.Params{
	"CHAT_ID": 2935,
})
if err != nil {
	return fmt.Errorf("im.chat.leave: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": true,
    "time": {
        "start": 1772482559,
        "finish": 1772482559.780171,
        "duration": 0.7801709175109863,
        "processing": 0,
        "date_start": "2026-03-02T13:15:59+01:00",
        "date_finish": "2026-03-02T13:15:59+01:00",
        "operating_reset_at": 1772483159,
        "operating": 0.10254502296447754
    }
}

Returned Data

#| || Name type | Description || || result boolean | true if the user has left the chat || || time time | Information about the request execution time || |#

Error Handling

HTTP Status: 400, 403

{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Chat ID can't be empty"
}

{% include notitle error handling %}

Possible Error Codes

#| || Code | Description | Value || || CHAT_ID_EMPTY | Chat ID can't be empty | CHAT_ID not provided || || ACCESS_ERROR | Action unavailable | Operation not available for this chat || || ACCESS_ERROR | It is forbidden to delete users of this chat | Cannot leave this chat using this method || || ACCESS_DENIED_KICK | Access denied to kick user from chat | The user is not a participant of the chat or cannot leave this chat || |#

{% include system errors %}

Continue Learning