获取指定工单自定义字段

GET

/helpdesk/v1/ticket_customized_fields/{ticket_customized_field_id}

该接口用于获取工单自定义字段详情。

服务台请求Header中还需添加“服务台token”参数：

Key: X-Lark-Helpdesk-Authorization

Value: base64(helpdesk_id:helpdesk_token)，通过base64加密将helpdesk_id和helpdesk_token用':'连接而成的字符串。

错误码

HTTP状态码	错误码	描述	排查建议
400	154000	Bad request, please check your request body	请求不合法，请检查参数
401	154001	Unauthorized, please check you have the correct access	检查Authorization 和 X-Lark-Helpdesk-Authorization 是否正确，应用和服务台属于同一租户
403	154003	Please check you have the correct access	检查是否申请正确权限
500	155000	Internal error	内部错误，请联系我们

请求参数

Authorization

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET '/helpdesk/v1/ticket_customized_fields/6948728206392295444' \
--header 'Authorization: Bearer <token>'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "ticket_customized_field_id": "6834320707288072194",
        "helpdesk_id": "1542164574896126",
        "key_name": "test dropdown",
        "display_name": "test dropdown",
        "position": "3",
        "field_type": "dropdown",
        "description": "下拉示例",
        "visible": true,
        "editable": true,
        "required": false,
        "created_at": "1591239289000",
        "updated_at": "1591239289000",
        "created_by": {
            "id": "ou_37019b7c830210acd88fdce886e25c71",
            "avatar_url": "https://xxxx",
            "name": "abc",
            "email": "xxxx@abc.com"
        },
        "updated_by": {
            "id": "ou_37019b7c830210acd88fdce886e25c71",
            "avatar_url": "https://xxxx",
            "name": "abc",
            "email": "xxxx@abc.com"
        },
        "dropdown_options": {
            "children": [
                {
                    "tag": "a2ac322d-8d8c-432e-9631-17c4acaddbf7",
                    "display_name": "a"
                },
                {
                    "tag": "67068d18-20c9-412e-afc0-714d0e8fac29",
                    "display_name": "b"
                },
                {
                    "tag": "d135b9f3-f260-49e6-bb7b-32e334a99caf",
                    "display_name": "c"
                }
            ]
        },
        "dropdown_allow_multiple": true
    }
}

修改于 2025-10-21 07:28:31

更新工单自定义字段

获取全部工单自定义字段

获取指定工单自定义字段

错误码#

请求参数

返回响应

错误码