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

使用GetTicketTemplate获取工单模板定义信息。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
TemplateId	string	否	模板 ID。	4ca2e2-c8d19b82c-d7ce393ac8197d3ab
InstanceId	string	是	实例 ID。	ccc-test
TemplateVersion	string	否	模板版本。	1703517780627

返回参数

名称	类型	描述	示例值
	object	GetTicketTemplateResponse
Data	object	数据。
InstanceId	string	实例 ID。	ccc-test
TemplateId	string	模板 ID。	4ca2e2-c8d19b82c-d7ce393ac8197d3ab
Name	string	模板名称。	测试模板。
State	string	状态码。	Enabled
Editor	string	模板编辑人。	editor-xxx@ccc-test
CategoryId	string	工单类目 ID。	43c2671b-****-4223-86d0-6bd187905cc8
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
Attributes	string	扩展属性。	{}
DisplayOrder	integer	列表展示顺序。	1
CreatedTime	long	创建时间。	1717664210000
UpdatedTime	long	更新时间。	1717664210000
Creator	string	创建者。	creator@cccV2-kmz
ProcessDefinition	string	流程信息。	[{\"id\":\"TICKET_START\",\"name\":\"开始\",\"nodeIndex\":0,\"properties\":{\"position\":{\"x\":250,\"y\":200}},\"type\":\"TICKET_START\",\"events\":[{\"edgeId\":\"8bd07339\",\"sourceAnchor\":0,\"next\":\"APPROVAL__JNBSSREc\",\"targetAnchor\":0}]},{\"id\":\"TICKET_FINISH\",\"name\":\"结束\",\"nodeIndex\":9999,\"properties\":{\"position\":{\"x\":767,\"y\":206}},\"type\":\"TICKET_FINISH\",\"events\":[]},{\"id\":\"APPROVAL__JNBSSREc\",\"name\":\"流程节点\",\"nodeIndex\":1,\"properties\":{\"skillGroupId\":\"chat001@cccV2-kmz\",\"position\":{\"x\":537,\"y\":164.5}},\"type\":\"APPROVAL\",\"events\":[{\"edgeId\":\"74031613\",\"sourceAnchor\":1,\"next\":\"TICKET_FINISH\",\"targetAnchor\":0}]}]
UpdatedTime	long	上次修改的时间。	1717664210000
RequestId	string	请求 ID。	BF268B34-09C2-43FD-BAC4-5D31EA633111
HttpStatusCode	integer	HTTP 状态码。	200
Code	string	响应码。	OK
Message	string	响应信息。	无
Params	array	错误参数列表。
Param	string	错误参数。	无

示例

正常返回示例

JSON格式

{
  "Data": {
    "InstanceId": "ccc-test",
    "TemplateId": "4ca2e2-c8d19b82c-d7ce393ac8197d3ab\n",
    "Name": "测试模板。\n\n",
    "State": "Enabled",
    "Editor": "editor-xxx@ccc-test",
    "CategoryId": "43c2671b-****-4223-86d0-6bd187905cc8",
    "TicketFields": [
      {
        "DisplayName": "姓名",
        "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",
        "Attributes": "{}",
        "DisplayOrder": 1,
        "CreatedTime": 1717664210000,
        "UpdatedTime": 1717664210000,
        "Creator": "creator@cccV2-kmz"
      }
    ],
    "ProcessDefinition": "[{\\\"id\\\":\\\"TICKET_START\\\",\\\"name\\\":\\\"开始\\\",\\\"nodeIndex\\\":0,\\\"properties\\\":{\\\"position\\\":{\\\"x\\\":250,\\\"y\\\":200}},\\\"type\\\":\\\"TICKET_START\\\",\\\"events\\\":[{\\\"edgeId\\\":\\\"8bd07339\\\",\\\"sourceAnchor\\\":0,\\\"next\\\":\\\"APPROVAL__JNBSSREc\\\",\\\"targetAnchor\\\":0}]},{\\\"id\\\":\\\"TICKET_FINISH\\\",\\\"name\\\":\\\"结束\\\",\\\"nodeIndex\\\":9999,\\\"properties\\\":{\\\"position\\\":{\\\"x\\\":767,\\\"y\\\":206}},\\\"type\\\":\\\"TICKET_FINISH\\\",\\\"events\\\":[]},{\\\"id\\\":\\\"APPROVAL__JNBSSREc\\\",\\\"name\\\":\\\"流程节点\\\",\\\"nodeIndex\\\":1,\\\"properties\\\":{\\\"skillGroupId\\\":\\\"chat001@cccV2-kmz\\\",\\\"position\\\":{\\\"x\\\":537,\\\"y\\\":164.5}},\\\"type\\\":\\\"APPROVAL\\\",\\\"events\\\":[{\\\"edgeId\\\":\\\"74031613\\\",\\\"sourceAnchor\\\":1,\\\"next\\\":\\\"TICKET_FINISH\\\",\\\"targetAnchor\\\":0}]}]",
    "UpdatedTime": 1717664210000
  },
  "RequestId": "BF268B34-09C2-43FD-BAC4-5D31EA633111",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "Params": [
    "无"
  ]
}

错误码

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

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