跳转至

tasks

feishu.task.tasks

TasksNamespace

Bases: Namespace

任务（Task）接口命名空间。

通过 client.task.tasks 访问，封装飞书任务 v2 中任务对象的增删改查。任务以 task_guid 唯一标识， 返回体中同时带有面向用户的 task_id（形如 t100041）与可直接打开的 url。

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

飞书文档

创建任务

源代码位于： feishu/task/tasks.py
Python
 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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
class TasksNamespace(Namespace):
    r"""
    任务（Task）接口命名空间。

    通过 `client.task.tasks` 访问，封装飞书任务 v2 中任务对象的增删改查。任务以 `task_guid` 唯一标识，
    返回体中同时带有面向用户的 `task_id`（形如 `t100041`）与可直接打开的 `url`。

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

    飞书文档:
        [创建任务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/create)
    """

    async def create(self, task: dict[str, Any], *, user_id_type: str | None = None) -> NestedDict:
        r"""
        创建任务。

        将 `task` 作为请求体发送至创建任务接口。

        Args:
            task: 任务数据，原样作为 JSON 发送，常见键包括 `summary`（标题）、`description`、`due`（截止时间）、
                `members`（成员，含 `id`/`role`/`type`）、`start`、`tasklists` 等。
            user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

        Returns:
            创建结果数据，含 `task` 字段，内含 `guid`（任务唯一标识）、`task_id`、`summary`、`status`、
            `url`、`creator`、`created_at` 等信息。

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

        飞书文档:
            [创建任务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/create)

        Examples:
            >>> await client.task.tasks.create({"summary": "写周报"})  # doctest:+SKIP
            {'task': {'guid': 'd116...', 'task_id': 't100041', 'summary': '写周报', 'status': 'todo'}}
        """
        params: dict[str, Any] = {}
        if user_id_type is not None:
            params["user_id_type"] = user_id_type
        return await self._request_data("POST", "task/v2/tasks", params=params, json=task)

    async def delete(self, task_guid: str) -> NestedDict:
        r"""
        删除任务。

        Args:
            task_guid: 任务唯一标识 `guid`。

        Returns:
            空数据体（接口成功时不返回额外字段）。

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

        飞书文档:
            [删除任务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/delete)

        Examples:
            >>> await client.task.tasks.delete("d116...")  # doctest:+SKIP
            {}
        """
        return await self._request_data("DELETE", f"task/v2/tasks/{quote_segment(task_guid)}")

    async def get(self, task_guid: str, *, user_id_type: str | None = None) -> NestedDict:
        r"""
        获取任务详情。

        Args:
            task_guid: 任务唯一标识 `guid`。
            user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

        Returns:
            任务数据，含 `task` 字段（结构同 [`create`][feishu.task.tasks.TasksNamespace.create] 的返回）。

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

        飞书文档:
            [获取任务详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/get)

        Examples:
            >>> await client.task.tasks.get("d116...")  # doctest:+SKIP
            {'task': {'guid': 'd116...', 'summary': '写周报', 'status': 'todo'}}
        """
        params: dict[str, Any] = {}
        if user_id_type is not None:
            params["user_id_type"] = user_id_type
        return await self._request_data("GET", f"task/v2/tasks/{quote_segment(task_guid)}", params=params)

    async def list(
        self,
        *,
        completed: bool | None = None,
        user_id_type: str | None = None,
        page_size: int = 50,
        max_items: int | None = None,
    ) -> builtins.list[NestedDict]:
        r"""
        获取“我负责的任务”列表。

        自动翻页并汇总当前用户负责的任务。该接口仅支持以 `user_access_token` 调用。

        Args:
            completed: 是否只返回已完成（`True`）/ 未完成（`False`）的任务；为空时返回全部。
            user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。
            page_size: 每页数量。默认为 50；超过 [feishu.consts.MAX_PAGE_SIZE][] 时由客户端收敛。
            max_items: 最多返回的任务数量，`None` 表示不限制。默认为 `None`。

        Returns:
            任务对象列表（`data.items`）；无任务时返回空列表。

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

        飞书文档:
            [获取任务列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/list)

        Examples:
            >>> await client.as_user("u-xxx").task.tasks.list(completed=False)  # doctest:+SKIP
            [{'guid': 'd116...', 'summary': '写周报', 'status': 'todo'}]
        """
        params: dict[str, Any] = {}
        if completed is not None:
            params["completed"] = completed
        if user_id_type is not None:
            params["user_id_type"] = user_id_type
        return await self._client.paginate_get("task/v2/tasks", params=params, page_size=page_size, max_items=max_items)

    async def patch(
        self,
        task_guid: str,
        task: dict[str, Any],
        update_fields: Iterable[str],
        *,
        user_id_type: str | None = None,
    ) -> NestedDict:
        r"""
        更新任务。

        飞书任务更新采用“字段白名单”语义：`task` 携带新值，`update_fields` 显式列出本次要更新的字段名，
        未列出的字段保持不变。

        Args:
            task_guid: 任务唯一标识 `guid`。
            task: 携带新值的任务字段，原样作为 JSON 发送（键同 `create`）。
            update_fields: 本次需要更新的字段名集合，例如 `["summary", "due"]`。
            user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

        Returns:
            更新后的任务数据，含 `task` 字段。

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

        飞书文档:
            [更新任务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/patch)

        Examples:
            >>> await client.task.tasks.patch("d116...", {"summary": "写月报"}, ["summary"])  # doctest:+SKIP
            {'task': {'guid': 'd116...', 'summary': '写月报'}}
        """
        params: dict[str, Any] = {}
        if user_id_type is not None:
            params["user_id_type"] = user_id_type
        body = {"task": task, "update_fields": list(update_fields)}
        return await self._request_data("PATCH", f"task/v2/tasks/{quote_segment(task_guid)}", params=params, json=body)

