根据机器人唯一标识（机器人Id）与其进行会话。
接口说明
本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cams:BeeBotChat | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SessionId | string | 否 | 会话 ID, 用于标识一个访问者的会话和上下文信息。 | en |
| Utterance | string | 是 | 机器人访问者输入。 | 659216218162179 |
| IsvCode | string | 否 | Isv 校验码，用于校验子账号是否由 ISV 授权。 | ksiekdki39ksks93939 |
| ChatBotInstanceId | string | 是 | 机器人实例 ID。 | 1 |
| KnowledgeId | string | 否 | 知识库中知识标题 ID。 | 1 |
| IntentName | string | 否 | 对话流中意图名称，若指定此名称，机器人会直接进入此意图做问答。 | intent |
| SenderId | string | 否 | 访问者 ID。用于识别当前会话中的用户。 | 861500000000 |
| SenderNick | string | 否 | 当前会话中访问的昵称。 | nick |
| Perspective | array | 否 | 视角编码列表。 | |
| string | 否 | 视角编码，用于调用同一知识标题下不同视角的答案。 | u6Yvizzjba | |
| VendorParam | object | 否 | 用户自定义参数集，一个 JSON 格式的用户自定义参数集，可以传入用户自定义的参数到各对话引擎。 | {\"skills\":\"chat_search\",\"accessToken\":\"73f4d5c8e8c334d9b538890bca68ac9a\",\"senderStaffId\":\"1697204021326\",\"senderCorpId\":\"dingee291fb2828058b9\"} |
| CustSpaceId | string | 否 | ISV 子客户的 SpaceId | 293483938849493 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
"Code": "OK",
"Message": "none",
"Data": {
"MessageId": "ab6be8af-cee4-40c3-9919-2ac7461d7d98",
"SessionId": "1234",
"Messages": [
{
"Knowledge": {
"HitStatement": "公积金",
"Summary": "公积金提取",
"RelatedKnowledges": [
{
"KnowledgeId": "735899",
"Title": "公积金提取"
}
],
"Category": "公积金",
"Title": "公积金提取",
"Content": "公积金提取，请在首页搜索公积金提取，提交办事的表单",
"AnswerSource": "KnowledgeBase",
"Id": "735898",
"ContentType": "PLAIN_TEXT"
},
"Text": {
"HitStatement": "查天气",
"DialogName": "示例_查天气",
"AnswerSource": "BotFramework",
"Slots": [
{
"Value": "北京",
"Origin": "北京",
"Name": "查天气意图.city",
"Hit": false
}
],
"NodeName": "示例_查天气.查天气填槽.__city",
"IntentName": "查天气意图",
"MetaData": "[[{\\\"columnName\\\":\\\"姓名\\\",\\\"stringValue\\\":\\\"王珊珊\\\"}]]",
"ExternalFlags": {
"test": "test",
"test2": 1
},
"Ext": {
"test": "test",
"test2": 1
},
"UserDefinedChatTitle": "问候",
"Content": "请问您要查哪里的天气？",
"NodeId": "1410-c7a72a78.__city",
"ContentType": "PLAIN_TEXT"
},
"Recommends": [
{
"KnowledgeId": "4548",
"Title": "测试纯文本",
"AnswerSource": "KNOWLEDGE"
}
],
"AnswerType": "Text",
"AnswerSource": "KNOWLEDGE"
}
]
},
"AccessDeniedDetail": "无"
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 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. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-07-04 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2022-10-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||
|