Overview

Updated on 2023-09-27 GMT+08:00

View PDF

The Online Intelligent Assistant Platform (OIAP) provides interfaces for the interactive voice response (IVR), chat app, CSP, or CEC to meet the requirements of intelligent interaction scenarios.

NOTE:

IP:PORT in all URLs indicates the IP address and port number of the OIAP on the NSLB.

Typical Interaction Sequence

Step 1 Obtain the token.
Check whether the OIAP needs to interconnect with an internal system (such as the CEC or CSP) or a tenant (third-party system).

If a third-party system needs to be interconnected, obtain a token using the tenant ID (C3 OIAP Interface Authentication) and invoke the interface within the token validity period. The obtained token must be transferred for each interface invocation.

If an internal system (the CEC or CSP) needs to be interconnected, obtain a token using the default user specified for system interconnection (C3 OIAP Interface Authentication) and invoke the interface within the token validity period. The obtained token must be transferred for each interface invocation.
Step 2 Establish the binding relationship with the OIAP.
After a token is obtained, a third-party system can query activated domains (Domain Query Interface) based on the tenant and language information and bind third-party access codes to domains (Interface for Querying Dialog ID Binding Relationships).
Step 3 Complete the dialog interaction.
After the access codes are bound to domains in the OIAP, the dialog interfaces (Dialog Interfaces) of the OIAP can be invoked for dialog interaction, for example, initialization, voice playing, call transfer, and hang-up.

Common Error Codes

**Table 1** Common error codes
Error Code	Description
900001	No token information exists or the token has expired.
900002	Failed to check the token information.
10000001	Internal error, which is usually caused by an application system fault.
10000002	The parameter is incorrect. Generally, the request does not provide all mandatory fields.
10000006	The interface input parameter with the same name already exists.
10000007	The interface output parameter with the same name already exists.
10000008	The interface header parameter with the same name already exists.
10000003	The parameter does not exist. You must enter the parameter.
10000004	The parameter already exists in the system and cannot be used again.
20000001	The flow in the released state cannot be modified.
20000002	The flow name already exists.
20000003	Failed to delete the node. The node is referenced by another flow.
20000004	Failed to delete the variable. The variable is referenced by a flow or template.
20000005	Failed to modify the variable. The original variable is referenced by a flow or template.
20000006	The file path does not exist.
20000007	An I/O exception occurred. Failed to read the file stream.
20000008	An error occurred when updating data.
200900002	Internal error, which is usually caused by an application system fault.
200900003	The parameter is incorrect. Generally, the request does not provide all mandatory fields.
200800001	The key does not exist.
200800002	The key is incorrect.
200800003	The account is locked.