create async

Python
create(task: dict[str, Any], *, user_id_type: str | None = None) -> NestedDict

创建任务。

将 task 作为请求体发送至创建任务接口。

参数：

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

任务数据，原样作为 JSON 发送，常见键包括 summary（标题）、description、due（截止时间）、 members（成员，含 id/role/type）、start、tasklists 等。

 必需
user_id_type
str | None

用户 ID 的类型，如 open_id、union_id、user_id；为空时使用接口默认值。

 None

返回：

类型 描述
NestedDict

创建结果数据，含 task 字段，内含 guid（任务唯一标识）、task_id、summary、status、
NestedDict

url、creator、created_at 等信息。

引发：

类型 描述
FeishuError

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

创建任务

示例：

Python Console Session
1
2
>>> await client.task.tasks.create({"summary": "写周报"})
{'task': {'guid': 'd116...', 'task_id': 't100041', 'summary': '写周报', 'status': 'todo'}}
源代码位于： feishu/task/tasks.py
Python
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 create(self, task: dict[str, Any], *, user_id_type: str | None = None) -> NestedDict:
    r"""
    创建任务。

    将 `task` 作为请求体发送至创建任务接口。

    Args:
        task: 任务数据，原样作为 JSON 发送，常见键包括 `summary`（标题）、`description`、`due`（截止时间）、
            `members`（成员，含 `id`/`role`/`type`）、`start`、`tasklists` 等。
        user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

    Returns:
        创建结果数据，含 `task` 字段，内含 `guid`（任务唯一标识）、`task_id`、`summary`、`status`、
        `url`、`creator`、`created_at` 等信息。

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

    飞书文档:
        [创建任务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/create)

    Examples:
        >>> await client.task.tasks.create({"summary": "写周报"})  # doctest:+SKIP
        {'task': {'guid': 'd116...', 'task_id': 't100041', 'summary': '写周报', 'status': 'todo'}}
    """
    params: dict[str, Any] = {}
    if user_id_type is not None:
        params["user_id_type"] = user_id_type
    return await self._request_data("POST", "task/v2/tasks", params=params, json=task)

