ListTicketTemplates - 获取工单模板列表_云联络中心(Cloud Contact Center)-阿里云帮助中心

使用ListTickerTemplate获取工单模板列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
SearchPattern	string	否	模板名称，模糊搜索。	模板1
CategoryId	string	否	工单类目 ID。	43c2671b-********86d0-6bd187905cc8
State	string	否	模板状态。 Enabled（已上线） Disabled（已下线）	Enabled
PageNumber	integer	否	分页序号，范围 1-100。	1
PageSize	integer	否	分页大小，范围 1-100。	100
InstanceId	string	是	实例 ID。	ccc-test

返回参数

名称	类型	描述	示例值
	object	ListTicketTemplatesResponse
Data	object	数据。
TotalCount	integer	总数。	25
PageNumber	integer	页码。	1
PageSize	integer	分页大小。	100
List	array<object>	模板列表。
List	object	模板。
InstanceId	string	实例 ID。	ccc-test
TemplateId	string	模板 ID。	b5c21219-3a1e-4bc0-92e7-da66e057d2f6
Name	string	模板名称。	测试模板
State	string	状态。	Enabled
Editor	string	编辑人。	creator@ccc-test
TicketFields	array<object>	模板字段列表。
TicketField	object	字段。
DisplayName	string	显示名称。	姓名
Description	string	描述。	姓名字段
Name	string	名称。	name
DataType	string	数据类型。	String
Pattern	string	正则表达式校验规则。	^
PatternErrorMessage	string	正则表达式校验错误提示信息	不是有效的email地址
MinLength	integer	最小长度。	1
MaxLength	integer	最大长度。	30
Minimum	double	数字最小值。	1
Maximum	double	数字最大值。	10
Required	boolean	是否必填。	false
System	boolean	是否是系统字段。	false
Disabled	boolean	是否被禁用。	false
Array	boolean	是否是数组。	false
ReadOnly	boolean	是否只读。	false
EditorType	string	编辑器类型。	textbox
Attribute	string	扩展属性。	{}
DisplayOrder	integer	列表展示顺序。	1
CreatedTime	long	创建时间。	1715780670000
UpdatedTime	long	更新时间。	1715780670000
Creator	string	创建者。	creator
ProcessDefinition	string	流程信息（废弃）。	无
UpdatedTime	long	更新时间。	1715780670000
CategoryId	string	类⽬ID。	43c2671b-*****-4223-86d0-6bd187905cc8
AppliedVersion	string	当前正在工作的版本。	0
LatestVersion	string	草稿版本。	1715780670000
RequestId	string	请求 ID。	8707EB29-BAED-4302-B999-40BA61877437
HttpStatusCode	integer	HTTP 状态码。	200
Code	string	响应码。	OK
Message	string	响应信息。	无
Params	array	错误参数列表。
Param	string	错误参数。	无

示例

正常返回示例

JSON格式

{
  "Data": {
    "TotalCount": 25,
    "PageNumber": 1,
    "PageSize": 100,
    "List": [
      {
        "InstanceId": "ccc-test",
        "TemplateId": "b5c21219-3a1e-4bc0-92e7-da66e057d2f6",
        "Name": "测试模板",
        "State": "Enabled",
        "Editor": "creator@ccc-test",
        "TicketFields": [
          {
            "DisplayName": "姓名\n",
            "Description": "姓名字段",
            "Name": "name",
            "DataType": "String",
            "Pattern": "^",
            "PatternErrorMessage": "不是有效的email地址\n",
            "MinLength": 1,
            "MaxLength": 30,
            "Minimum": 1,
            "Maximum": 10,
            "Required": false,
            "System": false,
            "Disabled": false,
            "Array": false,
            "ReadOnly": false,
            "EditorType": "textbox",
            "Attribute": "{}",
            "DisplayOrder": 1,
            "CreatedTime": 1715780670000,
            "UpdatedTime": 1715780670000,
            "Creator": "creator"
          }
        ],
        "ProcessDefinition": "无",
        "UpdatedTime": 1715780670000,
        "CategoryId": "43c2671b-*****-4223-86d0-6bd187905cc8",
        "AppliedVersion": "0",
        "LatestVersion": "1715780670000"
      }
    ]
  },
  "RequestId": "8707EB29-BAED-4302-B999-40BA61877437",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "Params": [
    "无"
  ]
}

错误码

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

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