获取备注
根据备注 ID 查询人才备注信息,包括备注内容、人才 ID、投递 ID 等。可用于人才备注信息展示等场景。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/hire/v1/notes/:note_id |
| HTTP Method | GET |
| 接口频率限制 | 20 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | hire:note:readonly 获取招聘备注信息 hire:note 更新招聘备注信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
note_id | string | 备注 ID,可通过获取备注列表获取 示例值:"6949805467799537964" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型 示例值:open_id 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID? - people_admin_id: 以people_admin_id来识别用户默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ note | note | 人才备注信息 |
└ id | string | 备注 ID |
└ talent_id | string | 人才 ID,详情请参考:获取人才信息 |
└ application_id | string | 投递 ID,详情请参考:获取投递信息 |
└ is_private | boolean | 是否私密备注 |
└ create_time | int | 创建时间,毫秒时间戳 |
└ modify_time | int | 更新时间,毫秒时间戳 |
└ creator_id | string | 创建人 ID,与入参中 user_id_type 类型一致 |
└ content | string | 备注内容 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"note": {
"id": "6949805467799537964",
"talent_id": "6916472453069883661",
"application_id": "6891565253964859661",
"is_private": false,
"create_time": 1618209327096,
"modify_time": 1618209327096,
"creator_id": "ou_f476cb099ac9227c9bae09ce46112579",
"content": "这是一个备注"
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询技术支持 |
| 400 | 1002002 | 参数错误 | 检查参数是否正确,例如类型,大小 |
