获取三方审批任务状态

GET

https://open.feishu.cn/open-apis/approval/v4/external_tasks

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

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

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

3.通过 status 获取指定状态的所有任务

4.通过page_token获取下一批数据

备注：

1.通过 instance_ids 获取指定实例的任务状态时，instance_ids为必须字段；

{
    "instance_ids": ["oa_159160304"]
}

2.通过 user_ids 获取指定用户的任务状态时，approval_codes、user_ids、status为必须字段；

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

3.通过 status 获取指定状态的所有任务时，approval_codes、status为必须字段；

{
    "approval_codes": [
        "E78F1022-A166-447C-8320-E151DA90D70F"
    ],
    "status": "PENDING"
}

4.通过 page_token获取下一批数据时，page_token为必须字段,

错误码

HTTP状态码	错误码	描述	排查建议
400	1390001	param is invalid	参数错误

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/approval/v4/external_tasks?page_size=100&page_token=nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "approval_codes": [
        "B7B65FFE-C2GC-452F-9F0F-9AA8352363D6"
    ],
    "instance_ids": [
        "oa_159160304"
    ],
    "user_ids": [
        "112321"
    ],
    "status": "PENDING"
}'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "data": [
            {
                "instance_id": "29075",
                "approval_id": "fwwweffff33111133xxx",
                "approval_code": "B7B65FFE-C2GC-452F-9F0F-9AA8352363D6",
                "status": "PENDING",
                "update_time": "1621863215000",
                "tasks": [
                    {
                        "id": "310",
                        "status": "PENDING",
                        "update_time": "1621863215000"
                    }
                ]
            }
        ],
        "page_token": "nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU",
        "has_more": false
    }
}

请求参数

Query 参数

page_size

string

分页大小

可选

示例值:

100

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果

示例值:

nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

approval_codes

array[string]

可选

审批定义 Code，用于指定只获取这些定义下的数据示例值：B7B65FFE-C2GC-452F-9F0F-9AA8352363D6 数据校验规则：最大长度：20

instance_ids

array[string]

可选

审批实例 ID, 用于指定只获取这些实例下的数据，最多支持 20 个示例值：oa_159160304

user_ids

array[string]

可选

审批实例 ID, 用于指定只获取这些实例下的数据，最多支持 20 个示例值：oa_159160304 user_ids string[] 否审批人 user_id，用于指定只获取这些用户的数据示例值：112321

status

string

可选

审批任务状态，用于指定获取该状态下的数据示例值："PENDING" 可选值有： PENDING：审批中 APPROVED：审批流程结束，结果为同意 REJECTED：审批流程结束，结果为拒绝 TRANSFERRED：任务转交 DONE：任务通过但审批人未操作；审批人看不到这个任务, 若想要看到, 可以通过抄送该人

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

data

array [object {6}]

返回数据

必需

page_token

string

必需

分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

has_more

boolean

是否还有更多项

必需

修改于 2023-02-02 03:47:06

资源介绍

发送审批 Bot 消息

获取三方审批任务状态

错误码#

请求参数

返回响应

错误码