调用DescribeInstance获取机器人详情_智能对话机器人(Chatbot)-阿里云帮助中心

查询机器人详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	机器人唯一标识	chatbot-cn-mp90s2lrk00050
AgentKey	string	否	业务空间 key，不设置则访问默认业务空间，key 值在主账号业务管理页面获取	ac627989eb4f8a98ed05fd098bbae5_p_beebot_public

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	907AA5F2-0521-49AB-80AB-1ADEFAB2B901
InstanceId	string	机器人唯一标识	chatbot-cn-mp90s2lrk00050
Name	string	机器人名称	智能客服-小C
TimeZone	string	机器人的时区，参考《公共-时区码》	Asia/Chongqing
Introduction	string	机器人备注	用于C端问答的机器人
LanguageCode	string	机器人服务的语言，如 zh-cn、en-us 枚举值： en-us：英文。 zh-cn：中文。	zh-cn
RobotType	string	机器人类型枚举值： scenario_callout：外呼机器人。 scenario_im：在线文本机器人。 scenario_ivr：导航机器人。	scenario_im
Avatar	string	机器人头像的 URL	/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png
EditStatus	string	机器人状态枚举值： PUBLISHED：已发布。 EDITING：编辑中。	PUBLISHED
CreateTime	string	机器人创建的 UTC 时间	2021-08-12T16:00:01Z
Categories	array<object>	类目列表
绑定的FAQ类目	object
CategoryId	long	类目 ID	30000066832
Name	string	类目名称	杭州市防疫政策
ParentCategoryId	long	父类目 ID，-1 表示根目录	-1

示例

响应报文：

{
	"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
	  }
	]
}

示例

正常返回示例

JSON格式

{
  "RequestId": "907AA5F2-0521-49AB-80AB-1ADEFAB2B901",
  "InstanceId": "chatbot-cn-mp90s2lrk00050",
  "Name": "智能客服-小C",
  "TimeZone": "Asia/Chongqing",
  "Introduction": "用于C端问答的机器人",
  "LanguageCode": "zh-cn",
  "RobotType": "scenario_im",
  "Avatar": "/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png",
  "EditStatus": "PUBLISHED",
  "CreateTime": "2021-08-12T16:00:01Z",
  "Categories": [
    {
      "CategoryId": 30000066832,
      "Name": "杭州市防疫政策",
      "ParentCategoryId": -1
    }
  ]
}

错误码

访问错误中心查看更多错误码。