飞书开放平台 Server API 文档

主题

创建任务 ​

该接口可以创建一个任务，在创建任务时，支持填写任务的基本信息（如标题、描述、负责人等），此外，还可以设置任务的开始时间、截止时间提醒等条件，此外，还可以通过传入 tasklists 字段将新任务加到多个清单中。

创建任务时，可以通过设置members字段来设置任务的负责人和关注人。关于member的格式，详见功能概述中的“ 如何表示任务和清单的成员？ ”章节。

如果要设置任务的开始时间和截止时间，需要遵守任务时间的格式和约束。详见功能概述中的“ 如何使用开始时间和截止时间？”章节。

如要设置自定义字段值，可以设置custom_fields字段。但因为自定义字段归属于清单，因此要填写的自定义字段的guid必须归属于要添加的清单(通过tasklists设置）。详见自定义字段概览。

通过设置client_token实现幂等调用。详见功能概述中的“ 幂等调用 ”章节。

如要创建一个任务的子任务，需要使用创建子任务接口。

创建任务时可以一并设置自定义字段值。但根据自定义字段的权限关系，任务只能添加tasklists字段设置的清单中关联的自定义字段的值。详见自定义字段功能概述中的介绍。

Tip: 如果创建任务时要将任务加入到多个清单中，调用身份必须对所有清单有可编辑权限。详情见清单功能概述中的“清单是如何鉴权的？“章节。

请求 ​

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

请求头 ​

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

查询参数 ​

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

请求体 ​

名称类型必填描述
summarystring是任务标题。不能为空，支持最大3000个utf8字符。
示例值："针对全年销售进行一次复盘"
descriptionstring否任务摘要。支持最大3000个utf8字符。
示例值："需要事先阅读复盘总结文档"
duedue否任务截止时间。详见功能概述中的“ 如何使用开始时间和截止时间？”章节。
示例值：1675742789470
  └ timestampstring否截止时间/日期的时间戳，距1970-01-01 00:00:00 UTC的毫秒数。如果截止时间是一个日期，需要把日期转换成时间戳，并设置 is_all_day=true
示例值："1675454764000"
  └ is_all_dayboolean否是否截止到一个日期。如果设为true，timestamp中只有日期的部分会被解析和存储。
示例值：true
originorigin否任务关联的第三方平台来源信息，用于来源信息在飞书任务界面的展示。只能创建任务时设置，一旦设置后就不可变更。详见功能概述中的“ 如何使用Origin? ”章节。
  └ platform_i18n_namei18n_text否任务导入来源的名称，用于在任务中心详情页展示。需提供多语言版本。
    └ en_usstring否英文
示例值："workbench"
数据校验规则：
- 最大长度：1000 字符
    └ zh_cnstring否中文
示例值："工作台"
数据校验规则：
- 最大长度：1000 字符
    └ zh_hkstring否中文（香港地区）
示例值："工作臺"
数据校验规则：
- 最大长度：1000 字符
    └ zh_twstring否中文（台湾地区）
示例值："工作臺"
数据校验规则：
- 最大长度：1000 字符
    └ ja_jpstring否日语
示例值："作業台"
数据校验规则：
- 最大长度：1000 字符
    └ fr_frstring否法语
示例值："Table de travail"
    └ it_itstring否意大利语
示例值："banco di lavoro"
    └ de_destring否德语
示例值："Werkbank"
    └ ru_rustring否俄语
示例值："верстак"
    └ th_thstring否泰语
示例值："โต๊ะทำงาน"
    └ es_esstring否西班牙语
示例值："banco de trabajo"
    └ ko_krstring否韩语
示例值："작업대"
  └ hrefhref否任务关联的来源平台详情页链接
    └ urlstring否来源链接对应的地址，如填写必须以https://或者http😕/开头。
说明：如需调整 PC 端链接打开方式，可在飞书客户端的 设置 > 效率 > 链接打开方式 内调整。
示例值："https://www.example.com"
数据校验规则：
- 长度范围：0 ～ 1024 字符
    └ titlestring否来源链接对应的标题
示例值："反馈一个问题，需要协助排查"
数据校验规则：
- 最大长度：512 字符
extrastring否调用者可以传入的任意附带到任务上的数据。在获取任务详情时会原样返回。如果是二进制数据可以使用Base64编码。
示例值："dGVzdA=="
数据校验规则：
- 最大长度：65536 字符
completed_atstring否任务的完成时刻时间戳(ms)。不填写或者设为0表示创建一个未完成任务；填写一个具体的时间戳表示创建一个已完成任务。
示例值："1675742789470"
默认值：0
数据校验规则：
- 最大长度：20 字符
membersmember\[\]否任务成员列表，包括负责人和关注人。不填写表示任务无成员。单次请求支持最大50个成员（去重后）。
详见功能概述中的“ 如何表示任务和清单的成员？ ”章节。
示例值：[ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f]
  └ idstring是表示member的id
示例值："ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f"
数据校验规则：
- 最大长度：100 字符
  └ typestring否成员的类型，可以是user或者app。
示例值："user"
默认值：user
  └ rolestring是成员角色，可以是"assignee"或者"follower"。
示例值："assignee"
数据校验规则：
- 最大长度：20 字符
  └ namestring否成员名称
示例值："张明德（明德）"
repeat_rulestring否重复任务规则。如果设置，则该任务为“重复任务”。详见任务功能概述中的“如何使用重复任务？”章节。
示例值："FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR"
数据校验规则：
- 最大长度：1000 字符
custom_completecustom_complete否任务自定义完成配置。详见任务功能概述中的“ 如何使用任务自定义完成？”章节。
  └ pccustom_complete_item否pc客户端自定义完成配置（含mac和windows）
    └ hrefstring否自定义完成的跳转url
示例值："https://www.example.com"
    └ tipi18n_text否自定义完成的弹出提示
      └ en_usstring否英文
示例值："workbench"
数据校验规则：
- 最大长度：1000 字符
      └ zh_cnstring否中文
示例值："工作台"
数据校验规则：
- 最大长度：1000 字符
      └ zh_hkstring否中文（香港地区）
示例值："工作臺"
数据校验规则：
- 最大长度：1000 字符
      └ zh_twstring否中文（台湾地区）
示例值："工作臺"
数据校验规则：
- 最大长度：1000 字符
      └ ja_jpstring否日语
示例值："作業台"
数据校验规则：
- 最大长度：1000 字符
      └ fr_frstring否法语
示例值："Table de travail"
      └ it_itstring否意大利语
示例值："banco di lavoro"
      └ de_destring否德语
示例值："Werkbank"
      └ ru_rustring否俄语
示例值："верстак"
      └ th_thstring否泰语
示例值："โต๊ะทำงาน"
      └ es_esstring否西班牙语
示例值："banco de trabajo"
      └ ko_krstring否韩语
示例值："작업대"
  └ ioscustom_complete_item否ios端的自定义完成配置
    └ hrefstring否自定义完成的跳转url
示例值："https://www.example.com"
    └ tipi18n_text否自定义完成的弹出提示为
      └ en_usstring否英文
示例值："workbench"
数据校验规则：
- 最大长度：1000 字符
      └ zh_cnstring否中文
示例值："工作台"
数据校验规则：
- 最大长度：1000 字符
      └ zh_hkstring否中文（香港地区）
示例值："工作臺"
数据校验规则：
- 最大长度：1000 字符
      └ zh_twstring否中文（台湾地区）
示例值："工作臺"
数据校验规则：
- 最大长度：1000 字符
      └ ja_jpstring否日语
示例值："作業台"
数据校验规则：
- 最大长度：1000 字符
      └ fr_frstring否法语
示例值："Table de travail"
      └ it_itstring否意大利语
示例值："banco di lavoro"
      └ de_destring否德语
示例值："Werkbank"
      └ ru_rustring否俄语
示例值："верстак"
      └ th_thstring否泰语
示例值："โต๊ะทำงาน"
      └ es_esstring否西班牙语
示例值："banco de trabajo"
      └ ko_krstring否韩语
示例值："작업대"
  └ androidcustom_complete_item否android端的自定义完成配置
    └ hrefstring否自定义完成的跳转url
示例值："https://www.example.com"
    └ tipi18n_text否自定义完成的弹出提示为
      └ en_usstring否英文
示例值："workbench"
数据校验规则：
- 最大长度：1000 字符
      └ zh_cnstring否中文
示例值："工作台"
数据校验规则：
- 最大长度：1000 字符
      └ zh_hkstring否中文（香港地区）
示例值："工作臺"
数据校验规则：
- 最大长度：1000 字符
      └ zh_twstring否中文（台湾地区）
示例值："工作臺"
数据校验规则：
- 最大长度：1000 字符
      └ ja_jpstring否日语
示例值："作業台"
数据校验规则：
- 最大长度：1000 字符
      └ fr_frstring否法语
示例值："Table de travail"
      └ it_itstring否意大利语
示例值："banco di lavoro"
      └ de_destring否德语
示例值："Werkbank"
      └ ru_rustring否俄语
示例值："верстак"
      └ th_thstring否泰语
示例值："โต๊ะทำงาน"
      └ es_esstring否西班牙语
示例值："banco de trabajo"
      └ ko_krstring否韩语
示例值："작업대"
taskliststask_in_tasklist_info\[\]否任务所在清单的信息
  └ tasklist_guidstring否指定在某个清单中创建任务，需要该清单的可编辑权限。不填写表示不在清单中创建任务。
示例值："cc371766-6584-cf50-a222-c22cd9055004"
数据校验规则：
- 最大长度：100 字符
  └ section_guidstring否清单中自定义分组的GUID，用于指定在某个清单中创建任务的同时把任务加入到某个具体的分组中。如果填写了清单的GUID，却没填写分组的GUID，则自动加入该清单的默认分组中。
示例值："e6e37dcc-f75a-5936-f589-12fb4b5c80c2"
client_tokenstring否幂等token。如果提供则触发后端实现幂等行为。详见功能概述中的“ 幂等调用 ”章节。
示例值："daa2237f-8310-4707-a83b-52c8a81e0fb7"
数据校验规则：
- 长度范围：10 ～ 100 字符
startstart否任务的开始时间(ms), 详见功能概述中的“ 如何使用开始时间和截止时间？”章节。
  └ timestampstring否开始时间/日期的时间戳，距1970-01-01 00:00:00的毫秒数。如果开始时间是一个日期，需要把日期转换成时间戳，并设置 is_all_day=true。
如果同时设置任务的开始时间和截止时间，开始时间必须<=截止时间，并且开始/截止时间的is_all_day设置必须相同。
示例值："1675454764000"
  └ is_all_dayboolean否是否开始于一个日期。如果设为true，timestamp中只有日期的部分会被解析和存储。
示例值：true
remindersreminder\[\]否任务提醒。要设置提醒必须同时设置任务的截止时间。一个任务最多只能设置1个提醒。
  └ relative_fire_minuteint是相对于截止时间的提醒时间分钟数，取值必须大于等于0（调用本接口只能设置截止日期前的提醒时间）。例如30表示截止时间前30分钟提醒；0表示截止时提醒。
示例值：30
modeint否任务完成模式, 1 - 会签任务; 2 - 或签任务
示例值：2
默认值：2
数据校验规则：
- 取值范围：1 ～ 2
is_milestoneboolean否是否是里程碑任务
示例值：false
默认值：false
custom_fieldsinput_custom_field_value\[\]否自定义字段值。可以在创建任务的同时设置一个或多个自定义字段的值。要设置值的自定义字段必须关联于任务要加入的清单(通过tasklists字段设置），否则将无法设置。
每个字段的值根据字段类型填写相应的字段。 * 当type为"number"时，应使用number_value字段，表示数字类型自定义字段的值； * 当type为"member"时，应使用member_value字段，表示人员类型自定义字段的值； * 当type为"datetime"时，应使用datetime_value字段，表示日期类型自定义字段的值； * 当type为"single_select"时，应使用single_select_value字段，表示单选类型自定义字段的值； * 当type为"multi_select"时，应使用multi_select_value字段，表示多选类型自定义字段的值； * 当type为“text”时，应使用text_value字段，表示文本字段类型的值。
  └ guidstring是自定义字段guid
示例值："73b21903-0041-4796-a11e-f8be919a7063"
  └ number_valuestring否数字类型的自定义字段值，填写一个合法数字的字符串表示，空字符串表示设为空。
示例值："10.23"
数据校验规则：
- 最大长度：20 字符
  └ member_valuemember\[\]否人员类型的自定义字段值。可以设置1个或多个用户的id（遵循member格式，只支持user类型）。当字段设为只不能多选时只能输入一个值。设为空数组表示设为空。
数据校验规则：
- 最大长度：50
    └ idstring否表示member的id
示例值："ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f"
数据校验规则：
- 最大长度：100 字符
    └ typestring否成员类型（默认user，可不填写）
示例值："user"
默认值：user
    └ namestring否成员名称
示例值："张明德（明德）"
  └ datetime_valuestring否日期类型自定义字段值，可以输入一个表示日期的以毫秒为单位的时间戳字符串。设为空字符串表示设为空。
示例值："1698192000000"
  └ single_select_valuestring否单选类型字段值，填写一个字段选项的option_guid。设置为空字符串表示设为空。
示例值："73b21903-0041-4796-a11e-f8be919a7063"
数据校验规则：
- 最大长度：100 字符
  └ multi_select_valuestring\[\]否多选类型字段值，可以填写一个或多个本字段的option_guid。设为空数组表示设为空。
示例值：["73b21903-0041-4796-a11e-f8be919a7063"]
数据校验规则：
- 最大长度：50
  └ text_valuestring否文本类型字段值。可以填写最多3000字符。使用空字符串表示设为空。
示例值："这是一段文本描述。"
docx_sourcedocx_source否如果希望设置任务来源为文档，则设置此字段 - 和extra互斥，同时设置时报错 - 和origin互斥，同时设置时报错 - 和custom_complete互斥，同时设置时报错
  └ tokenstring是任务关联的文档token，要求：如果使用tenant_access_token请求，则请求机器人有文档编辑权限；如果使用user_access_token，则请求用户有文档的编辑权限
示例值："OvZCdFYVHo5ArFxJKHjcnRbtnKd"
数据校验规则：
- 长度范围：27 ～ 27 字符 - 正则校验：[a-zA-Z0-9]{27}
  └ block_idstring是任务关联的文档block_id，要求block_id存在于token对应文档中、且block_id没有绑定过其他的任务
示例值："O6wwd22uIoG8acxwxGtbljaUcfc"
数据校验规则：
- 长度范围：27 ～ 27 字符 - 正则校验：[a-zA-Z0-9]{27}
positive_remindersreminder\[\]否正数协议每日提醒
数据校验规则：
- 长度范围：1 ～ 10
  └ relative_fire_minuteint是相对于截止时间的提醒时间分钟数。例如30表示截止时间前30分钟提醒；0表示截止时提醒。
示例值：30

请求体示例 ​

json
{
    "summary": "针对全年销售进行一次复盘",
    "description": "需要事先阅读复盘总结文档",
    "due": {
        "timestamp": "1675454764000",
        "is_all_day": true
    },
    "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://www.example.com",
            "title": "反馈一个问题，需要协助排查"
        }
    },
    "extra": "dGVzdA==",
    "completed_at": "1675742789470",
    "members": [
        {
            "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
            "type": "user",
            "role": "assignee",
            "name": "张明德（明德）"
        }
    ],
    "repeat_rule": "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR",
    "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": "작업대"
            }
        }
    },
    "tasklists": [
        {
            "tasklist_guid": "cc371766-6584-cf50-a222-c22cd9055004",
            "section_guid": "e6e37dcc-f75a-5936-f589-12fb4b5c80c2"
        }
    ],
    "client_token": "daa2237f-8310-4707-a83b-52c8a81e0fb7",
    "start": {
        "timestamp": "1675454764000",
        "is_all_day": true
    },
    "reminders": [
        {
            "relative_fire_minute": 30
        }
    ],
    "mode": 2,
    "is_milestone": false,
    "custom_fields": [
        {
            "guid": "73b21903-0041-4796-a11e-f8be919a7063",
            "number_value": "10.23",
            "member_value": [
                {
                    "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                    "type": "user",
                    "name": "张明德（明德）"
                }
            ],
            "datetime_value": "1698192000000",
            "single_select_value": "73b21903-0041-4796-a11e-f8be919a7063",
            "multi_select_value": [
                "73b21903-0041-4796-a11e-f8be919a7063"
            ],
            "text_value": "这是一段文本描述。"
        }
    ],
    "docx_source": {
        "token": "OvZCdFYVHo5ArFxJKHjcnRbtnKd",
        "block_id": "O6wwd22uIoG8acxwxGtbljaUcfc"
    },
    "positive_reminders": [
        {
            "relative_fire_minute": 30
        }
    ]
}

