Help Center/ Customer Engagement Center/ User Guide/ Tenant Administrator Guide/ Robot Management and Configuration Guide/ Configuring a Common IVR Flow/ Diagram Elements/ Interface Invoking

Interface Invoking

This diagram element is used when a third-party system interface needs to be invoked to implement a function. If no interface is selected, you can directly add parameters and assign values to the parameters to implement the function of the diagram element.

Diagram Element

Parameter Description

  • Node Name: name of a node.
  • Description: details of a node.
  • Interface Type: Select the type of the interface to be invoked. The options are inner interface and self defined interface. If inner interface is selected, the following three built-in interfaces are available:
    • Record Q&A: This interface used to record the survey ID, question title, user reply intention, original user reply, and other information.
    • Obtain the APIFabric token: This interface is used to obtain the API Fabric token. After a robot successfully invokes this interface, the token is recorded in the cache and can be directly obtained from the cache within the validity period. If the AK/SK is changed, the original cache is not cleared, and this interface fails to be invoked within the cache validity period. To invoke this interface immediately, you can bind the flow to a new robot.
    • Sentiment Recognition: This interface is used to recognize the emotion of a user or an agent and an emotion confidence level.
  • Invoked Interface: interface to be invoked. Select an interface added on the Resource Management > Business Interface page.
  • Variable assignment: variable name and variable value. The output parameter returned by the interface is valid only on the current node. If you want to use the value in subsequent flow nodes, define a variable here and assign the value of the output parameter to the variable.

    In a security subflow scenario:

    1. When the variable value is IVRREQUEST.input, the variable name must be a variable that is saved after being encrypted.
    2. If the variable value contains a variable that is saved after being encrypted and the variable name is not a variable that is saved after being encrypted, the system displays a message indicating that the expression contains an encrypted variable and data security should be concerned. However, the customer storage flow is not affected.
  • Condition branch: condition name and conditional expression. Define the branches of the exit of the current diagram element. For example, you can set a branch based on the value of an output parameter. Different subsequent flows can be specified for each branch.
  • Method Invocation: Built-in functions described in Built-in Functions can be used if data processing, such as truncation, length obtaining, conversion, and check, is required by businesses.

    In a security subflow scenario:

    1. If the method parameter contains a variable that is saved after being encrypted and the return value is not a variable that is saved after being encrypted, the system displays a message indicating that the expression contains an encrypted variable and data security should be concerned. However, the customer storage flow is not affected.

Condition Branch Description

Table 1 Condition branch description

Condition Branch

Description

Usage

SYSERROR_INNER

ODFS internal error

Triggered when an unknown error occurs in the ODFS. If no option is selected, the flow goes to the exception handling flow.

SYSERROR_INTERFACE

Interface invocation failure

Triggered when an interface invocation exception occurs. If no option is selected, the flow goes to the exception handling flow.

Using the Diagram Element

Click the diagram element or drag it to the canvas, and select the interface to be invoked. The invoked interface needs to be configured on the Resource > Business Interface page in advance. Alternatively, in the dialog box that is displayed, click Add to add an interface. If you use this diagram element to assign a value, you do not need to select an interface. Instead, you can directly add a cache variable and assign a value to it. In this case, you need to maintain global variables in advance.

Typical Application Scenario

If the fields returned from the invoked interface contain returnCode and the value of returnCode is 0, the operation is successful. Other values indicate that the operation fails.

Parent topic: Diagram Elements