delete async

Python
delete(task_guid: str) -> NestedDict

删除任务。

参数：

名称 类型 描述 默认
task_guid
str

任务唯一标识 guid。

 必需

返回：

类型 描述
NestedDict

空数据体（接口成功时不返回额外字段）。

引发：

类型 描述
FeishuError

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

删除任务

示例：

Python Console Session
1
2
>>> await client.task.tasks.delete("d116...")
{}
源代码位于： feishu/task/tasks.py
Python
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
async def delete(self, task_guid: str) -> NestedDict:
    r"""
    删除任务。

    Args:
        task_guid: 任务唯一标识 `guid`。

    Returns:
        空数据体（接口成功时不返回额外字段）。

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

    飞书文档:
        [删除任务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/delete)

    Examples:
        >>> await client.task.tasks.delete("d116...")  # doctest:+SKIP
        {}
    """
    return await self._request_data("DELETE", f"task/v2/tasks/{quote_segment(task_guid)}")

get async

Python
get(task_guid: str, *, user_id_type: str | None = None) -> NestedDict

获取任务详情。

参数：

名称 类型 描述 默认
task_guid
str

任务唯一标识 guid。

 必需
user_id_type
str | None

用户 ID 的类型，如 open_id、union_id、user_id；为空时使用接口默认值。

 None

返回：

类型 描述
NestedDict

任务数据，含 task 字段（结构同 create 的返回）。

引发：

类型 描述
FeishuError

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

获取任务详情

示例：

Python Console Session
1
2
>>> await client.task.tasks.get("d116...")
{'task': {'guid': 'd116...', 'summary': '写周报', 'status': 'todo'}}
源代码位于： feishu/task/tasks.py
Python
 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
async def get(self, task_guid: str, *, user_id_type: str | None = None) -> NestedDict:
    r"""
    获取任务详情。

    Args:
        task_guid: 任务唯一标识 `guid`。
        user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

    Returns:
        任务数据，含 `task` 字段（结构同 [`create`][feishu.task.tasks.TasksNamespace.create] 的返回）。

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

    飞书文档:
        [获取任务详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/get)

    Examples:
        >>> await client.task.tasks.get("d116...")  # doctest:+SKIP
        {'task': {'guid': 'd116...', 'summary': '写周报', 'status': 'todo'}}
    """
    params: dict[str, Any] = {}
    if user_id_type is not None:
        params["user_id_type"] = user_id_type
    return await self._request_data("GET", f"task/v2/tasks/{quote_segment(task_guid)}", params=params)

list async

Python
list(*, completed: bool | None = None, user_id_type: str | None = None, page_size: int = 50, max_items: int | None = None) -> list[NestedDict]

获取“我负责的任务”列表。

自动翻页并汇总当前用户负责的任务。该接口仅支持以 user_access_token 调用。

参数：

名称 类型 描述 默认
completed
bool | None

是否只返回已完成（True）/ 未完成（False）的任务；为空时返回全部。

 None
user_id_type
str | None

用户 ID 的类型，如 open_id、union_id、user_id；为空时使用接口默认值。

 None
page_size
int

每页数量。默认为 50；超过 [feishu.consts.MAX_PAGE_SIZE][] 时由客户端收敛。

 50
max_items
int | None

最多返回的任务数量，None 表示不限制。默认为 None。

 None

返回：

类型 描述
list[NestedDict]

任务对象列表（data.items）；无任务时返回空列表。

引发：

类型 描述
FeishuError

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

获取任务列表

示例：