响应 ​

响应体 ​

名称类型描述
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成员角色
      └ namestring成员名称
    └ membersmember\[\]任务成员列表
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring成员角色
      └ namestring成员名称
    └ completed_atstring任务完成的时间戳(ms)
    └ attachmentsattachment\[\]任务的附件列表
      └ guidstring附件guid
      └ file_tokenstring附件在云文档系统中的token
      └ namestring附件名
      └ sizeint附件的字节大小
      └ resourceresource附件归属的资源
        └ typestring资源类型
        └ idstring资源ID
      └ uploadermember附件上传者
        └ idstring表示member的id
        └ typestring成员的类型
        └ rolestring角色，可以是负责人（assginee）或者关注人（follower）
        └ namestring成员名称
      └ 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该任务的子任务的个数。
    └ is_milestoneboolean是否是里程碑任务
    └ custom_fieldscustom_field_value\[\]任务的自定义字段值
      └ guidstring字段GUID
      └ typestring自定义字段类型，支持"member", "datetime", "number", "single_select", "multi_select"五种类型
      └ number_valuestring数字类型的自定义字段值，填写一个合法数字的字符串表示，空字符串表示设为空。
      └ datetime_valuestring日期类型自定义字段值。可以输入一个表示日期的以毫秒为单位的字符串。设为空字符串表示设为空。
      └ member_valuemember\[\]人员类型的自定义字段值，可以设置1个或多个用户的id（遵循member格式，只支持user类型）。当该字段的设置为“不能多选”时只能输入一个值。设为空数组表示设为空。
        └ idstring表示member的id
        └ typestring成员的类型
        └ rolestring成员角色
        └ namestring成员名称
      └ single_select_valuestring单选类型字段值，填写一个字段选项的option_guid。设置为空字符串表示设为空。
      └ multi_select_valuestring\[\]多选类型字段值，可以填写一个或多个本字段的option_guid。设为空数组表示设为空。
      └ namestring自定义字段名
      └ text_valuestring文本类型字段值。可以输入一段文本。空字符串表示清空。
    └ dependenciestask_dependency\[\]任务依赖
      └ typestring依赖类型
