...
| Redirect to URL | |
|---|---|
|
|
...
|
Перед использованием данной статьи убедитесь что:
- У вас установлено приложение TWIN для YCLIENTS.
- Для интеграции вы используете телефонию CIS или чаты.
Описание функции
Запись в YCLIENTS
...
Запись в Yclients создаётся при помощи следующей BPL-операции:
| Блок кода | ||||
|---|---|---|---|---|
| ||||
yclients.createRecord(salonId, params) |
, где:
- salonId
...
- : ID филиала в
...
- YCLIENTS,
- params
...
- : список параметров записи, в котором:
staffId – идентификатор сотрудника (обязательный параметр).
services – список услуг (обязательный параметр).
| Название параметра | Обязательный параметр | Значение |
|---|---|---|
| staffId | Да | Идентификатор сотрудника |
| services | Да | Список услуг, где каждый элемент это ассоциативный массив: |
...
id |
...
– |
...
идентификатор услуги |
| client |
...
| Да | Информация о клиенте |
...
phone – номер телефона клиента (обязательный параметр).
: phone – Номер телефона клиента name – Имя клиента (используется |
...
, если это новый клиент) |
...
...
...
– |
...
Email клиента |
| datetime |
...
seanceLength - длительность сеанса, сек (обязательный параметр).
| Да | Дата и время | |
| seanceLenght | Да | Длительность сеанса, в секундах |
| saveIfBusy | Нет | Сохранять |
...
ли запись если время занято или нерабочее (по умолчанию false) |
| sendSms |
...
| Нет | Отправлять ли смс с деталями записи клиенту (по умолчанию false) | |
| comment |
...
| Нет | Комментарий к записи | |
| smsRemainHours |
...
| Нет | За сколько часов до визита следует выслать смс напоминание клиенту |
...
0 – если не нужно, по умолчанию 1) |
| emailRemainHours |
...
| Нет | За сколько часов до визита следует выслать email напоминание клиенту |
...
0 – если не нужно, по умолчанию 12) |
| attendance |
...
| Нет | Статус записи (2 - Пользователь подтвердил запись, |
...
1 – Пользователь пришел, услуги оказаны, |
...
0 – ожидание пользователя, - |
...
1 – пользователь не пришел на визит, по умолчанию 0) |
| customFields |
...
| Нет | Ассоциативный массив дополнительных полей, заполняется согласно настроенным полям в филиале | |
| recordLabels |
...
| Нет | Список идентификаторов категорий записи | |
| customColor |
...
| Нет | Цвет записи (по умолчанию null) | |
| apiId |
...
| Нет | Идентификатор внешней системы (по умолчанию null) |
Пример использования в сценарии
Для создания записи:
- добавьте в сценарий блок Арифметическая операция,
- Выберите тип Произвольный тип,
- В поле BPL-выражение напишите функцию с нужными вам полями,
- Нажмите кнопку Преобразовать BPL в AST.
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
$recordId = yclients.createRecord(25344, {"staffId": 2303331, "services": [{"id": 11428840}], "client": {"phone": "79876543210", "name": "Семён", "email": "semen@gmail.com"}, "datetime": "2023-06-07 15:00", "seanceLength": 3600,"saveIfBusy": false, "sendSms": false, "comment": "Комментарий к записи", "smsRemainHours": 1, "emailRemainHours": 12, "attendance": 2, "customFields": {"priority":"high"}, "recordLabels": ["67345", "78549"], "customColor": nil, "apiId": "7894"}); |
После выполнения функции в YCLIENTS будет создана запись, а в переменную $recordId будет сохранён её ID.
Его можно использовать далее в сценарии бота для других операций с созданной записью.