Елемент API запит в чат-ботах

Автоматизувати процес стало ще простіше з API запитами. За допомогою цього функціоналу ви зможете, наприклад, за назвою міста повідомляти погоду, за назвою товару здійснювати пошук та виводити результат у чат-бот, за даними підписника реєструвати його на захід або створювати замовлення.

Це працює так: ви надсилаєте запити даних у зовнішні системи про будь-яку інформацію, якою цікавиться ваш користувач або створюєте новий об’єкт. У відповідь ви дістаєте дані, які можна відразу видавати користувачу в повідомленні або записувати в змінну чат-бота.

Як надіслати запит на отримання даних

Перетягніть елемент Запит API (API Request) на робоче поле, з’єднайте його з елементом, після якого потрібно отримати інформацію.

Виберіть тип запиту:

• GET запит зазвичай використовують для отримання наявних даних;
• POST запит зазвичай використовують для створення нового об’єкта в системі та отримання інформації про нього.

Введіть URL-адресу, на яку буде відправлено запит. У запиті можете використовувати користувальницькі та глобальні змінні вашого чат-бота та модифікувати їх.

Ви можете додавати заголовки запиту, наприклад, для авторизації запитів. Також можна використовувати змінні бота в заголовках запиту.

Якщо ви використовуєте запит POST, введіть тіло запиту в потрібному полі в JSON з параметрами. Ви також можете модифікувати тіло запиту.

Натисніть Перевірити запит (Test Request), щоб перевірити надсилання даних. Також перевірка стане в пригоді для розпізнавання даних під час подальшого налаштування.

Як використовувати отримані дані

У разі успішного запиту ви отримаєте тіло відповіді та користувач пройде гілкою Виконано.

По гілці Виконано (Done) будуть йти всі відповіді запитів зі статусом 2хх. Відповіді запитів з іншими статусами підуть по гілці Помилка (Error) і дані не можна буде використовувати. Читайте докладніше: Як продовжити ланцюжок у разі помилки запиту.

Отримані дані можна використати один раз у наступному текстовому блоці, записати у змінну чат-бота для багаторазового використання або надіслати картки повідомлень на основі зазначеного масиву.

API може повертати відповідь до 65 КБ в розмірі. Часовий ліміт на обробку запиту становить 60 секунд.

Використання даних зі збереженням у змінну

Щоб зберегти дані у змінні для подальшого використання, в елементі Запит API (API Request) перейдіть у вкладку Зберігати значення (Save values) і в налаштуваннях відповідностей натисніть Додати (Add).

З поля відповіді виберіть ключ, значення змінної якого вам потрібно використовувати.

Виберіть змінну, до якої потрібно зберігати значення. Ви можете зберегти значення до 1024 символів з поля у відповіді.

Коли ви зберегли необхідну кількість змінних, натисніть Застосувати (Apply) та перейдіть до створення наступного блоку.

У прикладі нижче ми створили замовлення, дістали дані у відповідь із нашої CRM, зберегли їх у змінні та повідомляємо користувачеві для швидкої ідентифікації замовленої послуги чи товару.

Для користувача спілкування з вашим чат-ботом виглядає так:

Використання даних у вигляді виразу JSON Path

Якщо вам не потрібно записувати дані до змінних, можете використовувати отриману інформацію вставкою виразу шляху JSON структури.

Для цього після перевірки запиту та отримання успішної відповіді натисніть Додати (Add) знайдіть змінну та скопіюйте JSON Path з поля відповіді.

Потім натисніть Застосувати (Apply) та перейдіть до створення наступного елементу.

Дані, які ви не записуєте, можна використовувати лише один раз у наступному текстовому блоці.

У тексті повідомлення додайте JSON Path {{$['somekey']['nestedkey']}}.

Для користувача спілкування з вашим чат-ботом із цього прикладу виглядає так:

Використання для надсилання карток

На платному тарифі доступне також надсилання карток, сформованих із даних, які будуть отримані у відповідь на запит. Для цього перейдіть у вкладку Відправляти повідомлення (Send messages) і заповніть поля форми даними з отриманого масиву.

Дізнайтеся більше: Як надсилати картки повідомлень у чат-ботах.

Як продовжити ланцюжок у разі помилки запиту

Також ви можете розгалузити сценарій і у разі неуспішного API запиту продовжити ланцюжок по гілці Помилка (Error). Наприклад, ви можете повідомити про помилку та перепитати необхідні дані, якщо вони не збігаються, або покликати менеджера.

Оновлено: 01.07.2024