创建职级
调用该接口创建一个职级。职级是用户属性之一,用于标识用户的职位级别,例如 P1、P2、P3、P4。
使用限制
单租户内职级数量总数上限为 10,000,但需要注意,如果总数超过 4,000,则无法在管理后台打开职级列表。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/contact/v3/job_levels |
| HTTP Method | POST |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | contact:contact 更新通讯录 contact:job_level 创建、删除、更新职级 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
name | string | 是 | 职级名称。通用名称,如果未设置多语言名称,则默认展示该名称。 示例值:"高级专家" 数据校验规则: - 长度范围: 1 ~ 255 字符 |
description | string | 否 | 职级描述。字符长度上限 5,000。通用描述,如果未设置多语言描述,则默认展示该描述。 默认值:空 示例值:"公司内部中高级职称,有一定专业技术能力的人员" |
order | int | 否 | 职级排序。数值越小,排序越靠前。 默认值:空。如果不传入该值,则默认职级排在列表最后位(即 order 取值为当前职级列表内的最大值)。 示例值:200 数据校验规则: - 取值范围: 100 ~ 100000 |
status | boolean | 是 | 是否启用该职级。 可选值有: - true:启用 - false:不启用 说明:只有启用了的职级可以设置为用户属性。 示例值:true |
i18n_name | i18n_content\[\] | 否 | 多语言职级名称。 默认值:空,表示不设置多语言名称。 |
└ locale | string | 否 | 语言版本。例如: - zh_cn:中文 - en_us:英语 - ja_jp:日语 示例值:"zh_cn" |
└ value | string | 否 | 语言版本对应的职级名称。 示例值:"多语言内容" |
i18n_description | i18n_content\[\] | 否 | 多语言职级描述。 默认值:空,表示不设置多语言描述。 |
└ locale | string | 否 | 语言版本。例如: - zh_cn:中文 - en_us:英语 - ja_jp:日语 示例值:"zh_cn" |
└ value | string | 否 | 语言版本对应的职级描述。 示例值:"多语言内容" |
请求体示例
json
{
"name": "高级专家",
"description": "公司内部中高级职称,有一定专业技术能力的人员",
"order": 200,
"status": true,
"i18n_name": [
{
"locale": "zh_cn",
"value": "多语言内容"
}
],
"i18n_description": [
{
"locale": "zh_cn",
"value": "多语言内容"
}
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ job_level | job_level | 职级信息。 |
└ name | string | 职级名称。 |
└ description | string | 职级描述。 |
└ order | int | 职级排序,数值越小,排序越靠前。 |
└ status | boolean | 是否启用职级。 可能值有: - true:启用 - false:不启用 |
└ job_level_id | string | 职级 ID。后续可通过该 ID 删除、更新、查询职级。 |
└ i18n_name | i18n_content\[\] | 多语言名称。 |
└ locale | string | 语言版本。 |
└ value | string | 语言版本对应的名称。 |
└ i18n_description | i18n_content\[\] | 多语言描述。 |
└ locale | string | 语言版本。 |
└ value | string | 语言版本对应的描述。 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"job_level": {
"name": "高级专家",
"description": "公司内部中高级职称,有一定专业技术能力的人员",
"order": 200,
"status": true,
"job_level_id": "mga5oa8ayjlp9rb",
"i18n_name": [
{
"locale": "zh_cn",
"value": "多语言内容"
}
],
"i18n_description": [
{
"locale": "zh_cn",
"value": "多语言内容"
}
]
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 42300 | job level reach the upper limit | 职级数量到达上限,需要删除其他职级后重试。单租户内的职级数量上限为 10,000 个,此外需要注意,当职级数量超过 4,000 个以后,在管理后台将无法打开职级列表。 |
| 404 | 42301 | job level not exist | 职级不存在。 |
| 400 | 42302 | job level tenant lock fail | 并发更新职级受限,请等待一段时间重试。 |
| 400 | 42303 | job level name not valid | 职级名称不合法。请求时设置的名称长度限制为 1 ~ 255 个字符。 |
| 400 | 42305 | job level name duplicate | 职级名称重复。请调整名称取值后重试。 |
| 400 | 42306 | job level order duplicate | 职级排序值重复。请调整排序取值后重试。 |
| 400 | 42304 | job level description not valid | 描述不合法。描述的字符上限为 5,000。 |
| 400 | 42307 | job level external id duplicate | 职级 ID 重复,系统原因导致,请重试。 |
| 400 | 42308 | job level invalid order | 排序值不合法。职级排序取值范围为 100 ~ 100000。 |
更多错误码信息,参见通用错误码。
