Перед началом работы убедитесь, что:
-
У вас установлено приложение TWIN для YCLIENTS.
-
Для интеграции вы используете телефонию CIS или чаты.
¶ Описание функции
Запись в YCLIENTS создается при помощи следующей BPL-операции:
yclients.createRecord(salonId, params)
где:
-
salonId— ID филиала в YCLIENTS. Находится в YCLIENTS разделе Обзор → Сводка. -
params— список параметров записи, в котором:
| Название параметра | Обязательность параметра | Значение |
|---|---|---|
| staffId | Да | Идентификатор сотрудника. Для получения ID перейдите в YCLIENTS в раздел Настройки → Сотрудники. Выберите необходимого сотрудника и откройте ссылку с ним в новой вкладке. Скопируйте последнее число из адресной строки. |
| services | Да | Список услуг, где каждый элемент представляет собой ассоциативный массив, содержащий id – идентификатор услуги. ID услуги отображается последним числом в адресной строке браузера после её создания. Также ID услуги отображается в отчете по услугам в YCLIENTS. Чтобы выгрузить отчет по услугам перейдите в раздел Настройки → Услуги, нажмите Операции с Excel → Выгрузить в Excel. |
| client | Да | Информация о клиенте: phone – номер телефона клиента. name – имя клиента (используется, если это новый клиент). email – email клиента. |
| datetime | Да | Дата и время в формате yyyy-MM-dd HH:mm. |
| seanceLenght | Да | Длительность сеанса в секундах. |
| saveIfBusy | Нет | Сохранять ли запись, если время занято или нерабочее. По умолчанию false. |
| sendSms | Нет | Отправлять ли sms с деталями записи клиенту. По умолчанию false. |
| comment | Нет | Комментарий к записи. |
| smsRemainHours | Нет | За сколько часов до визита следует выслать sms-напоминание клиенту. По умолчанию – 1, если не нужно – 0. |
| emailRemainHours | Нет | За сколько часов до визита следует выслать email-напоминание клиенту По умолчанию – 12, если не нужно – 0. |
| attendance | Нет | Статус записи: 2 - клиент подтвердил запись; 1 – клиент пришел, услуги оказаны; 0 – ожидание клиента; -1 – клиент не пришел на визит. По умолчанию – 0. |
| customFields | Нет | Ассоциативный массив дополнительных полей. Заполняется согласно настроенным полям в филиале. |
| recordLabels | Нет | Список идентификаторов категорий записи. |
| customColor | Нет | Цвет записи. По умолчанию null. |
| apiId | Нет | Идентификатор внешней системы. По умолчанию null. |
¶ Пример использования в сценарии
Для создания записи выполните следующее:
-
Добавьте в сценарий блок Выражение.
-
Нажмите кнопку Открыть редактор. Появится окно с формой Ввод BPL-выражения.
-
В поле Содержимое ввода напишите функцию с нужными вам полями.
-
Нажмите Сохранить.
¶ Пример функции на добавление записи
$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, который можно использовать далее в сценарии для других операций с созданной записью.