跳转至

instances

feishu.approval.instances

InstancesNamespace

Bases: Namespace

审批实例接口命名空间。

通过 client.approval.instances 访问，封装飞书审批中审批实例（instance）相关的服务端接口， 包括创建、查询、列举与撤回审批实例等能力。依据审批定义（approval_code）发起的实例以 instance_id（或 instance_code）标识，实例内含若干待办任务与评论。

通常无需直接实例化，应通过 client.approval.instances 访问。

飞书文档

审批 / 审批实例

源代码位于： feishu/approval/instances.py
Python
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
class InstancesNamespace(Namespace):
    r"""
    审批实例接口命名空间。

    通过 `client.approval.instances` 访问，封装飞书审批中审批实例（instance）相关的服务端接口，
    包括创建、查询、列举与撤回审批实例等能力。依据审批定义（`approval_code`）发起的实例以
    `instance_id`（或 `instance_code`）标识，实例内含若干待办任务与评论。

    通常无需直接实例化，应通过 `client.approval.instances` 访问。

    飞书文档:
        [审批 / 审批实例](https://open.feishu.cn/document/server-docs/approval-v4/instance/create)
    """

    async def cancel(self, approval_code: str, instance_code: str, user_id: str) -> NestedDict:
        r"""
        撤回审批实例。

        将 `approval_code`、`instance_code`、`user_id` 作为请求体字段发送，撤回指定用户
        发起的审批实例。

        Args:
            approval_code: 审批定义的唯一标识 `approval_code`。
            instance_code: 待撤回审批实例的 `instance_code`。
            user_id: 发起撤回操作的用户 ID。

        Returns:
            接口返回的数据（通常为空）。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [撤回审批实例](https://open.feishu.cn/document/server-docs/approval-v4/instance/cancel)

        Examples:
            >>> await client.approval.instances.cancel("ABC123", "INST123", "u1")  # doctest:+SKIP
            {}
        """
        return await self._request_data(
            "POST",
            "approval/v4/instances/cancel",
            json={"approval_code": approval_code, "instance_code": instance_code, "user_id": user_id},
        )

    async def create(self, instance: dict[str, Any]) -> NestedDict:
        r"""
        创建审批实例。

        `instance` 是描述待创建审批实例的请求体，原样作为 JSON 发送，常见键包括
        `approval_code`、`form`、`user_id`、`open_id`、`department_id`、`node_approver_user_id_list`
        等。

        Args:
            instance: 审批实例定义对象，例如
                `{"approval_code": "ABC123", "user_id": "u1", "form": "[...]"}`。

        Returns:
            创建结果数据，含新建实例的 `instance_code` 等字段。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [创建审批实例](https://open.feishu.cn/document/server-docs/approval-v4/instance/create)

        Examples:
            >>> await client.approval.instances.create({"approval_code": "ABC123", "user_id": "u1"})  # doctest:+SKIP
            {'instance_code': 'INST123'}  # noqa: E501
        """
        return await self._request_data("POST", "approval/v4/instances", json=instance)

    async def get(self, instance_id: str) -> NestedDict:
        r"""
        获取审批实例详情。

        Args:
            instance_id: 审批实例的唯一标识 `instance_id`（即 `instance_code`）。

        Returns:
            审批实例数据，含 `approval_code`、`approval_name`、`status`、`form`、
            `task_list`、`comment_list`、`timeline` 等字段。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [获取单个审批实例详情](https://open.feishu.cn/document/server-docs/approval-v4/instance/get)

        Examples:
            >>> await client.approval.instances.get("INST123")  # doctest:+SKIP
            {'approval_code': 'ABC123', 'status': 'PENDING', 'form': '...', ...}  # noqa: E501
        """
        return await self._request_data("GET", f"approval/v4/instances/{quote_segment(instance_id)}")

    async def list(
        self,
        approval_code: str,
        start_time: str,
        end_time: str,
        *,
        page_size: int = 50,
        max_items: int | None = None,
    ) -> list[str]:
        r"""
        批量获取审批实例 ID。

        自动翻页并将各页结果拼接为单个列表返回。`page_size` 会被限制在
        [feishu.consts.MAX_PAGE_SIZE][] 以内。`approval_code`、`start_time`、`end_time`
        为必填查询参数。实例 ID 列表的条目位于响应体的 `instance_code_list` 字段下，且每个
        条目为实例编码（`instance_code`）字符串而非对象。

        Args:
            approval_code: 审批定义的唯一标识 `approval_code`（必填）。
            start_time: 时间范围的起始（毫秒时间戳字符串，必填）。
            end_time: 时间范围的结束（毫秒时间戳字符串，必填）。
            page_size: 每页条数，默认为 50，超过上限时按上限截断。
            max_items: 最多返回的条数；为空表示返回全部。

        Returns:
            审批实例编码（`instance_code`）字符串列表。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [批量获取审批实例 ID](https://open.feishu.cn/document/server-docs/approval-v4/instance/list)

        Examples:
            >>> await client.approval.instances.list("ABC123", "1609459200000", "1612137600000")  # doctest:+SKIP
            ['INST1', 'INST2', ...]  # noqa: E501
        """
        return await self._client.paginate_get(
            "approval/v4/instances",
            params={"approval_code": approval_code, "start_time": start_time, "end_time": end_time},
            page_size=page_size,
            max_items=max_items,
            items_key="instance_code_list",
        )

