Skip to content

获取三方协议

根据三方协议 ID 或投递 ID 获取三方协议信息,如三方协议状态、创建时间等信息。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/hire/v1/tripartite_agreements
HTTP MethodGET
接口频率限制10 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可hire:tripartite_agreement 更新三方协议 hire:tripartite_agreement:readonly 查看三方协议信息

请求头

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

查询参数

名称类型必填描述
page_sizeint分页大小
示例值:10
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
application_idstring投递 ID,可通过获取投递列表接口获取
示例值:6930815272790114324
tripartite_agreement_idstring三方协议 ID,由创建三方协议接口返回
示例值:6930815272790114325

Warning注意

  • 该接口目前只会返回一条数据,分页参数 page_sizepage_token 无效。
  • 参数 application_idtripartite_agreement_id 至少填一个,若不填则返回空数据;若都填写,接口将返回tripartite_agreement_id 参数指定的数据。

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemstripartite_agreement_info\[\]三方协议信息
    └ idstring三方协议 ID
    └ application_idstring投递 ID,详情可查看:获取投递信息
    └ stateint三方协议状态
可选值有
- 1: 未开始 - 2: 已申请 - 3: 学生处理中 - 4: 公司处理中 - 5: 学校处理中 - 6: 已终止 - 7: 已完成 - 8: 解约处理中 - 9: 已解约
    └ create_timestring三方协议创建时间,毫秒时间戳
    └ modify_timestring三方协议修改时间,毫秒时间戳
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "SUCCESS",
    "data": {
        "items": [
            {
                "id": "6930815272790114324",
                "application_id": "6930815272790114325",
                "state": 1,
                "create_time": "1698292282660",
                "modify_time": "1698292282661"
            }
        ]
    }
}

错误码

HTTP状态码错误码描述排查建议
5001002001系统错误请根据实际报错信息定位或咨询技术支持
4001002002参数错误检查参数是否正确,例如类型,大小

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

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