Skip to content

获取单个序列信息

调用该接口获取指定序列的信息,包括序列的名称、描述、启用状态以及 ID 等。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/contact/v3/job_families/:job_family_id
HTTP MethodGET
接口频率限制10 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可contact:job_family:readonly 查询租户下工作序列的详细信息 contact:job_family 创建、删除、更新租户的工作序列 contact:contact:readonly_as_app 以应用身份读取通讯录

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
job_family_idstring序列 ID。获取方式:
- 创建序列时可以从返回结果中获取(job_family_id)。 - 调用获取租户序列列表接口获取序列 ID。
示例值:"mga5oa8ayjlp9rb"

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ job_familyjob_family序列信息。
    └ namestring序列名称。
    └ descriptionstring序列描述。
    └ parent_job_family_idstring上级序列 ID。
    └ statusboolean是否启用序列。
可能值有
- true:启用 - false:禁用
    └ i18n_namei18n_content\[\]多语言序列名称。
      └ localestring语言版本。
可能值有
- zh_cn:中文 - en_us:英语 - ja_jp:日语
      └ valuestring语言版本对应的值。
    └ i18n_descriptioni18n_content\[\]多语言序列描述。
      └ localestring语言版本。
可能值有
- zh_cn:中文 - en_us:英语 - ja_jp:日语
      └ valuestring语言版本对应的值。
    └ job_family_idstring序列 ID。

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "job_family": {
            "name": "产品",
            "description": "负责产品策略制定的相关工作",
            "parent_job_family_id": "mga5oa8ayjlpzjq",
            "status": true,
            "i18n_name": [
                {
                    "locale": "zh_cn",
                    "value": "多语言内容"
                }
            ],
            "i18n_description": [
                {
                    "locale": "zh_cn",
                    "value": "多语言内容"
                }
            ],
            "job_family_id": "mga5oa8ayjlpkzy"
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
40442404job family not exist序列不存在。你需要检查并传入正确的序列 ID。

更多错误码信息,参见通用错误码

内容来源:飞书开放平台 · 自动爬取整理