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