创建工单自定义字段

该接口用于创建自定义字段。

Tip: 注意事项： user_access_token 访问，需要操作者是当前服务台的管理员或所有者

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/helpdesk/v1/ticket_customized_fields
HTTP Method	POST
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	helpdesk:all 更新服务台资源详情

请求头

名称	类型	必填	描述
Authorization	string	是	user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

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

Key: X-Lark-Helpdesk-Authorization

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

了解更多：获取与使用服务台token

请求体

引用类型： ticket_customized_field

名称	类型	必填	描述
helpdesk_id	string	否	服务台ID（需要和请求 Header 中的服务台 ID 保持一致，可以省略）。 示例值："1542164574896126"
key_name	string	是	键名 示例值："test dropdown"
display_name	string	是	名称 示例值："test dropdown"
position	string	是	字段在列表后台管理列表中的位置 示例值："3"
field_type	string	是	类型 string - 单行文本 multiline - 多行文本 dropdown - 下拉列表 dropdown_nested - 级联下拉 示例值："dropdown"
description	string	是	描述 示例值："下拉示例"
visible	boolean	是	是否可见 示例值：true
required	boolean	是	是否必填 示例值：false
dropdown_options	dropdown_option	否	下拉列表选项
∟ children	dropdown_option[]	否	选项列表
∟ tag	string	是	选项ID
∟ display_name	string	是	展示名称
∟ children	dropdown_option[]	否	同上：选项列表，只适用于多层下拉列表（最多可以设置三级下拉列表）
dropdown_allow_multiple	boolean	否	是否支持多选，仅在字段类型是dropdown的时候有效 示例值：true

请求体示例

{
    "helpdesk_id": "1542164574896126",
    "key_name": "test dropdown",
    "display_name": "test dropdown",
    "position": "3",
    "field_type": "dropdown",
    "description": "下拉示例",
    "visible": true,
    "required": false,
    "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
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述

响应体示例

{
    "code": 0,
    "msg": "success"
}

错误码

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	内部错误，请联系我们