ListCommonTicketFields - 获取工单字段定义_云联络中心(Cloud Contact Center)-阿里云帮助中心

使用ListCommonTicketFields获取实例下定义的工单字段类型。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test

返回参数

名称	类型	描述	示例值
	object	GetSchemaResponse
Data	object	数据。
InstanceId	string	实例 ID。	ccc-test
Id	string	Schema ID。	ticketing
Properties	object	字段列表。
	object	字段。
DisplayName	string	显示名称。	姓名
Description	string	描述。	name
Name	string	名称。	name
DataType	string	数据类型。	string
Pattern	string	正则表达式校验规则。	^
PatternErrorMessage	string	正则表达式校验错误提示信息。	不是有效的email地址
MinLength	integer	最小长度。	1
MaxLength	integer	最大长度。	10
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	创建时间。	1703517780627
UpdatedTime	long	更新时间。	1716211430928
Creator	string	创建者。	creator@ccc-test
CreatedTime	string	创建时间。	1703517780627
UpdatedTime	string	上次修改的时间。	1716211430928
RequestId	string	请求 ID。	30C7D235-DDCF-4C7F-A462-5E2598252C2B
HttpStatusCode	integer	HTTP 状态码。	200
Code	string	响应码。	OK
Message	string	响应信息。	无
Params	array	错误参数列表。
	string	错误参数。	无

示例

正常返回示例

JSON格式

{
  "Data": {
    "InstanceId": "ccc-test",
    "Id": "ticketing",
    "Properties": {
      "key": {
        "DisplayName": "姓名",
        "Description": "name",
        "Name": "name",
        "DataType": "string",
        "Pattern": "^",
        "PatternErrorMessage": "不是有效的email地址",
        "MinLength": 1,
        "MaxLength": 10,
        "Minimum": 1,
        "Maximum": 10,
        "Required": false,
        "System": false,
        "Disabled": false,
        "Array": false,
        "ReadOnly": false,
        "EditorType": "textbox",
        "Attributes": "{}\n",
        "DisplayOrder": 1,
        "CreatedTime": 1703517780627,
        "UpdatedTime": 1716211430928,
        "Creator": "creator@ccc-test"
      }
    },
    "CreatedTime": "1703517780627",
    "UpdatedTime": "1716211430928"
  },
  "RequestId": "30C7D235-DDCF-4C7F-A462-5E2598252C2B",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "Params": [
    "无"
  ]
}

错误码

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