Установить клиентов записи в листе ожидания booking.v1.waitlist.client.set
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
bookingКто может выполнять метод: любой пользователь
Метод booking.v1.waitlist.client.set устанавливает список клиентов для указанной записи в листе ожидания. Клиентами могут быть контакты и компании CRM.
Метод заменяет весь список клиентов записи. Чтобы сохранить текущих клиентов, получите их методом booking.v1.waitlist.client.list и передайте в clients вместе с новыми.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
waitListId* |
Идентификатор записи в листе ожидания. |
|
clients* |
Полный список клиентов записи. Каждый элемент — объект с полями |
Параметр clients
|
Название |
Описание |
|
id* |
Идентификатор контакта или компании CRM. Получить можно методом crm.item.list: |
|
type* |
Тип клиента. Например, |
Объект type
|
Название |
Описание |
|
module* |
Модуль клиента. Для контактов и компаний — |
|
code* |
Код типа клиента:
Доступные типы клиентов возвращает метод booking.v1.clienttype.list |
Пустой массив clients
Чтобы удалить текущие связи с клиентами, передайте clients: [].
Связанная сделка
Если у записи уже нет клиентов, но к ней привязана сделка методом booking.v1.waitlist.externalData.set, вызов с clients: [] привяжет к записи контакты и компанию этой сделки. Поэтому повторный вызов может заполнить список заново. Проверьте результат методом booking.v1.waitlist.client.list.
Примеры кода
Примеры связывают запись 13 с контактом 2795 и компанией 3063. Замените идентификаторы значениями своего Битрикс24.
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"waitListId":13,"clients":[{"id":2795,"type":{"module":"crm","code":"CONTACT"}},{"id":3063,"type":{"module":"crm","code":"COMPANY"}}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.waitlist.client.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"waitListId":13,"clients":[{"id":2795,"type":{"module":"crm","code":"CONTACT"}},{"id":3063,"type":{"module":"crm","code":"COMPANY"}}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.waitlist.client.set
// 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<boolean>({
method: 'booking.v1.waitlist.client.set',
params: {
waitListId: 13,
clients: [
{
id: 2795,
type: {
module: 'crm',
code: 'CONTACT',
},
},
{
id: 3063,
type: {
module: 'crm',
code: 'COMPANY',
},
},
],
},
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('Clients set successfully:', result)
}
} 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 setWaitlistClients() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'booking.v1.waitlist.client.set',
params: {
waitListId: 13,
clients: [
{
id: 2795,
type: {
module: 'crm',
code: 'CONTACT',
},
},
{
id: 3063,
type: {
module: 'crm',
code: 'COMPANY',
},
},
],
},
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('Clients set successfully:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setWaitlistClients)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.booking.v1.waitlist.client.set(
wait_list_id=13,
clients=[
{
"id": 2795,
"type": {
"module": "crm",
"code": "CONTACT",
},
},
{
"id": 3063,
"type": {
"module": "crm",
"code": "COMPANY",
},
},
],
).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(
'booking.v1.waitlist.client.set',
[
'waitListId' => 13,
'clients' => [
[
'id' => 2795,
'type' => [
'module' => 'crm',
'code' => 'CONTACT',
],
],
[
'id' => 3063,
'type' => [
'module' => 'crm',
'code' => 'COMPANY',
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result[0] === true) {
echo 'Success';
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting waitlist clients: ' . $e->getMessage();
}
BX24.callMethod(
"booking.v1.waitlist.client.set",
{
waitListId: 13,
clients: [
{
id: 2795,
type: {
module: "crm",
code: "CONTACT"
}
},
{
id: 3063,
type: {
module: "crm",
code: "COMPANY"
}
}
]
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'booking.v1.waitlist.client.set',
[
'waitListId' => 13,
'clients' => [
[
'id' => 2795,
'type' => [
'module' => 'crm',
'code' => 'CONTACT'
]
],
[
'id' => 3063,
'type' => [
'module' => 'crm',
'code' => 'COMPANY'
]
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "booking.v1.waitlist.client.set", b24.Params{
"waitListId": 13,
"clients": []b24.Params{
{
"id": 2795,
"type": b24.Params{
"module": "crm",
"code": "CONTACT",
},
},
{
"id": 3063,
"type": b24.Params{
"module": "crm",
"code": "COMPANY",
},
},
},
})
if err != nil {
return fmt.Errorf("booking.v1.waitlist.client.set: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1790294535,
"finish": 1790294535.315704,
"duration": 0.3157041072845459,
"processing": 0,
"date_start": "2026-09-25T03:02:15+03:00",
"date_finish": "2026-09-25T03:02:15+03:00",
"operating_reset_at": 1790295135,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа, содержит |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "1040",
"error_description": "Wait list not found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
В элементе |
|
|
|
В элементе |
|
|
|
В объекте |
|
|
|
В объекте |
|
|
|
Не передан |
|
|
|
Не передан массив |
|
|
|
Передан неизвестный тип клиента. Проверьте сочетание |
|
|
|
Запись с указанным |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |