Gallery

Docs

История изменений

История релизов

НАЧАЛО РАБОТЫ С ПЛАТФОРМОЙ

ПЕРЕД СОЗДАНИЕМ АГЕНТА

КОНСТРУКТОР СЦЕНАРИЯ АГЕНТА

СОЗДАНИЕ АГЕНТА НА ПЛАТФОРМЕ

ОБУЧЕНИЕ И ТЕСТИРОВАНИЕ АГЕНТА

РАЗМЕЩЕНИЕ АГЕНТА В КАНАЛАХ

ЭКСПЛУАТАЦИЯ АГЕНТА

АНАЛИТИКА ОБЩЕНИЯ АГЕНТА

Explore

КОНСТРУКТОР СЦЕНАРИЯ АГЕНТА

Вкладка внешних запросов — External Requests

Вкладка EXTERNAL REQUESTS — вкладка, на которой создаются

@Внешний запрос⁠

для дальнейшего их использования в

@Агент⁠

ах

@Компания⁠

Переход на вкладку Внешних запросов

В список

@Внешний запрос⁠

@Компания⁠

можно перейти двумя способами:

перейти на вкладку Resourses (

Вкладка ресурсов Компании — Resourses⁠

) и нажать кнопку External Requests;

перейти в

@БотБилдер⁠

@Агент⁠

а и открыть вкладку External Requests.

Список Внешних запросов

На вкладке

@Внешний запрос⁠

представлен список всех

@Внешний запрос⁠

@Компания⁠

⁠

Name — названия

@Внешний запрос⁠

ов;

⁠

Кнопка сортировки

@Внешний запрос⁠

ов по алфавиту;

⁠

По нажатию кнопки сортировка

@Внешний запрос⁠

ов меняется: от начала алфавита к концу и наоборот.

Method and URL — URL назначения, куда должен быть отправлен запрос и метод HTTP запроса;

⁠

In use — использование

@Внешний запрос⁠

ов в

@Агент⁠

ах;

⁠

Напротив каждого

@Внешний запрос⁠

а, используемого в

@Агент⁠

ах, проставлена галочка и кнопка Clarify;

⁠

По нажатию кнопки Clarify выводятся иконки

@Агент⁠

ов, в которых используется

@Внешний запрос⁠

⁠

Поиск по Внешним запросам

Поиск по имени Внешнего запроса

Для совершения поиска по имени

@Внешний запрос⁠

а необходимо ввести искомое значение в поле поиска.

В списке будут выведены только

@Внешний запрос⁠

ы, содержащие в названии искомую строку;

⁠

Поиск по использованию Внешнего запроса

Поиск по использованию

@Внешний запрос⁠

а в

@Агент⁠

ах производится с помощью фильтров In use и Not in use.

По нажатию на кнопку In use выводятся

@Внешний запрос⁠

ы, используемые в

@Агент⁠

ах;

⁠

По нажатию на кнопку In use вместо фильтра Not in use выводится фильтр Agent — фильтр по

@Агент⁠

ам.

По нажатию на кнопку Agent открывается панель поиска по

@Агент⁠

ам.

⁠

Чтобы найти

@Внешний запрос⁠

ы, которые используются в определенных

@Агент⁠

ах, необходимо кликнуть по необходимым

@Агент⁠

ам в списке.

По нажатию на кнопку Not in use выводятся

@Внешний запрос⁠

ы, не используемые в

@Агент⁠

ах.

⁠

Создание, изменение и удаление Внешних запросов

Создание Внешнего запроса

Чтобы создать

@Внешний запрос⁠

ы, необходимо:

Перейти в список

@Внешний запрос⁠

ов.

Нажать кнопку Create new.

⁠

По нажатию кнопки на панели справа откроется форма создания нового

@Внешний запрос⁠

а.

Необходимо заполнить поля на вкладках формы создания

@Внешний запрос⁠

а.

