Добавить клиентов к записи в лист ожидания booking.v1.waitlist.client.set
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
bookingКто может выполнять метод: любой пользователь
Метод booking.v1.waitlist.client.set устанавливает клиентов для указанной записи в листе ожидания.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
waitListId* |
Идентификатор записи в лист ожидания. |
|
clients* |
Массив объектов, содержащий информацию о клиентах (подробное описание) |
Параметр clients
|
Название |
Описание |
|
id* |
Идентификатор клиента, можно получить методом crm.item.list для контактов и компаний |
|
type* |
Тип клиента в формате
Cтруктуру объекта возвращает метод booking.v1.clienttype.list |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"waitListId":4,"clients":[{"id":1,"type":{"module":"crm","code":"CONTACT"}},{"id":2,"type":{"module":"crm","code":"CONTACT"}}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.waitlist.client.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"waitListId":4,"clients":[{"id":1,"type":{"module":"crm","code":"CONTACT"}},{"id":2,"type":{"module":"crm","code":"CONTACT"}}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/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: 4,
clients: [
{
id: 1,
type: {
module: 'crm',
code: 'CONTACT',
},
},
{
id: 2,
type: {
module: 'crm',
code: 'CONTACT',
},
},
],
},
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: 4,
clients: [
{
id: 1,
type: {
module: 'crm',
code: 'CONTACT',
},
},
{
id: 2,
type: {
module: 'crm',
code: 'CONTACT',
},
},
],
},
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>
try {
$response = $b24Service
->core
->call(
'booking.v1.waitlist.client.set',
[
'waitListId' => 4,
'clients' => [
[
'id' => 1,
'type' => [
'module' => 'crm',
'code' => 'CONTACT',
],
],
[
'id' => 2,
'type' => [
'module' => 'crm',
'code' => 'CONTACT',
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting waitlist clients: ' . $e->getMessage();
}
BX24.callMethod(
"booking.v1.waitlist.client.set",
{
waitListId: 4,
clients: [
{
id: 1,
type: {
module: "crm",
code: "CONTACT"
}
},
{
id: 2,
type: {
module: "crm",
code: "CONTACT"
}
}
]
},
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' => 4,
'clients' => [
[
'id' => 1,
'type' => [
'module' => 'crm',
'code' => 'CONTACT'
]
],
[
'id' => 2,
'type' => [
'module' => 'crm',
'code' => 'CONTACT'
]
]
]
]
);
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": 4,
"clients": []b24.Params{
{
"id": 1,
"type": b24.Params{
"module": "crm",
"code": "CONTACT",
},
},
{
"id": 2,
"type": b24.Params{
"module": "crm",
"code": "CONTACT",
},
},
},
})
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": 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 |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": 1040,
"error_description": "Wait list not found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
|
Не передан обязательный параметр внутри |
|
|
|
Список ожидания с указанным |
|
|
|
Не передан обязательный параметр |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |