im.dialog.users.list
Получить список участников
Описание
Метод im.dialog.users.list возвращает подробную информацию об участниках диалога с поддержкой пагинации.
Параметры
DIALOG_ID
string
обязательный
Идентификатор чата в формате:
chatXXX— чатsgXXX— чат группы или проектаXXX— идентификатор пользователя личного чата
Идентификатор чата можно получить с помощью метода im.chat.get. Идентификатор пользователя — с помощью методов user.get и user.search
SKIP_EXTERNAL
string
необязательный
Исключить системных пользователей:
- Y — исключить
- N — не исключать
По умолчанию: N
SKIP_EXTERNAL_EXCEPT_TYPES
string
необязательный
Список типов системных пользователей, которых нужно оставить в выборке, через запятую.
Например: bot, email
LIMIT
integer
необязательный
Количество элементов на страницу. По умолчанию: 50. Максимальное значение: 200
LAST_ID
integer
необязательный
Идентификатор последнего пользователя из выборки LIMIT.
Используется для последовательной загрузки списка
OFFSET
integer
необязательный
Смещение для постраничной выборки. По умолчанию: 0
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DIALOG_ID":"chat2935","SKIP_EXTERNAL":"Y","LIMIT":20,"OFFSET":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.dialog.users.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"DIALOG_ID":"chat2935","SKIP_EXTERNAL":"Y","LIMIT":20,"OFFSET":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/im.dialog.users.list
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each DialogUser returned in result[]
type DialogUser = {
id: number
active: boolean
name: string
first_name: string
last_name: string
work_position: string | null
color: string
avatar: string
avatar_hr: string
gender: string
birthday: string
extranet: boolean
network: boolean
bot: boolean
connector: boolean
external_auth_id: string
status: string
idle: ISODate | false
last_activity_date: ISODate
mobile_last_date: ISODate | false
desktop_last_date: ISODate | false
absent: ISODate | false
departments: number[]
phones: { work_phone?: string; personal_mobile?: string; personal_phone?: string } | false
bot_data: object | null
type: string
website: string
email: string
}
try {
const response = await $b24.actions.v2.call.make<DialogUser[]>({
method: 'im.dialog.users.list',
params: {
DIALOG_ID: 'chat13',
SKIP_EXTERNAL: 'Y',
LIMIT: 20,
},
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(`Retrieved ${result.length} dialog users:`, result.map(u => u.name))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 fetchDialogUsers() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'im.dialog.users.list',
params: {
DIALOG_ID: 'chat13',
SKIP_EXTERNAL: 'Y',
LIMIT: 20,
},
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(`Retrieved ${result.length} dialog users:`, result.map(u => u.name))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchDialogUsers)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.im.dialog.users.list(
dialog_id="chat2935",
skip_external=True,
limit=20,
offset=0,
).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}")
try {
$response = $b24Service
->core
->call(
'im.dialog.users.list',
[
'DIALOG_ID' => 'chat2935',
'SKIP_EXTERNAL' => 'Y',
'LIMIT' => 20,
'OFFSET' => 0
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error retrieving dialog users list: ' . $e->getMessage();
}
BX24.callMethod(
'im.dialog.users.list',
{
DIALOG_ID: 'chat2935',
SKIP_EXTERNAL: 'Y',
LIMIT: 20,
OFFSET: 0
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'im.dialog.users.list',
[
'DIALOG_ID' => 'chat2935',
'SKIP_EXTERNAL' => 'Y',
'LIMIT' => 20,
'OFFSET' => 0
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.dialog.users.list", b24.Params{
"DIALOG_ID": "chat2935",
"SKIP_EXTERNAL": "Y",
"LIMIT": 20,
"OFFSET": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("im.dialog.users.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
Active bool `json:"active"`
Name string `json:"name"`
FirstName string `json:"first_name"`
LastName string `json:"last_name"`
WorkPosition string `json:"work_position"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Active)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"id": 1269,
"active": true,
"name": "Александр Смирнов",
"first_name": "Александр",
"last_name": "Смирнов",
"work_position": "Руководитель отдела продаж",
"color": "#58cc47",
"avatar": "https://cdn-ru.bitrix24.ru/avatars/alexander-smirnov.png",
"avatar_hr": "https://cdn-ru.bitrix24.ru/avatars/alexander-smirnov@2x.png",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2026-03-02T17:45:59+03:00",
"mobile_last_date": false,
"desktop_last_date": false,
"absent": false,
"departments": [1],
"phones": {
"personal_mobile": "79165554419"
},
"bot_data": null,
"type": "user",
"website": "",
"email": "a.smirnov@example.ru"
},
{
"id": 99,
"active": true,
"name": "Екатерина Иванова",
"first_name": "Екатерина",
"last_name": "Иванова",
"work_position": "Бизнес-аналитик",
"color": "#58cc47",
"avatar": "https://cdn-ru.bitrix24.ru/avatars/ekaterina-ivanova.png",
"avatar_hr": "https://cdn-ru.bitrix24.ru/avatars/ekaterina-ivanova@2x.png",
"gender": "F",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2026-03-02T17:44:31+03:00",
"mobile_last_date": false,
"desktop_last_date": false,
"absent": false,
"departments": [121],
"phones": false,
"bot_data": null,
"type": "user",
"website": "",
"email": "e.ivanova@mail.ru"
},
{
"id": 1271,
"active": true,
"name": "Дмитрий Кузнецов",
"first_name": "Дмитрий",
"last_name": "Кузнецов",
"work_position": "Старший разработчик",
"color": "#df532d",
"avatar": "https://cdn-ru.bitrix24.ru/avatars/dmitry-kuznetsov.png",
"avatar_hr": "https://cdn-ru.bitrix24.ru/avatars/dmitry-kuznetsov@2x.png",
"gender": "M",
"birthday": "",
"extranet": false,
"network": false,
"bot": false,
"connector": false,
"external_auth_id": "socservices",
"status": "online",
"idle": false,
"last_activity_date": "2026-03-02T17:45:02+03:00",
"mobile_last_date": false,
"desktop_last_date": false,
"absent": false,
"departments": [1],
"phones": false,
"bot_data": null,
"type": "user",
"website": "",
"email": "d.kuznetsov@mail.ru"
}
],
"total": 3,
"time": {
"start": 1772477165,
"finish": 1772477165.266759,
"duration": 0.26675891876220703,
"processing": 0,
"date_start": "2026-03-02T17:46:05+03:00",
"date_finish": "2026-03-02T17:46:05+03:00",
"operating_reset_at": 1772477765,
"operating": 0
}
}
Возвращаемые данные
result
array
Массив объектов с данными участников диалога
total
integer
Общее количество участников, доступных текущему пользователю
next
integer
Смещение следующей страницы результатов.
Возвращается, если есть следующая страница
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "DIALOG_ID_EMPTY",
"error_description": "Dialog ID can't be empty"
}
| Код | Описание | Значение |
|---|---|---|
DIALOG_ID_EMPTY |
Dialog ID can't be empty | Не передан или передан некорректный DIALOG_ID |
ACCESS_ERROR |
You do not have access to the specified dialog | Нет доступа к указанному диалогу |
ACCESS_ERROR |
You don't have access to this chat | Нет доступа к указанному чату |

