im-user-status-get.md

Get User Status im.user.status.get

{% 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: any user

The method im.user.status.get returns the status of the current user.

{% note info "" %}

The method returns the status that was set using the im.user.status.set method.

{% endnote %}

Method Parameters

No parameters.

Code Examples

{% include Examples Note %}

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.user.status.get

• cURL (OAuth)

  curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/im.user.status.get

• 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<string | false>({
      method: 'im.user.status.get',
      params: {},
      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('Current user status:', 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 getUserStatus() {
      try {
        // Initialize the SDK inside a Bitrix24 frame
        const $b24 = await B24Js.initializeB24Frame()
  
        const response = await $b24.actions.v2.call.make({
          method: 'im.user.status.get',
          params: {},
          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('Current user status:', result)
      } catch (error) {
        // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
        console.error(error)
      }
    }
  
    document.addEventListener('DOMContentLoaded', getUserStatus)
  </script>

• PHP

  try {
      $response = $b24Service->core->call('im.user.status.get', []);
  
      $result = $response->getResponseData()->getResult();
  
      if ($result->error()) {
          echo 'Error: ' . $result->error();
      } else {
          var_dump($result->data());
      }
  } catch (Throwable $exception) {
      echo $exception->getMessage();
  }

• BX24.js

  BX24.callMethod('im.user.status.get', {}, function(result) {
      if (result.error()) {
          console.error(result.error().ex);
      } else {
          console.log(result.data());
      }
  });

• PHP CRest

  require_once('crest.php');
  
  $result = CRest::call('im.user.status.get', []);
  
  if (!empty($result['error'])) {
      echo 'Error: ' . $result['error_description'];
  } else {
      var_dump($result['result']);
  }

• Go

  // client and ctx are already created — see the Go SDK section
  res, err := client.Core().Call(ctx, "im.user.status.get", nil, b24.WithIdempotent())
  if err != nil {
  	return fmt.Errorf("im.user.status.get: %w", err)
  }
  
  var value string
  if err := json.Unmarshal(res.Result, &value); err != nil {
  	return fmt.Errorf("parse response: %w", err)
  }
  fmt.Println("result:", value)

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": "dnd",
    "time": {
        "start": 1760000000.0,
        "finish": 1760000000.05,
        "duration": 0.05,
        "processing": 0.02,
        "date_start": "2026-03-02T09:30:00+01:00",
        "date_finish": "2026-03-02T09:30:00+01:00",
        "operating_reset_at": 1760030000,
        "operating": 0
    }
}

Returned Data

#| || Name Type | Description || || result string boolean | The current status of the user.

Allowed values:

• online — online
• dnd — do not disturb
• away — away
• break — on break

If the status is not found, false is returned || || time time | Information about the request execution time || |#

{% note info "" %}

In the interface of the new messenger, only the online status is displayed. The statuses dnd, away, and break can be set using the method, but they are not shown in the interface.

Bitrix24 Chat: New Messenger

{% endnote %}

Error Handling

HTTP Status: 401

{
    "error": "INVALID_CREDENTIALS",
    "error_description": "Invalid request credentials"
}

The method has no error codes of its own — only system REST API errors are possible.

{% include notitle Error Handling %}

{% include System Errors %}

Continue Learning

• {#T}
• {#T}
• {#T}
• {#T}
• {#T}