Back to Details

feishu-approval

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

飞书审批

Feishu Approval

通过 Approval API 创建和查询审批实例。
Base URL: 
https://open.feishu.cn/open-apis/approval/v4
Create and query approval instances via the Approval API.
Base URL: 
https://open.feishu.cn/open-apis/approval/v4

审批实例

Approval Instances

API端点方法请求体示例说明
创建实例
/instances
POST
{"approval_code":"7C46...","user_id":"ou_xxx","form":"{\"widget1\":\"value1\"}"}
发起审批
查询实例
/instances/{instance_id}
GET-获取审批状态
审批操作
/instances/{instance_id}/approve
POST
{"comment":"同意","task_id":"xxx"}
同意/拒绝审批
撤回审批
/instances/{instance_id}/cancel
POST
{"user_id":"ou_xxx"}
申请人撤回
转交审批
/instances/{instance_code}/transfer
POST
{"user_id":"ou_xxx","transfer_user_id":"ou_yyy","comment":"转交"}
转交给他人
催办审批
/instances/{instance_id}/urge
POST-发送催办提醒
获取实例列表
/instances
GET查询参数：
page_size=50&page_token=xxx&user_id=ou_xxx
支持筛选参数（分页）
查询实例详情
/instances/detail
POST
{"instance_code":"xxx"}
查询完整详情
创建实例:
json
{
  "approval_code": "7C468A54-8745-2245-9675-08B7C63E7A85",
  "user_id": "ou_xxx",
  "form": "{\"widget1\":\"value1\"}"
}
APIEndpointMethodRequest Body ExampleDescription
Create Instance
/instances
POST
{"approval_code":"7C46...","user_id":"ou_xxx","form":"{\"widget1\":\"value1\"}"}
Initiate approval
Query Instance
/instances/{instance_id}
GET-Get approval status
Approval Action
/instances/{instance_id}/approve
POST
{"comment":"Approved","task_id":"xxx"}
Approve/Reject approval
Cancel Approval
/instances/{instance_id}/cancel
POST
{"user_id":"ou_xxx"}
Applicant cancels approval
Transfer Approval
/instances/{instance_code}/transfer
POST
{"user_id":"ou_xxx","transfer_user_id":"ou_yyy","comment":"Transfer"}
Transfer to another person
Urge Approval
/instances/{instance_id}/urge
POST-Send reminder for approval
Get Instance List
/instances
GETQuery Parameters: 
page_size=50&page_token=xxx&user_id=ou_xxx
Supports filter parameters (pagination)
Query Instance Details
/instances/detail
POST
{"instance_code":"xxx"}
Query complete details
Create Instance:
json
{
  "approval_code": "7C468A54-8745-2245-9675-08B7C63E7A85",
  "user_id": "ou_xxx",
  "form": "{\"widget1\":\"Request 3 days of leave\"}"
}

审批任务

Approval Tasks

API端点方法请求体示例说明
获取任务列表
/tasks
GET-查询待办任务
获取任务详情
/tasks/{task_id}
GET-查询任务详情
审批任务
/tasks/{task_id}/approve
POST
{"comment":"同意"}
处理审批任务
转交任务
/tasks/{task_id}/transfer
POST
{"transfer_user_id":"ou_xxx"}
转交任务
APIEndpointMethodRequest Body ExampleDescription
Get Task List
/tasks
GET-Query pending tasks
Get Task Details
/tasks/{task_id}
GET-Query task details
Approve Task
/tasks/{task_id}/approve
POST
{"comment":"Approved"}
Process approval task
Transfer Task
/tasks/{task_id}/transfer
POST
{"transfer_user_id":"ou_xxx"}
Transfer task

审批定义

Approval Definitions

API端点方法请求体示例说明
获取定义列表
/approvals
GET-查询所有审批模板
获取定义详情
/approvals/{approval_code}
GET-查询模板详情
获取定义表单
/approvals/{approval_code}/forms
GET-查询表单字段定义
APIEndpointMethodRequest Body ExampleDescription
Get Definition List
/approvals
GET-Query all approval templates
Get Definition Details
/approvals/{approval_code}
GET-Query template details
Get Definition Form
/approvals/{approval_code}/forms
GET-Query form field definitions

