获取三方审批任务状态

Error: 为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至新版本>>

该接口用于获取三方审批的状态。用户传入查询条件，接口返回满足条件的审批实例的状态。 该接口支持多种参数的组合， 包括如下组合：

1. 通过 instance_ids 获取指定实例的任务状态
2. 通过 user_ids 获取指定用户的任务状态
3. 通过 status 获取指定状态的所有任务
4. 获取下一批数据

请求

项目	值
HTTP URL	https://www.feishu.cn/approval/openapi/v2/external/list
HTTP Method	POST
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	approval:approval:readonly 访问审批应用

请求头

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

请求体

参数	类型	必须	说明
approval_codes	list	否	审批定义 Code，用于指定只获取这些定义下的数据
instance_ids	list	否	审批实例 ID, 用于指定只获取这些实例下的数据，最多支持 20 个
user_ids	list	否	审批人 user_id，用于指定只获取这些用户的数据
status	string	否	审批任务状态，用于指定获取该状态下的数据，状态值参照 三方审批任务状态枚举
scroll_id	string	否	通过 status 获取所有任务的请求，数据是分批返回的，使用 scroll_id 获取下一批数据
备注：通过 instance_ids 获取指定实例的任务状态时，instance_ids为必须字段；通过 user_ids 获取指定用户的任务状态时，approval_codes、user_ids、status为必须字段；通过 status 获取指定状态的所有任务时，approval_codes、status为必须字段；获取下一批数据时，scroll_id为必须字段。

请求体示例

1. 通过 instance_ids 获取指定实例的任务状态

{
    "instance_ids": ["oa_159160304"]
}

2. 通过 user_ids 获取指定用户的任务状态

{
    "approval_codes": ["B7B65FFE-C2GC-452F-9F0F-9AA8352363D6"],
    "user_ids": ["112321"],
    "status": "PENDING"
}

3. 获取下一批数据

{
    "scroll_id": "nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU"
}

响应

响应体

参数	类型	必须	说明
code	int	是	错误码，非 0 表示失败
msg	String	否	返回码的描述
data	object	是
∟data	list	是
∟instance_id	string	是	审批实例 ID
∟approval_code	String	是	审批对应的 approval_code
∟approval_id	String	是	审批的id
∟status	String	是	审批实例当前的状态，参考三方审批实例状态枚举
∟update_time	int	是	审批实例最后更新时间，单位 毫秒
∟tasks	list	否	审批实例下的审批任务
∟id	String	是	审批任务 ID
∟status	String	是	审批任务状态，状态值参照 三方审批任务状态枚举
∟update_time	int	是	审批任务最后更新时间，单位 毫秒
∟scroll_id	string	否	通过 status 获取所有任务的请求，数据是分批返回的， scroll_id 用于获取下一批数据，直至 scroll_id 为空

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "data": [
            {
                "approval_code": "60D0F7A2-052D-49E9-B570-C29C836CDF8E",
                "approval_id": "fwwweffff33111133xxx",
                "instance_id": "29075",
                "status": "PENDING",
                "tasks": [
                    {
                        "id": "310",
                        "status": "PENDING",
                        "update_time": 1621863215000
                    }
                ],
                "update_time": 1621863215000
            }
        ],
        "scroll_id": "DnF1ZXJ5VGhlbkZldGNoCgAAAAAFSe_nFjlFcHhJU2dXVEJlbzRhUDd2MHFEX2cAAAAABUnKKBZ2dkJLRkFHQVRrdTJWTGF3M2JFeENnAAAAAAOGMY0WUS1XNmw3bFlUZ2VORjNVT2cwOWtxUQAAAAADhjGOFlEtVzZsN2xZVGdlTkYzVU9nMDlrcVEAAAAAA8VIKxZ4VEFGaHRHRVE5V0s0ek9lNE9nOWpRAAAAAAQ9zgEWTDRLcUJ4c2VUU21ZRV9FQlRLWmNCQQAAAAAEfNk8Fno4emowUExBUzJTaFhPTkprU2RBaXcAAAAABQpkOxZ4V1drX2M5UVEycW5XUmpvNXJweG13AAAAAAPFSCwWeFRBRmh0R0VROVdLNHpPZTRPZzlqUQAAAAAEPlQ8FmZNc0Rsdm1TU2t5VnFrWjFsYjRhdlE="
    }
}