# Interface Documentation

Manage DUIX created applications, including concurrency management, session queries, session closure, third-party dialogue integration, etc.

# Usage Notes

  1. Clients obtain tokens using appId and appSecret. All management interface HTTP Headers must include the token to request corresponding interfaces.
  2. To ensure conversation quality, third-party dialogue interfaces provided for DUIX access must achieve response times within 20 seconds.

# Interaction Flow

image.png

# Common Request Headers

Field Type Required Description
token String Y Token obtained through appId and appSecret

# Common Response Parameters

After DUIX receives the token and other request data sets, it will first perform security checks and other verifications. After a series of verifications pass, it will process the data request sent. The platform's response parameter format is as follows:

Field Type Required Description
code String Y Response status code, 0 indicates success
message String N Success/error description message
data object N Specific response content
success Boolean Y Whether successful

Unless otherwise specified below, the interpretation of return values refers to the structure within data.

# Common Error Codes

Error Code Description
0 Normal
-1 System exception
1005 Token cannot be empty
1006 Token expired
1007 Dialogue information does not exist
1009 Insufficient available user attempts
2002 Session information does not exist
40001 Invalid appid or appsecret
40002 Internal error