获取群分享链接

获取指定群的分享链接，他人点击分享链接后可加入群组。

前提条件

应用需要开启机器人能力。

使用限制

• 调用该接口的用户或机器人必须在对应群组内。
• 单聊、密聊、团队群不支持生成分享链接。
• 当机器人被停用或者退出群组时，由该机器人获取的群分享链接也将失效。
• 当群组设置了 仅群主和群管理员可添加群成员或分享群 时，调用该接口的用户或机器人必须是群组的群主或管理员。
• 获取内部群分享链接时，调用该接口的用户或机器人必须和群组属于同一租户。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v1/chats/:chat_id/link
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	im:chat 获取与更新群组信息 im:chat:read 查看群信息 im:chat:readonly 获取群组信息

请求头

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

路径参数

名称	类型	描述
chat_id	string	群 ID。获取方式： - 创建群，从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口，可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 注意：单聊、密聊、团队群不支持分享群链接 示例值："oc_a0553eda9014c201e6969b478895c230"

请求体

名称	类型	必填	描述
validity_period	string	否	群分享链接有效时长 示例值："week" 可选值有： - week: 有效期 7 天 - year: 有效期 1 年 - permanently: 永久有效 默认值：week

请求体示例

{
    "validity_period": "week"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ share_link	string	群分享链接
└ expire_time	string	分享链接的过期时间，秒级时间戳
└ is_permanent	boolean	分享链接是否永久有效

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "share_link": "https://applink.feishu.cn/client/chat/chatter/add_by_link?link_token=3nf8789-4rfx-427d-a6bf-ed1d2df348aabd",
        "expire_time": "1609296809",
        "is_permanent": false
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	232001	Your request contains an invalid request parameter.	参数错误。请参考 API 文档参数描述，排查请求时参数是否填写有误。
400	232006	Your request specifies a chat_id which is invalid.	无效的 chat_id，请检查 chat_id 是否正确。获取方式： - 创建群，从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口，可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。
400	232009	Your request specifies a chat which has already been dissolved.	群组已被解散，无法操作。
400	232010	Operator and chat can NOT be in different tenants.	调用接口的操作者和被操作的群组不在同一租户下，无法操作。需确保当前的操作者和被操作的群组在同一租户下。
400	232011	Operator can NOT be out of the chat.	调用接口的操作者不在群组内，无法操作。你需要将当前调用 API 的应用或用户加入待操作的群组后重试。
400	232019	The request has been rate limited.	触发群限流，请控制请求的速度，详情参见频控策略。
400	232024	Users do not have the visibility of the app, or the operator does not have collaboration permissions with the target users.	机器人对用户没有可见性，或操作者与用户间没有协作权限。 - 如果是机器人对用户没有可见性，需要在开发者后台 > 应用详情页 > 应用发布 > 版本管理与发布 编辑应用对用户的可见性并发布应用。具体操作参考配置应用可用范围。 - 如果是操作者与用户之间没有协作权限，请检查是否与目标用户有协作权限，如屏蔽、未添加为联系人等。
400	232025	Bot ability is not activated.	应用未启用机器人能力。你需要登录开发者后台，在应用详情页的 应用能力 > 添加应用能力 页面内，添加 机器人 能力，并发布应用使配置生效。具体操作参见机器人能力。
400	232033	The operator or invited bots does NOT have the authority to manage external chats without the scope.	当前被操作的群为外部群，暂不支持操作外部群。只有开启对外共享能力的机器人支持外部群，详情参见机器人支持外部群和外部用户单聊。
400	232034	The app is unavailable or inactivate in the tenant.	应用在本租户下未安装或未启用。需要先安装应用，再使用应用调用接口。
400	232061	Secret chat cannot be share link.	密聊不支持分享群链接。
400	232062	P2P chat cannot be share link.	单聊不支持分享群链接。
400	232063	Team cannot be share link.	团队群不支持分享群链接。
400	232064	The operator is not a group owner or administrator, no permission to share chat link.	该群开启了“仅群主和群管理员可添加群成员/分享群”，请检查操作者在群中的身份，非群主和群管理员无法操作。
400	232065	The User/Bot can NOT be found.	机器人或用户不存在，请检查 Authorization 参数传入的 access_token 是否正确。

更多错误码信息，参见通用错误码。