# im.chat.get

URL: https://chugunov.pro/api-bitrix24/chats/im-chat-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить идентификатор чата
Scope: `im`
Кто может выполнять метод: любой пользователь

## Описание

Метод `im.chat.get` получает идентификатор чата.

## Параметры

- `ENTITY_TYPE` `string` — обязательный. Тип объекта для связи чата с внешним контекстом. Передается строкой.
  Возможные значения:
  - `VIDEOCONF` — чат видеоконференции
  - `AI_ASSISTANT_PRIVATE` — приватный чат с AI-ассистентом
  - `LINES` — чат открытой линии со стороны оператора
  - `LIVECHAT` — чат открытой линии со стороны клиента
  - `ANNOUNCEMENT` — чат объявлений
  - `CALENDAR` — чат, связанный с событием календаря
  - `MAIL` — чат, связанный с почтовой перепиской
  - `CRM` — системный чат «для обсуждения» CRM-элемента. Метод не вернет идентификаторы других чатов, связанных с элементом CRM
  - `SONET_GROUP` — системный чат группы или проекта
  - `TASKS_TASK` — чат задачи в [новой карточке задач](https://apidocs.bitrix24.ru/api-reference/tasks/tasks-new.html)
  - `TASKS` — системный чат задачи в старой карточке задач
  - `CALL` — чат, связанный со звонком
- `ENTITY_ID` `string` — обязательный. Идентификатор объекта в рамках `ENTITY_TYPE`.
  Передается строкой. Формат зависит от выбранного `ENTITY_TYPE`.
  Поддерживаемые форматы для распространенных типов:
  - `CRM` — `<CRM_TYPE>`|`<ID>`, например `LEAD`|`13`, `DEAL`|`1663`, `CONTACT`|`25`, `COMPANY`|`7`. Для смарт-процессов — `DYNAMIC_<entityTypeId>`|`<itemId>`
  - `LINES` — `<connectorId>`|`<lineId>`|`<connectorChatId>`|`<connectorUserId>`, например `telegrambot`|`2`|`209607941`|`744`
  - `LIVECHAT` — `<connectorId>`|`<lineId>`
  - `TASKS`, `TASKS_TASK` — идентификатор задачи, например `8293`
  - `CALENDAR` — идентификатор события календаря
  - `SONET_GROUP` — идентификатор группы
  Для остальных `ENTITY_TYPE` формат определяется модулем или интеграцией.

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "ID": 1437
    },
    "time": {
        "start": 1772028217,
        "finish": 1772028217.949613,
        "duration": 0.949613094329834,
        "processing": 0,
        "date_start": "2026-02-25T17:03:37+03:00",
        "date_finish": "2026-02-25T17:03:37+03:00",
        "operating_reset_at": 1772028817,
        "operating": 0
    }
}
```

### Возвращаемые данные

- `result` `object`. Возвращает объект с идентификатором чата `ID`.
  Метод вернет `null`:
  - если чат не найден
  - не указаны обязательные параметры
  - параметры заполнены неверно
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 401

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


## Примеры запроса

### cURL (Webhook)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.get
```

### cURL (OAuth)

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663","auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/im.chat.get
```

### JS (TS)

```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

// Shape of the payload returned in result (match the "response handling" section of the page)
type ImChatGetResult = {
  ID: number
}

try {
  const response = await $b24.actions.v2.call.make<ImChatGetResult>({
    method: 'im.chat.get',
    params: {
      ENTITY_TYPE: 'CRM',
      ENTITY_ID: 'DEAL|1663',
    },
    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('Chat ID:', result.ID)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 getChatId() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.chat.get',
        params: {
          ENTITY_TYPE: 'CRM',
          ENTITY_ID: 'DEAL|1663',
        },
        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('Chat ID:', result.ID)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.chat.get(
        entity_type="CRM",
        entity_id="DEAL|1663",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'im.chat.get',
            [
                'ENTITY_TYPE' => 'CRM',
                'ENTITY_ID' => 'DEAL|1663',
            ]
        );

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

    echo 'CHAT_ID: ' . var_export($result, true);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'im.chat.get',
    {
        ENTITY_TYPE: 'CRM',
        ENTITY_ID: 'DEAL|1663',
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'im.chat.get',
    [
        'ENTITY_TYPE' => 'CRM',
        'ENTITY_ID' => 'DEAL|1663',
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.chat.get", b24.Params{
	"ENTITY_TYPE": "CRM",
	"ENTITY_ID":   "DEAL|1663",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("im.chat.get: %w", err)
}

var item struct {
	ID b24.ID `json:"ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/chats/im-chat-get.html