This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.
Conducts sessions with the bot based on its unique identifier (ID).
Operation description
The ID of the session.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cams:BeeBotChat | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SessionId | string | No | The title of the related knowledge. | en |
| Utterance | string | Yes | The title of the hit question. | 659216218162179 |
| IsvCode | string | No | The source of the answer. | ksiekdki39ksks93939 |
| ChatBotInstanceId | string | Yes | Indicates whether the answer is in plain text or rich text. | 1 |
| KnowledgeId | string | No | The hit statement. | 1 |
| IntentName | string | No | The source of the answer. | intent |
| SenderId | string | No | The information about the slot. | 861500000000 |
| SenderNick | string | No | Beijing | nick |
| Perspective | array | No | Beijing | |
| string | No | The name. | u6Yvizzjba | |
| VendorParam | object | No | The node name. When AnswerSource is set to BotFramework, a value is returned for this parameter. | {\"skills\":\"chat_search\",\"accessToken\":\"73f4d5c8e8c334d9b538890bca68ac9a\",\"senderStaffId\":\"1697204021326\",\"senderCorpId\":\"dingee291fb2828058b9\"} |
| CustSpaceId | string | No | The metadata. | 293483938849493 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
"Code": "OK",
"Message": "none",
"Data": {
"MessageId": "ab6be8af-cee4-40c3-9919-2ac7461d7d98",
"SessionId": "1234",
"Messages": [
{
"Knowledge": {
"HitStatement": "provident fund",
"Summary": "Withdrawal of housing provident fund",
"RelatedKnowledges": [
{
"KnowledgeId": "735899",
"Title": "Withdrawal of housing provident fund."
}
],
"Category": "provident fund.",
"Title": "Withdrawal of housing provident fund.",
"Content": "Provident fund withdrawal, please search for provident fund withdrawal on the homepage and submit the form for handling the matter.\n",
"AnswerSource": "KnowledgeBase",
"Id": "735898",
"ContentType": "PLAIN_TEXT"
},
"Text": {
"HitStatement": "Check the weather.",
"DialogName": "Example: Checking Weather",
"AnswerSource": "BotFramework",
"Slots": [
{
"Value": "Beijing",
"Origin": "Beijing",
"Name": "Check weather intentions. city\n",
"Hit": false
}
],
"NodeName": "Example: Checking Weather Check the weather and fill in the slots__ city\n",
"IntentName": "Check weather intention.",
"MetaData": "[[{\\\"columnName\\\":\\\"name\\\",\\\"stringValue\\\":\\\"wangshanshan\\\"}]]\n",
"ExternalFlags": {
"test": "test",
"test2": 1
},
"Ext": {
"test": "test",
"test2": 1
},
"UserDefinedChatTitle": "greet.",
"Content": "May I ask where you want to check the weather?",
"NodeId": "1410-c7a72a78.__city",
"ContentType": "PLAIN_TEXT"
},
"Recommends": [
{
"KnowledgeId": "4548",
"Title": "Test plain text.",
"AnswerSource": "KNOWLEDGE"
}
],
"AnswerType": "Text",
"AnswerSource": "KNOWLEDGE"
}
]
},
"AccessDeniedDetail": "None"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | Product.Unsubscript | You have not subscribed to the specified product. |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. |
| 400 | System.LimitControl | The system is under flow control. |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-07-04 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2022-10-12 | The Error code has changed. The request parameters of the API has changed | View Change Details |