可选值有：
- prev: 前置依赖 - next: 后置依赖
      └ task_guidstring依赖任务的GUID
    └ assignee_relatedtask_assignee\[\]任务执行者相关信息，如会签任务各执行者完成时间等
      └ idstring任务执行者的id
      └ completed_atstring会签任务中执行者完成的时间戳(ms)
    └ positive_remindersreminder\[\]正数协议任务提醒
      └ idstring提醒时间设置的 ID
      └ relative_fire_minuteint相对于截止时间的提醒时间分钟数。例如30表示截止时间前30分钟提醒；0表示截止时提醒。

响应体示例 ​

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",
                "name": "张明德（明德）"
            },
            "members": [
                {
                    "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                    "type": "user",
                    "role": "follower",
                    "name": "张明德（明德）"
                }
            ],
            "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",
                        "name": "张明德（明德）"
                    },
                    "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://www.example.com",
                    "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,
            "is_milestone": false,
            "custom_fields": [
                {
                    "guid": "a4f648d7-76ef-477f-bc8e-0601b5a60093",
                    "type": "number",
                    "number_value": "10.23",
                    "datetime_value": "1687708260000",
                    "member_value": [
                        {
                            "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                            "type": "user",
                            "role": "editor",
                            "name": "张明德（明德）"
                        }
                    ],
                    "single_select_value": "4216f79b-3fda-4dc6-a0c4-a16022e47152",
                    "multi_select_value": [
                        "4216f79b-3fda-4dc6-a0c4-a16022e47152"
                    ],
                    "name": "优先级",
                    "text_value": "这是一段文本介绍。"
                }
            ],
            "dependencies": [
                {
                    "type": "next",
                    "task_guid": "93b7bd05-35e6-4371-b3c9-6b7cbd7100c0"
                }
            ],
            "assignee_related": [
                {
                    "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                    "completed_at": "1675742789470"
                }
            ],
            "positive_reminders": [
                {
                    "id": "10",
                    "relative_fire_minute": 30
                }
            ]
        }
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
4001470400请求参数有误，如没提供必填项，标题过长，尝试设置提醒却不提供截止时间等。具体错误原因参考返回的错误信息。
4041470404创建任务时设置加入清单/分组，但清单/分组不存在。具体错误原因参考返回的错误信息。
5001470500创建任务失败。服务器内部错误。重试调用后持续出错可以联系支持。 常见问题参考: 1. 检查members列表，是否存在member_id传入有误或与实际参数类型不匹配。 2. 在使用tenant_access_token访问接口时，members列表中不能传入其他租户成员。 3. 检查任务标题或描述内容是否存在非法内容，非法内容无法通过安全内容检查。
4031470403权限错误。创建任务时设置要加入某个清单，但没有清单的可编辑权限。检查调用身份是否对任务要加入的清单有编辑权限。详见清单是如何鉴权的？
5001470422使用同样的client_token进行并发接口调用不要用同样的client_token进行并发的接口调用。

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

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