cancel async

Python
cancel(approval_code: str, instance_code: str, user_id: str) -> NestedDict

撤回审批实例。

将 approval_code、instance_code、user_id 作为请求体字段发送，撤回指定用户 发起的审批实例。

参数：

名称 类型 描述 默认
approval_code
str

审批定义的唯一标识 approval_code。

 必需
instance_code
str

待撤回审批实例的 instance_code。

 必需
user_id
str

发起撤回操作的用户 ID。

 必需

返回：

类型 描述
NestedDict

接口返回的数据（通常为空）。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

撤回审批实例

示例：

Python Console Session
1
2
>>> await client.approval.instances.cancel("ABC123", "INST123", "u1")
{}
源代码位于： feishu/approval/instances.py
Python
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
async def cancel(self, approval_code: str, instance_code: str, user_id: str) -> NestedDict:
    r"""
    撤回审批实例。

    将 `approval_code`、`instance_code`、`user_id` 作为请求体字段发送，撤回指定用户
    发起的审批实例。

    Args:
        approval_code: 审批定义的唯一标识 `approval_code`。
        instance_code: 待撤回审批实例的 `instance_code`。
        user_id: 发起撤回操作的用户 ID。

    Returns:
        接口返回的数据（通常为空）。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [撤回审批实例](https://open.feishu.cn/document/server-docs/approval-v4/instance/cancel)

    Examples:
        >>> await client.approval.instances.cancel("ABC123", "INST123", "u1")  # doctest:+SKIP
        {}
    """
    return await self._request_data(
        "POST",
        "approval/v4/instances/cancel",
        json={"approval_code": approval_code, "instance_code": instance_code, "user_id": user_id},
    )

create async

Python
create(instance: dict[str, Any]) -> NestedDict

创建审批实例。

instance 是描述待创建审批实例的请求体，原样作为 JSON 发送，常见键包括 approval_code、form、user_id、open_id、department_id、node_approver_user_id_list 等。

参数：

名称 类型 描述 默认
instance
dict[str, Any]

审批实例定义对象，例如 {"approval_code": "ABC123", "user_id": "u1", "form": "[...]"}。

 必需

返回：

类型 描述
NestedDict

创建结果数据，含新建实例的 instance_code 等字段。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

创建审批实例

示例：

Python Console Session
1
2
>>> await client.approval.instances.create({"approval_code": "ABC123", "user_id": "u1"})
{'instance_code': 'INST123'}  # noqa: E501
源代码位于： feishu/approval/instances.py
Python
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
async def create(self, instance: dict[str, Any]) -> NestedDict:
    r"""
    创建审批实例。

    `instance` 是描述待创建审批实例的请求体，原样作为 JSON 发送，常见键包括
    `approval_code`、`form`、`user_id`、`open_id`、`department_id`、`node_approver_user_id_list`
    等。

    Args:
        instance: 审批实例定义对象，例如
            `{"approval_code": "ABC123", "user_id": "u1", "form": "[...]"}`。

    Returns:
        创建结果数据，含新建实例的 `instance_code` 等字段。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [创建审批实例](https://open.feishu.cn/document/server-docs/approval-v4/instance/create)

    Examples:
        >>> await client.approval.instances.create({"approval_code": "ABC123", "user_id": "u1"})  # doctest:+SKIP
        {'instance_code': 'INST123'}  # noqa: E501
    """
    return await self._request_data("POST", "approval/v4/instances", json=instance)

