Данные для сценариев
HTTP-запросы
Работа с HTTP-запросами
Это руководство поможет вам научиться создавать HTTP-запросы, редактировать их и использовать в сценариях на платформе.
1. Работа с HTTP-запросами
1.1. Просмотр списка запросов
-
Перейдите в раздел "HTTP-запросы".
-
На странице отображается список всех существующих запросов:
-
Поле поиска позволяет найти запрос по названию.
-
Фильтры помогут выбрать запросы, связанные с определёнными сценариями.
-
-
Чтобы создать новый запрос, нажмите кнопку "Создать HTTP-запрос".
1.2. Создание HTTP-запроса
-
После нажатия кнопки "Создать HTTP-запрос" откроется редактор.
-
В разделе "Основные данные":
-
Укажите название запроса.
-
Выберите тип запроса (например, GET или POST).
-
Вставьте URL-адрес для отправки запроса.
- После заполнения основных данных вопрос можно сохранять, но лучше не делайте этого до получения результатов, совпадающих с настроенными принимаемыми результатами, чтобы избежать ошибок в реальных звонках при использовании запроса в сценариях.
-
-
В разделе "Входные параметры":
-
На вкладке "Параметры" добавьте ключи и значения параметров.
-
На вкладке "Заголовки" укажите заголовки запроса.
-
На вкладке "Тело" укажите структуру тела запроса, если это POST-запрос.
- Обратите внимание, что если мы передаем либо в сам ключ, либо в значение название в «{{}}», то этот параметр будет передаваться из самого сценария в виде переменной. И он отобразится в поле «Переменные во входных параметрах»
-
-
В разделе "Принимаемые результаты":
1.3. Работа с разделом "Результаты"
-
После настройки нажмите кнопку "Получить результаты".
-
Запрос отправится, и вы увидите статус выполнения (например, 200 OK), а также время обработки запроса.
-
Сравните возвращённые результаты с указанными принимаемыми параметрами: совпадения подсвечиваются зелёным цветом, а несоответствия красным. Вы можете редактировать или удалять принимаемые параметры в этом разделе, чтобы уточнить настройки.
1.4. Сохранение запроса
-
Сохраняйте запрос только после того, как убедитесь, что принимаемые результаты совпадают с полученными в разделе "Результаты".
-
Если результаты не совпадают, скорректируйте принимаемые параметры или настройте запрос повторно, чтобы избежать ошибок в реальных звонках.
2. Использование HTTP-запросов в сценариях
2.1. Добавление блока "Отправить HTTP-запрос"
-
Перейдите в редактор сценариев.
-
Щелкните правой кнопкой мыши по рабочему пространству и выберите "Отправить HTTP-запрос".
2.2. Настройка блока
-
Выберите ранее созданный запрос из выпадающего списка.
-
Настройте входные параметры:
-
Для каждого параметра выберите переменную сценария, которая будет передавать значение.
-
-
Настройте принимаемые результаты:
-
Для каждого возвращаемого значения выберите переменную, которая будет использоваться в сценарии.
№
Действие
Скрин
1
Нажмите ПКМ по полотну и в появившемся списке выберите блок «Отправить HTTP-запрос»
2
В выпадающем списке выбираем наш созданный запрос
3
После выбора запроса в разделе «Входные параметры» как раз-таки появляется параметр, который мы добавляли
4
Присваиваем ему переменную сценария «agent_id» (как создать переменную в сценарии читай тут)
Таким образом, мы передаем значение переменной из сценария в значение ключа нашего HTTP-запроса
5
Нажимаем на вкладку «Результаты запроса» и видим, что наш запрос возвращает значение «doctor_call»
Теперь также выбираем/создаем переменную из сценария, которой мы присвоим возвращаемое http-запросом значение
6
Сохраняем блок
-
2.3. Проверка и сохранение
-
Убедитесь, что все входные параметры и результаты настроены корректно.
-
Сохраните изменения сценария.
3. Советы и рекомендации
-
Тестируйте запросы отдельно в редакторе запросов перед сохранением и перед добавлением в сценарий: это поможет избежать ошибок при настройке сценария.
-
Следите за вложенностью: Максимальная глубина вложенности принимаемых параметров — 5 уровней.
-
Используйте понятные названия переменных в редакторе сценариев: Это упростит их использование в сценариях.
Примечание
Для дополнительной информации по настройке блоков сценариев ознакомьтесь с разделом "Редактор сценариев" в документации.
SQL-запросы (Запросы к БД)
Работа с SQL-запросами
Данное руководство поможет вам разобраться с настройкой баз данных, созданием SQL-запросов и их использованием в сценариях на платформе.
1. Работа с базами данных
1.1. Просмотр списка баз данных
-
Перейдите в раздел "Базы данных".
-
На странице отображается список подключённых баз данных:
-
Статус подключения (например, "Подключена" или "Ошибка") отображает текущее состояние доступа к базе данных.
-
Если статус "Ошибка", попробуйте обновить статусы подключений. Если ошибка сохраняется, проверьте настройки базы данных.
-
-
Для добавления новой базы данных нажмите кнопку "Добавить базу данных".
1.2. Добавление новой базы данных
-
Нажмите кнопку "Добавить базу данных".
-
Введите следующие параметры:
-
Название базы данных.
-
Тип базы данных (например, Oracle, MySQL, PostgreSQL).
-
Хост, порт, имя пользователя, пароль и имя базы данных.
-
-
Нажмите кнопку "Добавить базу данных" для сохранения.
-
После добавления база появится в списке. Убедитесь, что статус подключения отображается как "Подключена".
1.3. Настройка базы данных
-
Нажмите на иконку параметров (шестерёнка) напротив нужной базы данных в списке.
-
Откроется модальное окно с параметрами базы данных:
-
Вы можете изменить название, тип базы данных, хост, порт, имя пользователя, пароль и имя базы данных.
-
Для сохранения изменений нажмите "Сохранить изменения".
-
-
Для удаления базы данных нажмите кнопку "Удалить базу данных".
-
Если база данных используется в запросах, система уведомит вас о невозможности удаления и покажет список связанных запросов.
-
2. Работа с SQL-запросами
2.1. Просмотр списка SQL-запросов
-
Перейдите в раздел "SQL-запросы".
-
На странице отображается список всех созданных SQL-запросов:
-
Колонка "Базы данных и сценарии" отображает, к каким базам данных и в каких сценариях использован запрос.
-
Используйте поле поиска для поиска запросов по названию.
-
Вы можете фильтровать запросы по базам данных или сценариям.
-
-
Для создания нового SQL-запроса нажмите кнопку "Создать SQL-запрос".
2.2. Создание SQL-запроса
-
Нажмите кнопку "Создать SQL-запрос".
-
В открывшемся редакторе выполните следующие действия:
-
В разделе "Основные данные" укажите название запроса и выберите базу данных из выпадающего списка.
-
В разделе "SQL-запрос" введите текст SQL-запроса.
- После этого доступно сохранение запроса, но сохранять запрос без успешного получения результата крайне не рекомендуется, потому что это может привести к ошибкам в реальных диалогах при использовании такого запроса в сценарии впоследствии.
-
В разделе "Переменные во входных параметрах", если такие есть, добавьте параметры запроса:
-
Укажите имя переменной.
-
Задайте тип переменной ("Число" или "Строка").
-
-
-
Для проверки запроса нажмите кнопку "Получить результаты":
-
Отобразятся результаты выполнения запроса.
-
Убедитесь, что запрос выполняется корректно, и результаты соответствуют ожидаемым.
-
-
Нажмите кнопку "Сохранить запрос" для завершения.
2.3. Редактирование SQL-запроса
-
Для редактирования существующего запроса выберите его из списка и нажмите на его название.
-
Внесите изменения в открывшемся редакторе.
-
Нажмите кнопку "Сохранить запрос" для сохранения изменений.
2.4. Удаление SQL-запроса
3. Использование SQL-запросов в сценариях
3.1. Добавление блока "Выполнить SQL-запрос"
-
Перейдите в редактор сценариев.
-
Щелкните правой кнопкой мыши по рабочему пространству и выберите "Выполнить SQL-запрос".
3.2. Настройка блока
-
Выберите созданный SQL-запрос из выпадающего списка.
-
Настройте входные параметры:
-
Для каждого параметра выберите переменную сценария, которая будет передавать значение.
-
-
Настройте результаты запроса:
-
Для каждого возвращаемого значения выберите переменную, которая будет использоваться в сценарии.
-
№ |
Действие |
Скрин |
1 |
Нажмите ПКМ по рабочему пространству и в появившемся списке выберите блок «Отправить запрос в базу» |
|
2 |
В правом боковом меню в выпадающем списке выбираем наш созданный запрос |
|
3 |
После выбора запроса в разделе «Входные параметры» как раз-таки появляется параметр, который мы добавляли (параметр, который будет передан в запрос) |
|
4 |
Присваиваем ему переменную сценария «phone» (как создать переменную в сценарии читайте на странице «Работа с переменными») Таким образом, мы передаем значение переменной из сценария в наш запрос |
|
5 |
Нажимаем на вкладку «Результаты запроса» и видим, что наш запрос возвращает столбец «user_id» Теперь также выбираем/создаем переменную из сценария, которой мы присвоим возвращаемое sql-запросом значение |
|
6 |
Сохраняем блок |
3.3. Проверка и сохранение сценария
-
Убедитесь, что все входные параметры и результаты настроены корректно.
-
Сохраните изменения сценария.
4. Советы и рекомендации
-
Тестируйте запросы отдельно перед сохранением в редакторе SQL-запросов: это поможет избежать ошибок при настройке сценария.
-
Следите за статусом подключения баз данных: корректная работа SQL-запросов зависит от доступности баз данных.
-
Используйте понятные названия переменных: это упростит их использование в сценариях.
Примечание
Для дополнительной информации по настройке блоков сценариев ознакомьтесь с разделом "Редактор сценариев" в документации.