飞书开放平台 Server API 文档

主题

任务移出清单 ​

将任务从一个清单中移出。返回任务详情。

如果任务不在清单中，接口将返回成功。

Tip: 需要清单的可编辑权限。详情见清单功能概述中的“清单是如何鉴权的？“章节。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/task/v2/tasks/:task_guid/remove_tasklist
HTTP MethodPOST
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用task:task:write 查看、创建、更新、删除任务

请求头 ​

名称类型必填描述
Authorizationstring是tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Typestring是固定值："application/json; charset=utf-8"

路径参数 ​

名称类型描述
task_guidstring要从清单移除的任务的全局唯一ID
示例值："d300a75f-c56a-4be9-80d1-e47653028ceb"

查询参数 ​

名称类型必填描述
user_id_typestring否用户 ID 类型
示例值：open_id
默认值：open_id

请求体 ​

名称类型必填描述
tasklist_guidstring是要移除的清单的全局唯一ID
示例值："d300a75f-c56a-4be9-80d1-e47653028ceb"
数据校验规则：
- 最大长度：100 字符

请求体示例 ​

json
{
    "tasklist_guid": "d300a75f-c56a-4be9-80d1-e47653028ceb"
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ tasktask添加后的任务详情
    └ guidstring任务guid，任务的唯一ID
    └ summarystring任务标题
    └ descriptionstring任务描述
    └ duedue任务截止时间
      └ timestampstring截止时间/日期的时间戳，距1970-01-01 00:00:00的毫秒数。如果截止时间是一个日期，需要把日期转换成时间戳，并设置 is_all_day=true
      └ is_all_dayboolean是否截止到一个日期。如果设为true，timestamp中只有日期的部分会被解析和存储。
    └ remindersreminder\[\]任务的提醒配置列表。目前每个任务最多有1个。
      └ idstring提醒时间设置的 ID
      └ relative_fire_minuteint相对于截止时间的提醒时间分钟数。例如30表示截止时间前30分钟提醒；0表示截止时提醒。
    └ creatormember任务创建者
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring成员角色
    └ membersmember\[\]任务成员列表
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring成员角色
    └ completed_atstring任务完成的时间戳(ms)
    └ attachmentsattachment\[\]任务的附件列表
      └ guidstring附件guid
      └ file_tokenstring附件在云文档系统中的token
      └ namestring附件名
      └ sizeint附件的字节大小
      └ resourceresource附件归属的资源
        └ typestring资源类型
        └ idstring资源ID
      └ uploadermember附件上传者
        └ idstring表示member的id
        └ typestring成员的类型
        └ rolestring成员角色
      └ is_coverboolean是否是封面图
      └ uploaded_atstring上传时间戳(ms)
    └ originorigin任务关联的第三方平台来源信息。创建是设置后就不可更改。
      └ platform_i18n_namei18n_text任务导入来源的名称，用于在任务中心详情页展示。需提供多语言版本。
        └ en_usstring英文
        └ zh_cnstring中文
        └ zh_hkstring中文（香港地区）
        └ zh_twstring中文（台湾地区）
        └ ja_jpstring日语
        └ fr_frstring法语
        └ it_itstring意大利语
        └ de_destring德语
        └ ru_rustring俄语
        └ th_thstring泰语
        └ es_esstring西班牙语
        └ ko_krstring韩语
      └ hrefhref任务关联的来源平台详情页链接
        └ urlstring链接对应的地址
        └ titlestring链接对应的标题
    └ extrastring任务附带的自定义数据。
    └ taskliststask_in_tasklist_info\[\]任务所属清单的名字。调用者只能看到有权限访问的清单的列表。
      └ tasklist_guidstring任务所在清单的guid
      └ section_guidstring任务所在清单的自定义分组guid
    └ repeat_rulestring如果任务为重复任务，返回重复任务的配置
    └ parent_task_guidstring如果当前任务为某个任务的子任务，返回父任务的guid
    └ modeint任务的模式。1 - 会签任务；2 - 或签任务
    └ sourceint任务创建的来源
可选值有：
- 0: 未知来源 - 1: 任务中心 - 2: 群组任务/消息转任务 - 6: 通过开放平台以tenant_access_token授权创建的任务 - 7: 通过开放平台以user_access_token授权创建的任务 - 8: 文档任务
    └ custom_completecustom_complete任务的自定义完成配置
      └ pccustom_complete_itempc客户端自定义完成配置（含mac和windows）
        └ hrefstring自定义完成的跳转url
        └ tipi18n_text自定义完成的弹出提示为
          └ en_usstring英文
          └ zh_cnstring中文
          └ zh_hkstring中文（香港地区）
          └ zh_twstring中文（台湾地区）
          └ ja_jpstring日语
          └ fr_frstring法语
          └ it_itstring意大利语
          └ de_destring德语
          └ ru_rustring俄语
          └ th_thstring泰语
          └ es_esstring西班牙语
          └ ko_krstring韩语
      └ ioscustom_complete_itemios端的自定义完成配置
        └ hrefstring自定义完成的跳转url
        └ tipi18n_text自定义完成的弹出提示为
          └ en_usstring英文
          └ zh_cnstring中文
          └ zh_hkstring中文（香港地区）
          └ zh_twstring中文（台湾地区）
          └ ja_jpstring日语
          └ fr_frstring法语
          └ it_itstring意大利语
          └ de_destring德语
          └ ru_rustring俄语
          └ th_thstring泰语
          └ es_esstring西班牙语
          └ ko_krstring韩语
      └ androidcustom_complete_itemandroid端的自定义完成配置
        └ hrefstring自定义完成的跳转url
        └ tipi18n_text自定义完成的弹出提示为
          └ en_usstring英文
          └ zh_cnstring中文
          └ zh_hkstring中文（香港地区）
          └ zh_twstring中文（台湾地区）
          └ ja_jpstring日语
          └ fr_frstring法语
          └ it_itstring意大利语
          └ de_destring德语
          └ ru_rustring俄语
          └ th_thstring泰语
          └ es_esstring西班牙语
          └ ko_krstring韩语
    └ task_idstring任务界面上的代码
    └ created_atstring任务创建时间戳(ms)
    └ updated_atstring任务最后一次更新的时间戳(ms)
    └ statusstring任务的状态，支持"todo"和"done"两种状态
    └ urlstring任务的分享链接
    └ startstart任务的开始时间
      └ timestampstring开始时间/日期的时间戳，距1970-01-01 00:00:00的毫秒数。如果开始时间是一个日期，需要把日期转换成时间戳，并设置 is_all_day=true
      └ is_all_dayboolean是否开始于一个日期。如果设为true，timestamp中只有日期的部分会被解析和存储。
    └ subtask_countint该任务的子任务的个数。

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "task": {
            "guid": "83912691-2e43-47fc-94a4-d512e03984fa",
            "summary": "进行销售年中总结",
            "description": "进行销售年中总结",
            "due": {
                "timestamp": "1675454764000",
                "is_all_day": true
            },
            "reminders": [
                {
                    "id": "10",
                    "relative_fire_minute": 30
                }
            ],
            "creator": {
                "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                "type": "user",
                "role": "assignee"
            },
            "members": [
                {
                    "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                    "type": "user",
                    "role": "assignee"
                }
            ],
            "completed_at": "1675742789470",
            "attachments": [
                {
                    "guid": "f860de3e-6881-4ddd-9321-070f36d1af0b",
                    "file_token": "boxcnTDqPaRA6JbYnzQsZ2doB2b",
                    "name": "foo.jpg",
                    "size": 62232,
                    "resource": {
                        "type": "task",
                        "id": "e6e37dcc-f75a-5936-f589-12fb4b5c80c2"
                    },
                    "uploader": {
                        "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                        "type": "user",
                        "role": "assignee"
                    },
                    "is_cover": false,
                    "uploaded_at": "1675742789470"
                }
            ],
            "origin": {
                "platform_i18n_name": {
                    "en_us": "workbench",
                    "zh_cn": "工作台",
                    "zh_hk": "工作臺",
                    "zh_tw": "工作臺",
                    "ja_jp": "作業台",
                    "fr_fr": "Table de travail",
                    "it_it": "banco di lavoro",
                    "de_de": "Werkbank",
                    "ru_ru": "верстак",
                    "th_th": "โต๊ะทำงาน",
                    "es_es": "banco de trabajo",
                    "ko_kr": "작업대"
                },
                "href": {
                    "url": "https://support.foo.com/internal/bar",
                    "title": "反馈一个问题，需要协助排查"
                }
            },
            "extra": "dGVzdA==",
            "tasklists": [
                {
                    "tasklist_guid": "cc371766-6584-cf50-a222-c22cd9055004",
                    "section_guid": "e6e37dcc-f75a-5936-f589-12fb4b5c80c2"
                }
            ],
            "repeat_rule": "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR",
            "parent_task_guid": "e297ddff-06ca-4166-b917-4ce57cd3a7a0",
            "mode": 2,
            "source": 6,
            "custom_complete": {
                "pc": {
                    "href": "https://www.example.com",
                    "tip": {
                        "en_us": "workbench",
                        "zh_cn": "工作台",
                        "zh_hk": "工作臺",
                        "zh_tw": "工作臺",
                        "ja_jp": "作業台",
                        "fr_fr": "Table de travail",
                        "it_it": "banco di lavoro",
                        "de_de": "Werkbank",
                        "ru_ru": "верстак",
                        "th_th": "โต๊ะทำงาน",
                        "es_es": "banco de trabajo",
                        "ko_kr": "작업대"
                    }
                },
                "ios": {
                    "href": "https://www.example.com",
                    "tip": {
                        "en_us": "workbench",
                        "zh_cn": "工作台",
                        "zh_hk": "工作臺",
                        "zh_tw": "工作臺",
                        "ja_jp": "作業台",
                        "fr_fr": "Table de travail",
                        "it_it": "banco di lavoro",
                        "de_de": "Werkbank",
                        "ru_ru": "верстак",
                        "th_th": "โต๊ะทำงาน",
                        "es_es": "banco de trabajo",
                        "ko_kr": "작업대"
                    }
                },
                "android": {
                    "href": "https://www.example.com",
                    "tip": {
                        "en_us": "workbench",
                        "zh_cn": "工作台",
                        "zh_hk": "工作臺",
                        "zh_tw": "工作臺",
                        "ja_jp": "作業台",
                        "fr_fr": "Table de travail",
                        "it_it": "banco di lavoro",
                        "de_de": "Werkbank",
                        "ru_ru": "верстак",
                        "th_th": "โต๊ะทำงาน",
                        "es_es": "banco de trabajo",
                        "ko_kr": "작업대"
                    }
                }
            },
            "task_id": "t6272302",
            "created_at": "1675742789470",
            "updated_at": "1675742789470",
            "status": "todo",
            "url": "https://applink.feishu.cn/client/todo/detail?guid=70577c8f-91ab-4c91-b359-a21a751054e8&suite_entity_num=t192012",
            "start": {
                "timestamp": "1675454764000",
                "is_all_day": true
            },
            "subtask_count": 1
        }
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
4001470400请求参数错误，如传入的清单GUID不合法。错误原因见返回的msg提示的信息。
4041470404任务数据不存在或者已删除。确认要访问的任务数据是否存在或已删除。
5001470500服务器错误。尝试重试调用。如持续失败，请联系支持人员进行反馈。
4031470403缺少任务移出清单的权限。检查调用身份是否有清单的可编辑权限。详情见清单功能概述中的“清单是如何鉴权的？“章节。

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

本镜像仅供学习与查阅，文档版权归飞书所有