get async

Python
get(instance_id: str) -> NestedDict

获取审批实例详情。

参数：

名称 类型 描述 默认
instance_id
str

审批实例的唯一标识 instance_id（即 instance_code）。

 必需

返回：

类型 描述
NestedDict

审批实例数据，含 approval_code、approval_name、status、form、
NestedDict

task_list、comment_list、timeline 等字段。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

获取单个审批实例详情

示例：

Python Console Session
1
2
>>> await client.approval.instances.get("INST123")
{'approval_code': 'ABC123', 'status': 'PENDING', 'form': '...', ...}  # noqa: E501
源代码位于： feishu/approval/instances.py
Python
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
async def get(self, instance_id: str) -> NestedDict:
    r"""
    获取审批实例详情。

    Args:
        instance_id: 审批实例的唯一标识 `instance_id`（即 `instance_code`）。

    Returns:
        审批实例数据，含 `approval_code`、`approval_name`、`status`、`form`、
        `task_list`、`comment_list`、`timeline` 等字段。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [获取单个审批实例详情](https://open.feishu.cn/document/server-docs/approval-v4/instance/get)

    Examples:
        >>> await client.approval.instances.get("INST123")  # doctest:+SKIP
        {'approval_code': 'ABC123', 'status': 'PENDING', 'form': '...', ...}  # noqa: E501
    """
    return await self._request_data("GET", f"approval/v4/instances/{quote_segment(instance_id)}")

list async

Python
list(approval_code: str, start_time: str, end_time: str, *, page_size: int = 50, max_items: int | None = None) -> list[str]

批量获取审批实例 ID。

自动翻页并将各页结果拼接为单个列表返回。page_size 会被限制在 [feishu.consts.MAX_PAGE_SIZE][] 以内。approval_code、start_time、end_time 为必填查询参数。实例 ID 列表的条目位于响应体的 instance_code_list 字段下，且每个 条目为实例编码（instance_code）字符串而非对象。

参数：

名称 类型 描述 默认
approval_code
str

审批定义的唯一标识 approval_code（必填）。

 必需
start_time
str

时间范围的起始（毫秒时间戳字符串，必填）。

 必需
end_time
str

时间范围的结束（毫秒时间戳字符串，必填）。

 必需
page_size
int

每页条数，默认为 50，超过上限时按上限截断。

 50
max_items
int | None

最多返回的条数；为空表示返回全部。

 None

返回：

类型 描述
list[str]

审批实例编码（instance_code）字符串列表。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

批量获取审批实例 ID

示例：

Python Console Session
1
2
>>> await client.approval.instances.list("ABC123", "1609459200000", "1612137600000")
['INST1', 'INST2', ...]  # noqa: E501
源代码位于： feishu/approval/instances.py
Python
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
async def list(
    self,
    approval_code: str,
    start_time: str,
    end_time: str,
    *,
    page_size: int = 50,
    max_items: int | None = None,
) -> list[str]:
    r"""
    批量获取审批实例 ID。

    自动翻页并将各页结果拼接为单个列表返回。`page_size` 会被限制在
    [feishu.consts.MAX_PAGE_SIZE][] 以内。`approval_code`、`start_time`、`end_time`
    为必填查询参数。实例 ID 列表的条目位于响应体的 `instance_code_list` 字段下，且每个
    条目为实例编码（`instance_code`）字符串而非对象。

    Args:
        approval_code: 审批定义的唯一标识 `approval_code`（必填）。
        start_time: 时间范围的起始（毫秒时间戳字符串，必填）。
        end_time: 时间范围的结束（毫秒时间戳字符串，必填）。
        page_size: 每页条数，默认为 50，超过上限时按上限截断。
        max_items: 最多返回的条数；为空表示返回全部。

    Returns:
        审批实例编码（`instance_code`）字符串列表。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [批量获取审批实例 ID](https://open.feishu.cn/document/server-docs/approval-v4/instance/list)

    Examples:
        >>> await client.approval.instances.list("ABC123", "1609459200000", "1612137600000")  # doctest:+SKIP
        ['INST1', 'INST2', ...]  # noqa: E501
    """
    return await self._client.paginate_get(
        "approval/v4/instances",
        params={"approval_code": approval_code, "start_time": start_time, "end_time": end_time},
        page_size=page_size,
        max_items=max_items,
        items_key="instance_code_list",
    )