Customizing the Http Call widget for Zoom Virtual Agent
Zoom Virtual Agent admins can add and edit the Http Call widget. The Http Call widget allows you to request information from an external data source using Http. The returned content can be written to a variable and the variable can be stated back to the user using the Send Media widget.
For example, a customer wants to know something specific about a particular order. You can make an Http call with their order number. The information returned can be stored as a variable such as ship-date or arrival-date. You can use this variable throughout the flow for even more personalization.
Note: This feature requires knowledge of web development including Http requests. You also need access to a database that can accept Http requests.
Prerequisites for customizing the Http Call widget
- Account owner or admin privileges; or relevant role/privilege
- Basic, Pro, Business, Education, or Enterprise account
- Zoom Virtual Agent license
- Bot Flow created
How to edit the Http Call widget
- Sign in to the Zoom web portal.
- In the navigation menu, click AI Management and then Virtual Agents.
- Click the display name of an existing chatbot.
- Click the Bot Flows tab.
- Click the display name of an existing bot flow.
- In the left-side widgets panel, click and drag Http Call onto the preferred location in the flow.
- Select the Http Call widget.
- (Optional) In the right-side panel, click Rename to change the display name of the widget.
- In the Settings tab, customize these settings:
Request URL: Specify request URL.
Request Method: Select a standard HTTP request type (GET, POST, PUT, PATCH, DELETE).
Content Type: Specify content type for request body (for example, JSON).
Body: Optional part of the HTTP request which is used to send additional data to the server.
Authorization: Enter the authorization header value to authenticate your access to the external resource.
Result: Specify variables that will be returned by the HTTP call. This field should be a semicolon separated list of top-level JSON keys returned by the API in the response body. The keys can then be referenced in subsequent text to speech prompts by referencing the widget name and the json key name that you configure in this field.
Custom Headers: Pass more information about the request so the server knows how to deal with the information. For example, you can pass an API key to connect to a database.
- (Optional) Click the Retry After Failed or Timeout Request toggle to allow retries after HTTP requests and specify the number of retry requests.
- Click the Exits tab to customize exit settings.
Success: Select the destination widget if the HTTP call succeeds.
Fail: Select the destination widget if the HTTP call fails.