DescribeInstance_智能对话机器人_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.

流控信息

请求速率为20/1(s)。更多流控信息,请前往配额中心查看

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
暂无数据

请求参数

字段名称字段详情
InstanceIdstring

机器人唯一标识

示例值:chatbot-cn-mp90s2lrk00050参考取值来源:
    ListInstance
    CreateInstance
AgentKeystring

业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取

示例值:ac627989eb4f8a98ed05fd098bbae5_p_beebot_public参考取值来源:
    GetAgentInfo
    ListAgent

返回参数

字段名称字段详情
RequestIdstring

请求 ID

示例值:907AA5F2-0521-49AB-80AB-1ADEFAB2B901
InstanceIdstring

机器人唯一标识

示例值:chatbot-cn-mp90s2lrk00050
Namestring

机器人名称

示例值:智能客服-小C
TimeZonestring

机器人的时区,参考《公共-时区码》

示例值:Asia/Chongqing
Introductionstring

机器人备注

示例值:用于C端问答的机器人
LanguageCodestring

机器人服务的语言,如 zh-cn、en-us

示例值:zh-cn枚举值:en-uszh-cn
RobotTypestring

机器人类型

示例值:scenario_im枚举值:scenario_calloutscenario_imscenario_ivr
Avatarstring

机器人头像的 URL

示例值:/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png
EditStatusstring

机器人状态

示例值:PUBLISHED枚举值:PUBLISHEDEDITING
CreateTimestring

机器人创建的 UTC 时间

示例值:2021-08-12T16:00:01Z
Categoriesarray<object>

类目列表

返回说明

示例

响应报文:

{
	"Name": "test1",
	"LanguageCode": "zh-cn",
  "RobotType":"scenario_im",
	"Introduction": "客户演示",
	"InstanceId": "chatbot-cn-mp90s2lrk00050",
	"CreateTime": "2018-09-11T09:26:14Z",
	"RequestId": "E7661C58-9CE7-4754-AB98-9BA40EAA7C27",
	"Avatar": "//gw.alicdn.com/tfs/TB1N5CwqTtYBeNjy1XdXXXXyVXa-90-97.png",
	"TimeZone": "Asia/Chongqing",
	"Categories": [
	  {
		"Name": "测试类目 test11",
		"ParentCategoryId": -1,
		"CategoryId": 1000006427
	  }
	]
}

变更历史

变更时间变更内容概要操作
2022-06-10
变更返回参数

相关示例

智能问答机器人-机器人FAQ问答场景
2022-07-20