imbot.v2.Chat.User.list
Список участников чата
Описание
Метод imbot.v2.Chat.User.list возвращает список участников чата.
Параметры
botId
integer
обязательный
ID бота
botToken
string
необязательный
Уникальный токен авторизации бота. Обязателен при авторизации через вебхук, не нужен для OAuth.
Передавайте тот же botToken, который был указан при регистрации чат-бота
dialogId
string
обязательный
ID диалога. Для групповых чатов — chat{chatId}
order
object
необязательный
Сортировка.
Доступные поля: id, lastSendMessageId, userId. Значение: ASC или DESC.
Пример: {"id": "ASC"}
limit
integer
необязательный
Количество записей (1–200). По умолчанию 50
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botId":456,"botToken":"my_bot_token","dialogId":"chat5","order":{"id":"ASC"},"limit":50}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Chat.User.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"botId":456,"dialogId":"chat5","order":{"id":"ASC"},"limit":50,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imbot.v2.Chat.User.list
try {
const response = await $b24.callMethod('imbot.v2.Chat.User.list', {
botId: 456,
dialogId: 'chat5',
order: { id: 'ASC' },
limit: 50,
});
const { result } = response.getData();
console.log('result:', result);
} catch (error) {
console.error('Error:', error);
}
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imbot.v2.chat.user.list(
bot_id=456,
dialog_id="chat5",
order={
"id": "ASC",
},
limit=50,
).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(
'imbot.v2.Chat.User.list',
[
'botId' => 456,
'dialogId' => 'chat5',
'order' => ['id' => 'ASC'],
'limit' => 50,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'result: ' . print_r($result, true);
} catch (Throwable $exception) {
error_log($exception->getMessage());
echo 'Error: ' . $exception->getMessage();
}
BX24.callMethod(
'imbot.v2.Chat.User.list',
{
botId: 456,
dialogId: 'chat5',
order: { id: 'ASC' },
limit: 50,
},
function(result) {
if (result.error()) {
console.error(result.error().ex);
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imbot.v2.Chat.User.list',
[
'botId' => 456,
'dialogId' => 'chat5',
'order' => ['id' => 'ASC'],
'limit' => 50,
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
foreach ($result['result'] as $user) {
echo $user['id'] . ': ' . $user['name'] . "\n";
}
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.v2.Chat.User.list", b24.Params{
"botId": 456,
"botToken": "my_bot_token",
"dialogId": "chat5",
"order": b24.Params{
"id": "ASC",
},
"limit": 50,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("imbot.v2.Chat.User.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
Active bool `json:"active"`
Name string `json:"name"`
FirstName string `json:"firstName"`
LastName string `json:"lastName"`
WorkPosition string `json:"workPosition"`
}
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": 1,
"active": true,
"name": "John Smith",
"firstName": "John",
"lastName": "Smith",
"workPosition": "Developer",
"color": "#ab7761",
"avatar": "",
"gender": "M",
"birthday": "15-03",
"extranet": false,
"bot": false,
"connector": false,
"externalAuthId": "default",
"status": "online",
"idle": false,
"lastActivityDate": "2025-01-15T14:25:00+03:00",
"absent": false,
"departments": [7],
"phones": false,
"type": "employee"
},
{
"id": 2,
"active": true,
"name": "Anna Davis",
"firstName": "Anna",
"lastName": "Davis",
"workPosition": "Manager",
"color": "#5b7e91",
"avatar": "",
"gender": "F",
"birthday": "22-08",
"extranet": false,
"bot": false,
"connector": false,
"externalAuthId": "default",
"status": "online",
"idle": false,
"lastActivityDate": "2025-01-15T14:20:00+03:00",
"absent": false,
"departments": [12],
"phones": false,
"type": "employee"
}
],
"time": {
"start": 1728626400.123,
"finish": 1728626400.234,
"duration": 0.111,
"processing": 0.045,
"date_start": "2024-10-11T10:00:00+03:00",
"date_finish": "2024-10-11T10:00:00+03:00"
}
}
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied"
}
| Код | Описание | Значение |
|---|---|---|
BOT_TOKEN_NOT_SPECIFIED |
Bot token is not specified | Не указан botToken. Обязателен при авторизации через вебхук |
BOT_ID_REQUIRED |
Bot ID is required | Не указан botId |
BOT_NOT_FOUND |
Bot not found | Бот не найден |
BOT_OWNERSHIP_ERROR |
Bot is registered by another application | Бот зарегистрирован другим приложением |
ACCESS_DENIED |
Access denied | Бот не является участником чата |

