Skip to content

获取动态订阅

提供一个清单的GUID和一个订阅的GUID,获取该订阅的详细信息,包括名称,订阅者,可通知的event key列表等。

Tip: 获取动态订阅需要该清单的读取权限。

请求

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

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
tasklist_guidstring清单GUID。可以通过创建清单,或者通过获取清单列表接口查询得到。
示例值:"33991879-704f-444f-81d7-55a6aa7be80c"
activity_subscription_guidstring订阅GUID。可以通过创建动态订阅接口创建,或者通过列取动态订阅查询得到。
示例值:"33991879-704f-444f-81d7-55a6aa7be80c"

查询参数

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

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ activity_subscriptiontasklist_activity_subscription订阅详情
    └ guidstring订阅guid
    └ namestring订阅名称
    └ subscribersmember\[\]订阅者
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring成员角色
    └ include_keysint\[\]要订阅的清单动态类型
    └ disabledboolean该订阅是否为停用

响应体示例

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

错误码

HTTP状态码错误码描述排查建议
4001470400请求参数错误,如输入的订阅GUID不合法。根据返回的msg确认错误原因。
4031470403缺少清单的读取权限。确认调用身份对清单有读取权限。
4041470404清单不存在或已删除。确认清单是否存在。
5001470500服务器错误。尝试重试调用。如持续失败,请联系支持人员进行反馈。

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