查询实例列表

POST

https://open.feishu.cn/open-apis/approval/v4/instances/query

该接口通过不同条件查询审批系统中符合条件的审批实例列表。

注：

user_id、approval_code、instance_code、instance_external_id、group_external_id 不得均为空
approval_code 和 group_external_id 查询结果取并集，instance_code 和 instance_external_id 查询结果取并集，其他查询条件都对应取交集
查询时间跨度不得大于30天，开始和结束时间必须都设置，或者都不设置

错误码

HTTP状态码	错误码	描述	排查建议
400	1390001	param is invalid	参数错误
400	1390002	approval code not found	检查审批定义code是否正确
400	1390003	instance code not found	检查审批实例code是否正确
400	1395001	There have been some errors. Please try again later	服务出现错误，请稍候再试

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/approval/v4/instances/query?page_size=&page_token=nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU&user_id_type=' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_id": "lwiu098wj",
    "approval_code": "EB828003-9FFE-4B3F-AA50-2E199E2ED942",
    "instance_code": "EB828003-9FFE-4B3F-AA50-2E199E2ED943",
    "instance_external_id": "EB828003-9FFE-4B3F-AA50-2E199E2ED976",
    "group_external_id": "1234567",
    "instance_title": "test",
    "instance_status": "PENDING",
    "instance_start_time_from": "1547654251506",
    "instance_start_time_to": "1547654251506",
    "locale": "zh-CN"
}'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "count": 10,
        "instance_list": [
            {
                "approval": {
                    "code": "EB828003-9FFE-4B3F-AA50-2E199E2ED943",
                    "name": "approval",
                    "is_external": true,
                    "external": {
                        "batch_cc_read": false
                    },
                    "approval_id": "7090754740375519252",
                    "icon": "https://lf3-ea.bytetos.com/obj/goofy/ee/approval/approval-admin/image/iconLib/v3/person.png"
                },
                "group": {
                    "external_id": "0004",
                    "name": "groupA"
                },
                "instance": {
                    "code": "EB828003-9FFE-4B3F-AA50-2E199E2ED943",
                    "external_id": "0004_3ED52DC1-AA6C",
                    "user_id": "lwiu098wj",
                    "start_time": "1547654251506",
                    "end_time": "1547654251506",
                    "status": "pending",
                    "title": "test",
                    "extra": "{}",
                    "serial_id": "201902020001",
                    "link": {
                        "pc_link": "https://www.baidu.com/",
                        "mobile_link": "https://www.baidu.com/"
                    }
                }
            }
        ],
        "page_token": "nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU",
        "has_more": false
    }
}

请求参数

Query 参数

page_size

string

可选

分页大小

示例值：10

默认值：10

数据校验规则：

最大值：200

page_token

string

可选

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

示例值:

nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU

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？
默认值：open_id

当值为 user_id，字段权限要求：

获取用户 user ID

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

user_id

string

必需

根据x_user_type填写用户 id 示例值："lwiu098wj"

approval_code

string

必需

审批定义 code 示例值："EB828003-9FFE-4B3F-AA50-2E199E2ED942"

instance_code

string

必需

审批实例 code 示例值："EB828003-9FFE-4B3F-AA50-2E199E2ED943"

instance_external_id

string

必需

审批实例第三方 id 注：和 approval_code 取并集示例值："EB828003-9FFE-4B3F-AA50-2E199E2ED976"

group_external_id

string

必需

审批定义分组第三方 id 注：和 instance_code 取并集示例值："1234567"

instance_title

string

必需

审批实例标题（只有第三方审批有）示例值："test"

instance_status

string

必需

审批实例状态，注：若不设置，查询全部状态若不在集合中，报错示例值："PENDING" 可选值有： PENDING：审批中 RECALL：撤回 REJECT：拒绝 DELETED：已删除 APPROVED：通过 ALL：所有状态

instance_start_time_from

string

必需

实例查询开始时间（unix毫秒时间戳）示例值："1547654251506"

instance_start_time_to

string

必需

实例查询结束时间 (unix毫秒时间戳) 示例值："1547654251506"

locale

string

必需

地区示例值："zh-CN" 可选值有： zh-CN：中文 en-US：英文 ja-JP：日文

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

count

integer

查询返回条数

必需

instance_list

array [object {3}]

审批实例列表

必需

page_token

string

必需

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

has_more

boolean

是否还有更多项

必需

修改于 2023-02-02 03:56:20

更新审批 Bot 消息

查询抄送列表

查询实例列表

错误码#

请求参数

返回响应

错误码