列取动态订阅
给定一个清单的GUID,获取其所有的订阅信息。结果按照订阅的创建时间排序。
Tip: 列取动态订阅需要清单的读取权限。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/task/v2/tasklists/:tasklist_guid/activity_subscriptions |
| HTTP Method | GET |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | task:tasklist:read 查看任务清单 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 |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
tasklist_guid | string | 清单GUID。可以通过创建清单,或者通过获取清单列表接口查询得到。 示例值:"d19e3a2a-edc0-4e4e-b7cc-950e162b53ae" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
limit | int | 否 | 返回结果的最大数量 示例值:50 默认值: 50数据校验规则: - 取值范围: 1 ~ 50 |
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 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | tasklist_activity_subscription\[\] | 清单的动态订阅数据 |
└ guid | string | 订阅guid |
└ name | string | 订阅名称 |
└ subscribers | member\[\] | 订阅者 |
└ id | string | 表示member的id |
└ type | string | 成员的类型 |
└ role | string | 成员角色 |
└ include_keys | int\[\] | 要订阅的清单动态类型 |
└ disabled | boolean | 该订阅是否为停用 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"guid": "d19e3a2a-edc0-4e4e-b7cc-950e162b53ae",
"name": "Roadmap订阅",
"subscribers": [
{
"id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
"type": "user",
"role": "editor"
}
],
"include_keys": [
101
],
"disabled": false
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1470400 | 请求有误,如输入的清单GUID不合法。 | 查看返回的msg以确定原因。 |
| 403 | 1470403 | 缺少清单的读取权限。 | 确认调用身份拥有清单读取权限。 |
| 404 | 1470404 | 清单不存在或已删除。 | 确认清单是否存在。 |
| 500 | 1470500 | 服务器错误。 | 尝试用同样参数重复调用接口。如果错误持续,请联系技术支持人员协助。 |
