Skip to content

查询用户的任务列表

根据用户和任务分组查询任务列表。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/approval/v4/tasks/query
HTTP MethodGET
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用approval:approval:readonly 访问审批应用
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

查询参数

名称类型必填描述
page_sizeint分页大小
示例值:100
默认值100
数据校验规则: - 最大值:200
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:"1"
user_idstring需要查询的 User ID
示例值:"example_user_id"
topicstring需要查询的任务分组主题,如「待办」、「已办」等
示例值:"1"
可选值有
- 1: 待办审批 - 2: 已办审批 - 3: 已发起审批 - 17: 未读知会 - 18: 已读知会
user_id_typestring用户 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,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ taskstask\[\]任务列表
    └ topicstring任务所属的任务分组,如「待办」、「已办」等
可选值有
- 1: 待办审批 - 2: 已办审批 - 3: 已发起审批 - 17: 未读知会 - 18: 已读知会
    └ user_idstring任务所属的用户 ID
    └ titlestring任务题目
    └ urlstask_urls任务相关 URL
      └ helpdeskstring帮助服务台 URL
      └ mobilestring移动端 URL
      └ pcstringPC 端 URL
    └ process_external_idstring流程三方 ID,仅第三方流程,需要在当前租户、当前 APP 内唯一
    └ task_external_idstring任务三方 ID,仅第三方流程,需要在当前流程实例内唯一
    └ statusstring任务状态
可选值有
- 1: 待办 - 2: 已办 - 17: 未读 - 18: 已读 - 33: 处理中,标记完成用 - 34: 撤回
    └ process_statusstring流程实例状态
可选值有
- 0: 无流程状态,不展示对应标签 - 1: 流程实例流转中 - 2: 已通过 - 3: 已拒绝 - 4: 已撤销 - 5: 已终止
    └ definition_codestring流程定义 Code
    └ initiatorsstring\[\]发起人 ID 列表
    └ initiator_namesstring\[\]发起人姓名列表
    └ task_idstring任务 ID,全局唯一
    └ process_idstring流程 ID,全局唯一
    └ process_codestring流程 Code
    └ definition_group_idstring流程定义分组 ID
    └ definition_group_namestring流程定义分组名称
    └ definition_idstring流程定义 ID
    └ definition_namestring流程定义名称
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项
  └ countcount列表计数,只在分页第一页返回
    └ totalint总数,大于等于 1000 个项目时将返回 999
    └ has_moreboolean还有更多,当大于等于 1000 时将返回 true

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "tasks": [
            {
                "topic": "1",
                "user_id": "example_user_id",
                "title": "任务题目示例",
                "urls": {
                    "helpdesk": "https://blabla",
                    "mobile": "https://blabla",
                    "pc": "https://blabla"
                },
                "process_external_id": "example_instance_id",
                "task_external_id": "example_task_id",
                "status": "Todo",
                "process_status": "Running",
                "definition_code": "000000-00000000000000-0example",
                "initiators": [
                    "starter"
                ],
                "initiator_names": [
                    "发起人姓名"
                ],
                "task_id": "1212564555454",
                "process_id": "1214564545474",
                "process_code": "123e4567-e89b-12d3-a456-426655440000",
                "definition_group_id": "1212564555454",
                "definition_group_name": "流程定义名称",
                "definition_id": "1212564555454",
                "definition_name": "流程定义组名称"
            }
        ],
        "page_token": "example_page_token",
        "has_more": true,
        "count": {
            "total": 123,
            "has_more": false
        }
    }
}

错误码

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

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