Python Console Session
1
2
>>> await client.as_user("u-xxx").task.tasks.list(completed=False)
[{'guid': 'd116...', 'summary': '写周报', 'status': 'todo'}]
源代码位于： feishu/task/tasks.py
Python
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
async def list(
    self,
    *,
    completed: bool | None = None,
    user_id_type: str | None = None,
    page_size: int = 50,
    max_items: int | None = None,
) -> builtins.list[NestedDict]:
    r"""
    获取“我负责的任务”列表。

    自动翻页并汇总当前用户负责的任务。该接口仅支持以 `user_access_token` 调用。

    Args:
        completed: 是否只返回已完成（`True`）/ 未完成（`False`）的任务；为空时返回全部。
        user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。
        page_size: 每页数量。默认为 50；超过 [feishu.consts.MAX_PAGE_SIZE][] 时由客户端收敛。
        max_items: 最多返回的任务数量，`None` 表示不限制。默认为 `None`。

    Returns:
        任务对象列表（`data.items`）；无任务时返回空列表。

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

    飞书文档:
        [获取任务列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/list)

    Examples:
        >>> await client.as_user("u-xxx").task.tasks.list(completed=False)  # doctest:+SKIP
        [{'guid': 'd116...', 'summary': '写周报', 'status': 'todo'}]
    """
    params: dict[str, Any] = {}
    if completed is not None:
        params["completed"] = completed
    if user_id_type is not None:
        params["user_id_type"] = user_id_type
    return await self._client.paginate_get("task/v2/tasks", params=params, page_size=page_size, max_items=max_items)

patch async

Python
patch(task_guid: str, task: dict[str, Any], update_fields: Iterable[str], *, user_id_type: str | None = None) -> NestedDict

更新任务。

飞书任务更新采用“字段白名单”语义：task 携带新值，update_fields 显式列出本次要更新的字段名， 未列出的字段保持不变。

参数：

名称 类型 描述 默认
task_guid
str

任务唯一标识 guid。

 必需
task
dict[str, Any]

携带新值的任务字段，原样作为 JSON 发送（键同 create）。

 必需
update_fields
Iterable[str]

本次需要更新的字段名集合，例如 ["summary", "due"]。

 必需
user_id_type
str | None

用户 ID 的类型，如 open_id、union_id、user_id；为空时使用接口默认值。

 None

返回：

类型 描述
NestedDict

更新后的任务数据，含 task 字段。

引发：

类型 描述
FeishuError

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

更新任务

示例：

Python Console Session
1
2
>>> await client.task.tasks.patch("d116...", {"summary": "写月报"}, ["summary"])
{'task': {'guid': 'd116...', 'summary': '写月报'}}
源代码位于： feishu/task/tasks.py
Python
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
async def patch(
    self,
    task_guid: str,
    task: dict[str, Any],
    update_fields: Iterable[str],
    *,
    user_id_type: str | None = None,
) -> NestedDict:
    r"""
    更新任务。

    飞书任务更新采用“字段白名单”语义：`task` 携带新值，`update_fields` 显式列出本次要更新的字段名，
    未列出的字段保持不变。

    Args:
        task_guid: 任务唯一标识 `guid`。
        task: 携带新值的任务字段，原样作为 JSON 发送（键同 `create`）。
        update_fields: 本次需要更新的字段名集合，例如 `["summary", "due"]`。
        user_id_type: 用户 ID 的类型，如 `open_id`、`union_id`、`user_id`；为空时使用接口默认值。

    Returns:
        更新后的任务数据，含 `task` 字段。

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

    飞书文档:
        [更新任务](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/task/patch)

    Examples:
        >>> await client.task.tasks.patch("d116...", {"summary": "写月报"}, ["summary"])  # doctest:+SKIP
        {'task': {'guid': 'd116...', 'summary': '写月报'}}
    """
    params: dict[str, Any] = {}
    if user_id_type is not None:
        params["user_id_type"] = user_id_type
    body = {"task": task, "update_fields": list(update_fields)}
    return await self._request_data("PATCH", f"task/v2/tasks/{quote_segment(task_guid)}", params=params, json=body)