Действия
Свой запрос
Агент получает данные из вашей системы по API и отвечает с их учётом.
С этим действием агент сам обращается к вашей системе по API. Это может быть CRM, учётная программа или сервер сайта. Агент узнаёт у клиента нужные данные, отправляет запрос и отвечает с учётом того, что вернула система. Например, называет статус заказа или свободное время мастера.
Что делает
В блоке «Что делает» дайте действию понятное «Название» и опишите в поле «Когда вызывать», в какой ситуации нужен запрос. Агент читает это описание и по нему решает, когда обратиться к системе.
Куда отправить
В блоке «Куда отправить» выберите тип запроса и укажите «Адрес».
| Тип | Когда нужен |
|---|---|
| Получить данные · GET | узнать что-то, например статус заказа |
| Отправить данные · POST | передать что-то в систему |
| Изменить данные · PUT | обновить существующую запись |
| Удалить · DELETE | удалить запись |
То, что зависит от клиента, пишите в адресе в двойных фигурных скобках, например {{order_id}}. Имя переменной пишется латиницей без пробелов. Кнопка «Вставить переменную» добавит её в адрес. Всё остальное уйдёт как написано.
Для POST и PUT появится поле «Тело запроса (JSON)». Переменные в нём работают так же, а кавычки и спецсимволы из ответов клиента экранируются автоматически.
Если система требует доступ, выберите «Авторизацию».
- Токен уйдёт в заголовке
Authorization: Bearer. - Ключ API уйдёт в заголовке с названием, которое вы укажете.
Агент не видит ключ и никогда не спрашивает его у клиента. Заголовки и параметры адреса настраиваются в разделе «Дополнительно», но обычно они не нужны.
Что спросить у клиента
Для каждой переменной из адреса и тела запроса агент сначала задаст клиенту вопрос. Напишите его в поле «Что спросить у клиента», например «номер заказа из письма с подтверждением». Рядом выберите тип ответа. Это может быть текст, число или ответ «да» или «нет».
Что агент увидит в ответе
Выберите, какую часть ответа системы передать агенту.
- Весь ответ — до 20 000 символов, остальное обрежется.
- Только отмеченные поля — агент увидит только нужное, а лишнее, например телефоны других клиентов, останется скрытым. Поля отмечаются после проверки запроса. Их можно указать и вручную, через точку, например
delivery.date, а для списков с квадратными скобками, напримерitems[].title.
Проверка
Справа есть панель «Проверка». Она работает без сохранения действия. Впишите, что мог бы ответить клиент, и нажмите «Проверить запрос». Появится ответ системы, а на вкладке «Агент увидит» видно, что получит агент. Если всё верно, нажмите «Сохранить».