Вкладка Main

Вкладка Main содержит базовые данные

@Внешний запрос⁠

а.

⁠

Поля вкладки:

Name* — название

@Внешний запрос⁠

. Максимальная длина значения поля — 1000 символов.

Description — описание

@Внешний запрос⁠

. Максимальная длина значения поля — 1000 символов.

Метод запроса* — HTTP метод для данного запроса. По умолчанию установлен метод GET.

GET

POST

PUT

PATCH

DELETE

HEAD

Endpoint* — адрес вебхука, на который будет отправлен данный

@Внешний запрос⁠

. Максимальная длина значения поля — 1000 символов.

Формат значения:

Строка

⁠

@Контекстная переменная⁠

в формате {{ var }}

⁠

@Выражение⁠

или

@Выражение с управляющей конструкцией⁠

. Подробнее:

Использование синтаксиса в External Request⁠

⁠

Вкладка Headers

На вкладке Headers можно добавить заголовки к

@Внешний запрос⁠

у.

⁠

Поля и кнопки вкладки:

Header* — название заголовка. Максимальная длина значения поля — 1000 символов.

Value* — значение заголовка. Максимальная длина значения поля — 1000 символов.

Формат значения: допустимо использование

@Выражение⁠

или

@Выражение с управляющей конструкцией⁠

Кнопка крестика удаляет заголовок (строку).

Add new field — кнопка добавления нового заголовка.

Вкладка Query parameters

На вкладке Query parameters можно прописать параметры, которые будут подставлены к URL запроса.

⁠

Поля и кнопки вкладки:

Parameter* — название параметра. Максимальная длина значения поля — 1000 символов.

Кодировка символов не латинского алфавита: Допускаются пробелы, спецсимволы и не латинский символы, будет произведено кодирование значение параметра при выполнении запроса.

Важно: Параметры запроса (имена и значения) будут закодированы в любом случае при подстановке в
@Итоговый URL внешнего запроса⁠
, во избежание двойной кодировки на вкладке Query parameters стоит указывать параметры в незакодированном виде.

Value* — значение параметра.

Формат значения: допустимо использование

@Выражение⁠

или

@Выражение с управляющей конструкцией⁠

Пример:

⁠

Такой параметр будет включен в

@Итоговый URL внешнего запроса⁠

в виде query=%D0%B0%D0%B1%D0%B2%D0%B3%D0%B4

Важно: Параметры запроса (имена и значения) будут закодированы в любом случае при подстановке в
@Итоговый URL внешнего запроса⁠
, во избежание двойной кодировки на вкладке Query parameters стоит указывать параметры в незакодированном виде.

Кнопка крестика удаляет параметр (строку).

Add new field — кнопка добавления нового параметра.

Вкладка Data

На вкладке Data можно указать данные в JSON или XML, которые будут отправлены в теле запроса (BODY)

⁠

Поля вкладки:

Data type — формат отправляемых данных (BODY в Request):

Формат по умолчанию: JSON

Форматы:

JSON

XML

Важно: при выборе формата не забывать указывать соответствующий заголовок content-type: application/json или content-type: application/xml

Поле для добавления шаблона тела запроса (BODY), которое будет отправлено. Максимальная длина значения поля — 1000 символов.

Формат: для корректной работы с REST API должен соблюдаться формат JSON или XML в соответствии со спецификацией API назначения.

При Data type: JSON

произвольный текст.

При Data type: XML

синтаксис XML

регистр тегов имеет значение — <var></Var> будет считаться незакрытым тегом и запрос не будет выполнен

Важно: при копировании и вставке текста из сторонних систем в поле Data (например, тело запроса прислали в Slack), могут быть вставлены недопустимые символы кавычек, которые “сломают” тело запроса (JSON, XML) и сервер не сможет принять такой запрос. Визуально "неправильные” кавычки мало отличаются от “правильных”, но это все же другие символы. Примеры: