Interface for Querying Dialog ID Binding Relationships
Description
This interface is used to query the session ID binding relationships.
Interface Method
POST
URL
https://IP:PORT/oifde/rest/api/querynavigationinfo
Request
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
tenantId |
String |
Body |
Yes |
Tenant ID. |
accessCode |
String |
Body |
No |
Access ID. If this parameter is not passed, all binding relationships of the tenant are queried. If this parameter is passed, the pageNum and pageSize parameters need to be passed. The value can contain a maximum of 20 characters. |
pageNum |
String |
Body |
Yes |
Page number. Number of the page to be queried. The value 1 is for the first page. |
pageSize |
String |
Body |
Yes |
Number of records on each page. The value can be 5, 10, 20, 50, or 100. |
authToken |
String |
Body |
Yes |
Authentication token. For details, see C3 OIAP Interface Authentication. |
source |
String |
Body |
No |
Source device that initiates a dialog. |
Response
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
errorCode |
Integer |
Body |
No |
Error code. If the operation is successful, no error code is returned. If the operation fails, see Common Error Codes. |
errorMsg |
String |
Body |
No |
Error description. |
total |
Long |
Body |
Yes |
Total number of records. |
accessInfoList |
accessInfo[] |
Body |
Yes |
Dialog binding relationship list in an array. |
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
accessId |
String |
Body |
Yes |
Internal sequence number. |
tenantId |
String |
Body |
Yes |
Tenant ID. |
accessCode |
String |
Body |
Yes |
Access code (called number). |
domainId |
Integer |
Body |
No |
Domain ID. |
dialogType |
Integer |
Body |
Yes |
Dialog type.
|
flowCode |
String |
Body |
No |
Flow code. |
flowName |
String |
Body |
No |
Flow name. |
description |
String |
Body |
No |
Description. |
source |
String |
Body |
No |
Source device that initiates a dialog.
|
chatBotName |
String |
Body |
No |
Chatbot name. |
usingRecordService |
Integer |
Body |
No |
Whether to use VoiceCyber for recording.
|
Example
- Request
{ "tenantId": "tenant001", "accessCode": "10086" , "pageNum": "1" , "pageSize": "10" , "authToken": "0dbe1**************b505de" , "source": "OIFDE" }
- Response
{ "total": 2, // Total number of records, which is of the long type. "accessInfoList" : [{ // Dialog binding relationship list, which is an object array. "accessId":"100001", // Internal sequence number, which is a string. "tenantId": "tenantId001", // Tenant ID, which is a string. "accessCode": "10086", // Access ID, which is a string. "domainId":10001, // Domain ID, which is an integer. "dialogType ":1, // Dialog type, which is an integer. "flowCode" : "flowxxxxxx",// Flow code, which is a string. "description" : "",// Source device that initiates a dialog, which is a string. "source":"OIFDE",// Description, which is a string. "chatBotName":"10086", // Robot name, which is a string. "usingRecordService":0 // VoiceCyber recording is disabled. The value is an integer. },{ ... }] }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot