Данные для сценариев

• HTTP-запросы
• SQL-запросы (Запросы к БД)

HTTP-запросы

Работа с HTTP-запросами

Это руководство поможет вам научиться создавать HTTP-запросы, редактировать их и использовать в сценариях на платформе.

1. Работа с HTTP-запросами

1.1. Просмотр списка запросов

1. Перейдите в раздел "HTTP-запросы".

2. На странице отображается список всех существующих запросов:

   • Поле поиска позволяет найти запрос по названию.

   • Фильтры помогут выбрать запросы, связанные с определёнными сценариями.

3. Чтобы создать новый запрос, нажмите кнопку "Создать HTTP-запрос".

1.2. Создание HTTP-запроса

1. После нажатия кнопки "Создать HTTP-запрос" откроется редактор.

2. В разделе "Основные данные":

   • Укажите название запроса.

   • Выберите тип запроса (например, GET или POST).

   • Вставьте URL-адрес для отправки запроса.

   • После заполнения основных данных вопрос можно сохранять, но лучше не делайте этого до получения результатов, совпадающих с настроенными принимаемыми результатами, чтобы избежать ошибок в реальных звонках при использовании запроса в сценариях.

3. В разделе "Входные параметры":

   • На вкладке "Параметры" добавьте ключи и значения параметров.

   • На вкладке "Заголовки" укажите заголовки запроса.

   • На вкладке "Тело" укажите структуру тела запроса, если это POST-запрос.

   • Обратите внимание, что если мы передаем либо в сам ключ, либо в значение название в «{{}}», то этот параметр будет передаваться из самого сценария в виде переменной. И он отобразится в поле «Переменные во входных параметрах»
      

4. В разделе "Принимаемые результаты":

   • Добавьте параметры, которые сервер возвращает в ответе.

   • Укажите вложенные параметры (до 5 уровней вложенности).

   • После добавления параметров нажмите "Сохранить запрос". Затем перейдите в раздел "Результаты", чтобы протестировать запрос.

     

1.3. Работа с разделом "Результаты"

1. После настройки нажмите кнопку "Получить результаты".

2. Запрос отправится, и вы увидите статус выполнения (например, 200 OK), а также время обработки запроса.

3. Сравните возвращённые результаты с указанными принимаемыми параметрами: совпадения подсвечиваются зелёным цветом, а несоответствия красным. Вы можете редактировать или удалять принимаемые параметры в этом разделе, чтобы уточнить настройки.

1.4. Сохранение запроса

1. Сохраняйте запрос только после того, как убедитесь, что принимаемые результаты совпадают с полученными в разделе "Результаты".

2. Если результаты не совпадают, скорректируйте принимаемые параметры или настройте запрос повторно, чтобы избежать ошибок в реальных звонках.

2. Использование HTTP-запросов в сценариях

2.1. Добавление блока "Отправить HTTP-запрос"

1. Перейдите в редактор сценариев.

2. Щелкните правой кнопкой мыши по рабочему пространству и выберите "Отправить HTTP-запрос".

2.2. Настройка блока

1. Выберите ранее созданный запрос из выпадающего списка.

2. Настройте входные параметры:

   • Для каждого параметра выберите переменную сценария, которая будет передавать значение.

3. Настройте принимаемые результаты:

   • Для каждого возвращаемого значения выберите переменную, которая будет использоваться в сценарии.
     
     

     №	Действие	Скрин
     1	Нажмите ПКМ по полотну и в появившемся списке выберите блок «Отправить HTTP-запрос»
     2	В выпадающем списке выбираем наш созданный запрос
     3	После выбора запроса в разделе «Входные параметры» как раз-таки появляется параметр, который мы добавляли
     4	Присваиваем ему переменную сценария «agent_id» (как создать переменную в сценарии читай тут) Таким образом, мы передаем значение переменной из сценария в значение ключа нашего HTTP-запроса
     5	Нажимаем на вкладку «Результаты запроса» и видим, что наш запрос возвращает значение «doctor_call»  Теперь также выбираем/создаем переменную из сценария, которой мы присвоим возвращаемое http-запросом значение
     6	Сохраняем блок

2.3. Проверка и сохранение

1. Убедитесь, что все входные параметры и результаты настроены корректно.

2. Сохраните изменения сценария.

3. Советы и рекомендации

• Тестируйте запросы отдельно в редакторе запросов перед сохранением и перед добавлением в сценарий: это поможет избежать ошибок при настройке сценария.

• Следите за вложенностью: Максимальная глубина вложенности принимаемых параметров — 5 уровней.

• Используйте понятные названия переменных в редакторе сценариев: Это упростит их использование в сценариях.

Примечание

Для дополнительной информации по настройке блоков сценариев ознакомьтесь с разделом "Редактор сценариев" в документации.

SQL-запросы (Запросы к БД)

Работа с SQL-запросами

Данное руководство поможет вам разобраться с настройкой баз данных, созданием SQL-запросов и их использованием в сценариях на платформе.

1. Работа с базами данных

1.1. Просмотр списка баз данных

1.2. Добавление новой базы данных

1.3. Настройка базы данных

2. Работа с SQL-запросами

2.1. Просмотр списка SQL-запросов

2.2. Создание SQL-запроса

2.3. Редактирование SQL-запроса

2.4. Удаление SQL-запроса

3. Использование SQL-запросов в сценариях

3.1. Добавление блока "Выполнить SQL-запрос"

3.2. Настройка блока

№	Действие	Скрин
1	Нажмите ПКМ по рабочему пространству и в появившемся списке выберите блок «Отправить запрос в базу»
2	В правом боковом меню в выпадающем списке выбираем наш созданный запрос
3	После выбора запроса в разделе «Входные параметры» как раз-таки появляется параметр, который мы добавляли (параметр, который будет передан в запрос)
4	Присваиваем ему переменную сценария «phone» (как создать переменную в сценарии читайте на странице «Работа с переменными») Таким образом, мы передаем значение переменной из сценария в наш запрос
5	Нажимаем на вкладку «Результаты запроса» и видим, что наш запрос возвращает столбец «user_id» Теперь также выбираем/создаем переменную из сценария, которой мы присвоим возвращаемое sql-запросом значение
6	Сохраняем блок

3.3. Проверка и сохранение сценария

4. Советы и рекомендации

Примечание

Для дополнительной информации по настройке блоков сценариев ознакомьтесь с разделом "Редактор сценариев" в документации.