Skip to content

创建自定义分组

为清单或我负责的任务列表创建一个自定义分组。创建时可以需要提供名称和可选的配置。如果不指定位置,新分组会放到指定resource的自定义分组列表的最后。

当在清单中创建自定义分组时,需要设置resourse_type为"tasklist", resource_id设为清单的GUID。

当为我负责任务列表中创建自定义分组时,需要设置resource_type为"my_tasks",不需要设置resource_id。调用身份只能为自己的我负责的任务列表创建自定义分组。

请求

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

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_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

请求体

名称类型必填描述
namestring自定义分组名。不允许为空,最大100个utf8字符。
示例值:"已经审核过的任务"
resource_typestring自定义分组的资源类型,支持"tasklist"(清单)或者"my_tasks"(我负责的)。
示例值:"tasklist"
默认值tasklist
resource_idstring自定义分组要归属的资源id。当resource_type为"tasklist"时这里需要填写清单的GUID;当resource_type为"my_tasks"时,无需填写。
示例值:"cc371766-6584-cf50-a222-c22cd9055004"
insert_beforestring要将新分组插入到自定义分分组的前面的目标分组的guid。
insert_beforeinsert_after均不设置时表示将新分组放到已有的所有自定义分组之后。
如果同时设置insert_beforeinsert_after,接口会报错。
示例值:"e6e37dcc-f75a-5936-f589-12fb4b5c80c2"
数据校验规则
- 最大长度:100 字符
insert_afterstring要将新分组插入到自定义分分组的后面的目标分组的guid。
insert_beforeinsert_after均不设置时表示将新分组放到已有的所有自定义分组之后。
如果同时设置insert_beforeinsert_after,接口会报错。
示例值:"e6e37dcc-f75a-5936-f589-12fb4b5c80c2"
数据校验规则
- 最大长度:100 字符

请求体示例

json
{
    "name": "已经审核过的任务",
    "resource_type": "tasklist",
    "resource_id": "cc371766-6584-cf50-a222-c22cd9055004",
    "insert_before": "e6e37dcc-f75a-5936-f589-12fb4b5c80c2",
    "insert_after": "e6e37dcc-f75a-5936-f589-12fb4b5c80c2"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ sectionsection创建的自定义分组数据
    └ guidstring自定义分组的guid
    └ namestring自定义分组的名字
    └ resource_typestring资源类型
    └ is_defaultboolean分组是否为默认自定义分组
    └ creatormember自定义分组的创建者
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring成员角色
    └ tasklisttasklist_summary如果该分组归属于清单,展示清单的简要信息
      └ guidstring清单的全局唯一ID
      └ namestring清单名字
    └ created_atstring自定义分组创建时间戳(ms)
    └ updated_atstring自定义分组最近一次更新时间戳(ms)

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "section": {
            "guid": "e6e37dcc-f75a-5936-f589-12fb4b5c80c2",
            "name": "已经评审过的任务",
            "resource_type": "tasklist",
            "is_default": true,
            "creator": {
                "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                "type": "user",
                "role": "creator"
            },
            "tasklist": {
                "guid": "cc371766-6584-cf50-a222-c22cd9055004",
                "name": "活动分工任务列表"
            },
            "created_at": "1675742789470",
            "updated_at": "1675742789470"
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
4001470400请求参数有误,比如同时设置insert_beforeinsert_after具体错误原因参考返回的错误信息。
4041470404要创建自定义分组的归属资源不存在或已删除。确认资源数据是否存在或已删除。
5001470500服务器错误。尝试重试调用。如持续失败,请联系支持人员进行反馈。
4031470403缺少创建自定义分组的权限。确认调用身份是否有创建自定义分组的权限。

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