BeeBotChat_ChatApp消息服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
cams:BeeBotChat
Update
全部资源
*

请求参数

字段名称字段详情
SessionIdstring

会话 ID, 用于标识一个访问者的会话和上下文信息。

示例值:en
Utterancestring

机器人访问者输入。

示例值:659216218162179
IsvCodestring

Isv 校验码,用于校验子账号是否由 ISV 授权。

示例值:ksiekdki39ksks93939
ChatBotInstanceIdstring

机器人实例 ID。

示例值:1
KnowledgeIdstring

知识库中知识标题 ID。

示例值:1
IntentNamestring

对话流中意图名称,若指定此名称,机器人会直接进入此意图做问答。

示例值:intent
SenderIdstring

访问者 ID。用于识别当前会话中的用户。

示例值:861500000000
SenderNickstring

当前会话中访问的昵称。

示例值:nick
Perspectivearray<string>

视角编码列表。

VendorParamobject

用户自定义参数集,一个 JSON 格式的用户自定义参数集,可以传入用户自定义的参数到各对话引擎。

示例值:{\"skills\":\"chat_search\",\"accessToken\":\"73f4d5c8e8c334d9b538890bca68ac9a\",\"senderStaffId\":\"1697204021326\",\"senderCorpId\":\"dingee291fb2828058b9\"}
CustSpaceIdstring

ISV 子客户的 SpaceId

示例值:293483938849493

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:90E63D28-E31D-1EB2-8939-A94866411B2O
Codestring

返回结果,OK 为正常。

示例值:OK
Messagestring

提示信息,当返回异常时有值。

示例值:none
Dataobject

返回数据。

AccessDeniedDetailstring

访问被拒绝详细信息。

示例值:

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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
变更返回参数
2022-11-17
新增请求参数CustSpaceId
2022-10-12
删除请求参数ChatBotInstnaceId
新增请求参数ChatBotInstanceId

相关示例