ListCategories - 获取类目_云联络中心(Cloud Contact Center)-阿里云帮助中心

使用ListCategories获取类目信息。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test
Type	string	否	类目类别。枚举值： Ticket：Ticket。	Ticket
CategoryId	string	否	工单类目 ID。指定类目 ID，返回对应 ID 的子类目信息，不指定返回实例下类目的信息。	43c2671b-*-*-86d0-6bd187905cc8

返回参数

名称	类型	描述	示例值
	object	ListCategoriesResponse
Data	string	数据。类目节点信息，JSON 字符传形式。	[{\"categoryId\":\"43c2671b-8939-4223-**-6bd187905cc8\",\"childCategoryList\":[{\"categoryId\":\"120816ad-4392-4edf--6d053d5cfa5a\",\"childCategoryList\":[],\"deleted\":0,\"editor\":\"283277706217028904\",\"editorName\":\"283277706217028904\",\"instanceId\":\"cccV2-kmz\",\"itemCount\":0,\"level\":2,\"name\":\"客户反馈\",\"parentCategoryId\":\"43c2671b-8939--86d0-6bd187905cc8\",\"type\":\"Ticket\"}],\"deleted\":0,\"editor\":\"283277706217028904\",\"editorName\":\"283277706217028904\",\"instanceId\":\"cccV2-kmz\",\"itemCount\":10,\"level\":1,\"name\":\"测试一01类目\",\"type\":\"Ticket\"},{\"categoryId\":\"4948fcd0-2972--81c6-1a00927e1802\",\"childCategoryList\":[],\"deleted\":0,\"editor\":\"283277706217028904\",\"editorName\":\"283277706217028904\",\"instanceId\":\"cccV2-kmz\",\"itemCount\":0,\"level\":1,\"name\":\"生产环境验证\",\"type\":\"Ticket\"},{\"categoryId\":\"c426bd7f-9661-47c3-**-2508f1a32f66\",\"childCategoryList\":[],\"deleted\":0,\"editor\":\"269801834095770945\",\"editorName\":\"269801834095770945\",\"instanceId\":\"cccV2-kmz\",\"itemCount\":4,\"level\":1,\"name\":\"测试环境测试\",\"type\":\"Ticket\"}]
RequestId	string	请求 ID。	DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE
HttpStatusCode	integer	HTTP 状态码。	200
Code	string	响应码。	OK
Message	string	响应信息。	无
Params	array	错误参数列表。
Param	string	错误参数。	无

示例

正常返回示例

JSON格式

{
  "Data": "[{\\\"categoryId\\\":\\\"43c2671b-8939-4223-****-6bd187905cc8\\\",\\\"childCategoryList\\\":[{\\\"categoryId\\\":\\\"120816ad-4392-4edf-****-6d053d5cfa5a\\\",\\\"childCategoryList\\\":[],\\\"deleted\\\":0,\\\"editor\\\":\\\"283277706217028904\\\",\\\"editorName\\\":\\\"283277706217028904\\\",\\\"instanceId\\\":\\\"cccV2-kmz\\\",\\\"itemCount\\\":0,\\\"level\\\":2,\\\"name\\\":\\\"客户反馈\\\",\\\"parentCategoryId\\\":\\\"43c2671b-8939-****-86d0-6bd187905cc8\\\",\\\"type\\\":\\\"Ticket\\\"}],\\\"deleted\\\":0,\\\"editor\\\":\\\"283277706217028904\\\",\\\"editorName\\\":\\\"283277706217028904\\\",\\\"instanceId\\\":\\\"cccV2-kmz\\\",\\\"itemCount\\\":10,\\\"level\\\":1,\\\"name\\\":\\\"测试一01类目\\\",\\\"type\\\":\\\"Ticket\\\"},{\\\"categoryId\\\":\\\"4948fcd0-2972-****-81c6-1a00927e1802\\\",\\\"childCategoryList\\\":[],\\\"deleted\\\":0,\\\"editor\\\":\\\"283277706217028904\\\",\\\"editorName\\\":\\\"283277706217028904\\\",\\\"instanceId\\\":\\\"cccV2-kmz\\\",\\\"itemCount\\\":0,\\\"level\\\":1,\\\"name\\\":\\\"生产环境验证\\\",\\\"type\\\":\\\"Ticket\\\"},{\\\"categoryId\\\":\\\"c426bd7f-9661-47c3-****-2508f1a32f66\\\",\\\"childCategoryList\\\":[],\\\"deleted\\\":0,\\\"editor\\\":\\\"269801834095770945\\\",\\\"editorName\\\":\\\"269801834095770945\\\",\\\"instanceId\\\":\\\"cccV2-kmz\\\",\\\"itemCount\\\":4,\\\"level\\\":1,\\\"name\\\":\\\"测试环境测试\\\",\\\"type\\\":\\\"Ticket\\\"}]",
  "RequestId": "DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "Params": [
    "无"
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
404	NotExists.InstanceId	The specified instance %s does not exist.	指定的呼叫中心实例不存在。

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