文档

DescribeInstance - 获取机器人详情

更新时间:

查询机器人详情。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
InstanceIdstring

机器人唯一标识

chatbot-cn-mp90s2lrk00050
AgentKeystring

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

ac627989eb4f8a98ed05fd098bbae5_p_beebot_public

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

907AA5F2-0521-49AB-80AB-1ADEFAB2B901
InstanceIdstring

机器人唯一标识

chatbot-cn-mp90s2lrk00050
Namestring

机器人名称

智能客服-小C
TimeZonestring

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

Asia/Chongqing
Introductionstring

机器人备注

用于C端问答的机器人
LanguageCodestring

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

枚举值:
  • en-us英文
  • zh-cn中文
zh-cn
RobotTypestring

机器人类型

枚举值:
  • scenario_callout外呼机器人
  • scenario_im在线文本机器人
  • scenario_ivr导航机器人
scenario_im
Avatarstring

机器人头像的 URL

/alimefe/meebot/robot/0.0.5/img/xxx-90-97.png
EditStatusstring

机器人状态

枚举值:
  • PUBLISHED已发布
  • EDITING编辑中
PUBLISHED
CreateTimestring

机器人创建的 UTC 时间

2021-08-12T16:00:01Z
Categoriesobject []

类目列表

CategoryIdlong

类目 ID

30000066832
Namestring

类目名称

杭州市防疫政策
ParentCategoryIdlong

父类目 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
    }
  ]
}

错误码

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

  • 本页导读 (0)