审批抄送

Approval CC

API端点方法请求体示例说明
获取抄送列表
/cc
GET-查询抄送我的审批
已读抄送
/cc/{instance_id}/read
POST-标记抄送已读
APIEndpointMethodRequest Body ExampleDescription
Get CC List
/cc
GET-Query approvals copied to me
Mark CC as Read
/cc/{instance_id}/read
POST-Mark CC as read

审批评论

Approval Comments

API端点方法请求体示例说明
添加评论
/instances/{instance_id}/comments
POST
{"content":"评论内容","user_id":"ou_xxx"}
添加审批评论
获取评论
/instances/{instance_id}/comments
GET-查询评论列表
APIEndpointMethodRequest Body ExampleDescription
Add Comment
/instances/{instance_id}/comments
POST
{"content":"Comment content","user_id":"ou_xxx"}
Add approval comment
Get Comments
/instances/{instance_id}/comments
GET-Query comment list

常见参数说明

Common Parameter Explanations

user_id_type: 用户 ID 类型
  • open_id
    （默认）
  • user_id
  • union_id
分页参数:
  • page_size
    : 每页数量（默认 20，最大 100）
  • page_token
    : 分页标记
实例状态:
  • PENDING
    : 审批中
  • APPROVED
    : 已通过
  • REJECTED
    : 已拒绝
  • CANCELED
    : 已撤回
  • DELETED
    : 已删除
user_id_type: User ID type
  • open_id
    (default)
  • user_id
  • union_id
Pagination Parameters:
  • page_size
    : Number of items per page (default 20, max 100)
  • page_token
    : Pagination token
Instance Status:
  • PENDING
    : In approval
  • APPROVED
    : Approved
  • REJECTED
    : Rejected
  • CANCELED
    : Canceled
  • DELETED
    : Deleted

测试示例

Test Examples

获取审批定义列表:
bash
curl -X GET "https://open.feishu.cn/open-apis/approval/v4/approvals?page_size=10" \
  -H "Authorization: Bearer YOUR_TOKEN"
创建审批实例:
bash
curl -X POST "https://open.feishu.cn/open-apis/approval/v4/instances" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "approval_code": "7C468A54-8745-2245-9675-08B7C63E7A85",
    "user_id": "ou_xxx",
    "form": "{\"widget1\":\"请假3天\"}"
  }'
查询实例列表:
bash
curl -X GET "https://open.feishu.cn/open-apis/approval/v4/instances?page_size=20&user_id=ou_xxx" \
  -H "Authorization: Bearer YOUR_TOKEN"
Get Approval Definition List:
bash
curl -X GET "https://open.feishu.cn/open-apis/approval/v4/approvals?page_size=10" \
  -H "Authorization: Bearer YOUR_TOKEN"
Create Approval Instance:
bash
curl -X POST "https://open.feishu.cn/open-apis/approval/v4/instances" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "approval_code": "7C468A54-8745-2245-9675-08B7C63E7A85",
    "user_id": "ou_xxx",
    "form": "{\"widget1\":\"Request 3 days of leave\"}"
  }'
Query Instance List:
bash
curl -X GET "https://open.feishu.cn/open-apis/approval/v4/instances?page_size=20&user_id=ou_xxx" \
  -H "Authorization: Bearer YOUR_TOKEN"

最佳实践

Best Practices

  1. 先获取审批定义（确认 form 字段）
  2. form 必须字符串化 JSON
  3. 审批操作需审批人权限
  4. 分页查询：大量数据用 page_token 分页
  5. user_id 必填：创建实例和查询列表都需要指定 user_id
  1. Get approval definitions first (confirm form fields)
  2. Form must be stringified JSON
  3. Approval actions require approver permissions
  4. Pagination query: Use page_token for large datasets
  5. user_id is required: Specify user_id when creating instances and querying lists