创建动态订阅

为一个清单创建一个订阅。每个订阅可以包含1个或多个订阅者（目前只支持普通群组）。订阅创建后，如清单发生相应的事件，则会向订阅里的订阅者发送通知消息。一个清单最多可以创建50个订阅。每个订阅最大支持50个订阅者。订阅者目前仅支持"chat"类型。

每个订阅可以通过设置include_keys可以针对哪些事件(event_key)做通知。如果include_keys为空，则不对任何事件进行通知。

如有需要，创建时也可以直接将disabled设为true，创建一个禁止发送订阅通知的订阅。

Tip: 添加订阅群时，调用身份（用户或应用机器人）必须已是群成员。如果成功添加了订阅后，调用身份丧失了清单的可编辑权限或者退出了群，订阅依然会存在，直到被删除。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/task/v2/tasklists/:tasklist_guid/activity_subscriptions
HTTP Method	POST
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	task:tasklist:write 查看、创建、更新、删除任务清单
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

路径参数

名称	类型	描述
tasklist_guid	string	清单GUID 示例值："d19e3a2a-edc0-4e4e-b7cc-950e162b53ae"

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
name	string	是	订阅名称，不能为空，最大50个字符。 示例值："我的订阅"
subscribers	member\[\]	是	订阅者列表 数据校验规则： - 最大长度：50
└ id	string	否	表示member的id 示例值："oc_2cefb2f014f8d0c6c2d2eb7bafb0e54f" 数据校验规则： - 最大长度：100 字符
└ type	string	否	成员的类型 （目前仅支持chat） 示例值："chat" 默认值：user
include_keys	int\[\]	是	订阅的event key列表。每个event key用一个数字表示。目前支持下列event key： - 100: 任务添加入清单 - 101: 任务从清单被移除 - 103: 任务被完成 - 104: 任务恢复为未完成 - 109: 任务添加了负责人 - 110: 任务更新了负责人 - 111: 任务移除了负责人 - 119: 任务添加了附件 - 121: 任务中添加了新评论 - 122: 任务中对评论进行回复 - 129: 任务设置了新的开始时间 - 130: 任务设置了新的截止时间 - 131: 任务同时设置了新的开始/截止时间 - 132: 任务同时移除了开始/截止时间 该字段可以设置为空数组（即不对任何event进行通知）；输入的include_keys的元素不能重复。 示例值：[100]
disabled	boolean	否	该订阅是否为停用 示例值：false

请求体示例

{
    "name": "我的订阅",
    "subscribers": [
        {
            "id": "oc_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
            "type": "chat"
        }
    ],
    "include_keys": [
        100
    ],
    "disabled": false
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ activity_subscription	tasklist_activity_subscription	清单动态订阅
└ guid	string	订阅guid
└ name	string	订阅名称
└ subscribers	member\[\]	订阅者
└ id	string	表示member的id
└ type	string	成员的类型
└ role	string	成员角色
└ include_keys	int\[\]	要订阅的清单动态类型
└ disabled	boolean	该订阅是否为停用

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "activity_subscription": {
            "guid": "d19e3a2a-edc0-4e4e-b7cc-950e162b53ae",
            "name": "Roadmap订阅",
            "subscribers": [
                {
                    "id": "oc_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                    "type": "user",
                    "role": "editor"
                }
            ],
            "include_keys": [
                101
            ],
            "disabled": false
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1470400	请求参数错误，如设置了不支持的event_key。	错误原因见返回的msg提示的信息。
403	1470403	缺少对清单订阅的编辑权限或者不在群中。	确认调用身份拥有正确的权限。
404	1470404	要添加订阅的清单不存在或已删除。	确定要添加订阅的清单是否存在。
500	1470500	服务器错误。	尝试重试调用。如持续失败，请联系支持人员进行反馈。