Получить список записей из листа ожидания booking.v1.waitlist.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
bookingКто может выполнять метод: любой пользователь
Метод booking.v1.waitlist.list возвращает список записей из листа ожидания по фильтру.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter |
Объект для фильтрации записей листа ожидания. |
Параметр createdWithin
|
from* |
Дата начала периода фильтрации в формате |
|
to* |
Дата окончания периода фильтрации в формате |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"createdWithin":{"from":"01.04.2025","to":"16.04.2025"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.waitlist.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"createdWithin":{"from":"01.04.2025","to":"16.04.2025"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.waitlist.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type WaitListResult = {
waitList: {
id: number
note: string | null
}[]
}
try {
// booking.v1.waitlist.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<WaitListResult>({
method: 'booking.v1.waitlist.list',
params: {
filter: {
createdWithin: {
from: '01.04.2025',
to: '16.04.2025',
},
},
start: 0,
},
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('Waitlist entries:', result.waitList, 'Count:', result.waitList.length)
}
} 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 fetchWaitList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// booking.v1.waitlist.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'booking.v1.waitlist.list',
params: {
filter: {
createdWithin: {
from: '01.04.2025',
to: '16.04.2025',
},
},
start: 0,
},
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('Waitlist entries:', result.waitList, 'Count:', result.waitList.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchWaitList)
</script>
try {
$response = $b24Service
->core
->call(
'booking.v1.waitlist.list',
[
'filter' => [
'createdWithin' => [
'from' => '01.04.2025',
'to' => '16.04.2025', //не включительно, будут отобраны записи с самой поздней датой 15.04.2025
],
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error listing waitlist: ' . $e->getMessage();
}
BX24.callMethod(
"booking.v1.waitlist.list",
{
filter: {
createdWithin: {
from: "01.04.2025",
to: "16.04.2025", //не включительно, будут отобраны записи с самой поздней датой 15.04.2025
}
}
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'booking.v1.waitlist.list',
[
'filter' => [
'createdWithin' => [
'from' => '01.04.2025',
'to' => '16.04.2025' //не включительно, будут отобраны записи с самой поздней датой 15.04.2025
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "booking.v1.waitlist.list", b24.Params{
"filter": b24.Params{
"createdWithin": b24.Params{
"from": "01.04.2025",
"to": "16.04.2025",
},
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("booking.v1.waitlist.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "waitList".
raw, ok := b24.Unwrap(res.Result, "waitList")
if !ok {
return fmt.Errorf("в ответе нет ключа waitList")
}
var items []struct {
ID b24.ID `json:"id"`
Note string `json:"note"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"waitList": [
{
"id": 15,
"note": "заметка"
},
{
"id": 16,
"note": "заметка"
}
]
},
"time": {
"start": 1724068028.331234,
"finish": 1724068028.726591,
"duration": 0.3953571319580078,
"processing": 0.13033390045166016,
"date_start": "2025-01-21T13:47:08+02:00",
"date_finish": "2025-01-21T13:47:08+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит массив записей в листе ожидания. Структура описана ниже |
|
time |
Информация о времени выполнения запроса |
Запись в листе ожидания
|
id |
Идентификатор записи в листе ожидания |
|
note |
Заметка, связанная с записью в листе ожидания. Может быть |
Обработка ошибок
HTTP-статус: 400
{
"error": 422,
"error_description": "Invalid date"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
Не передан обязательный параметр внутри |
|
|
|
Некорректная дата |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать запись в листе ожидания из бронирования booking.v1.waitlist.createfrombooking
- Обновить запись в листе ожидания booking.v1.waitlist.update
- Получить запись из листа ожидания booking.v1.waitlist.get
- Добавить в лист ожидания booking.v1.waitlist.add
- Удалить запись из листа ожидания booking.v1.waitlist.delete