飞书 API

获取全部工单自定义字段

GET

https://open.feishu.cn/open-apis/helpdesk/v1/ticket_customized_fields

自建应用

该接口用于获取全部工单自定义字段。

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

Key: X-Lark-Helpdesk-Authorization

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

了解更多：获取与使用服务台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	内部错误，请联系我们

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/helpdesk/v1/ticket_customized_fields?page_token=6948728206392295444&page_size=10' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "visible": true
}'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "has_more": true,
        "next_page_token": "6948728206392295444",
        "items": [
            {
                "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": "c495fe14-aac0-4fd6-8851-9fde726e2a40",
                            "display_name": "l1",
                            "children": [
                                {
                                    "tag": "498ed5f1-f2b1-4585-b21f-3d4d2cd0cd26",
                                    "display_name": "l2"
                                },
                                {
                                    "tag": "51285604-367f-454f-adca-b4760c38850d",
                                    "display_name": "l22"
                                }
                            ]
                        },
                        {
                            "tag": "295cf315-df56-445b-b430-b58925ef331c",
                            "display_name": "l11"
                        }
                    ]
                },
                "dropdown_allow_multiple": true
            }
        ]
    }
}

请求参数

Query 参数

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值："6948728206392295444"

示例值:

6948728206392295444

page_size

string

可选

分页大小示例值：10；默认为20 数据校验规则：最大值：100

示例值:

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

visible

boolean

可选

是否可见示例值：true

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

has_more

boolean

是否还有更多项

必需

next_page_token

string

下一分页标识

必需

items

array [object {16}]

工单自定义字段列表

必需

获取指定工单自定义字段

富文本

获取全部工单自定义字段

错误码#

请求参数

返回响应

错误码