预览群邀请

扫码后先查看群信息、是否已在群中，以及加入是否需要审批。

POST /app/sdk/groups/invite-preview

调用方： SDK 客户端　·　认证： IM Token

请求头：Authorization: Bearer <IM Token>。先通过宿主后端获取 Token，再交给 SDK 使用。

请求参数

JSON Body

参数	类型	必填	说明
token	string	是	群邀请接口返回的 token，32–2048 字符，原样提交。不要把完整 popoim:// 二维码内容当作 token。

请求示例

curl 'https://example.com/app/sdk/groups/invite-preview' \
  -H "Authorization: Bearer $POPOIM_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"token":"<群邀请接口返回的 token>"}'

使用说明

• 根据 membership_status 和 can_join 决定显示“加入群”“等待审批”或“已加入”，不要只依据扫码成功显示入群成功。

返回参数

成功响应的最外层字段如下。下面所有业务字段都位于 data 中。

字段	类型	说明
code	integer	0 表示成功；非 0 时查看 msg，不把 data 当成功结果使用。
msg	string	成功通常为 ok，失败时为错误说明。
data	object	本次请求的业务结果，字段见下表。

data 字段

字段	类型	说明
invite_group	InviteGroup	供加入前预览的群信息。
membership_status	string	active 已是成员、pending 入群申请待审批、not_member 尚未入群。
join_mode	string	direct 可直接入群；approval 需要群主或管理员审批。
can_join	boolean	当前是否可以提交加入操作；已是成员或已有待审批申请时为 false。

返回示例

示例展示字段结构；ID、时间和资料仅作说明，请使用实际回包。

{
  "code": 0,
  "msg": "ok",
  "data": {
    "invite_group": {
      "conversation_id": "group_6284173029",
      "group_id": "6284173029",
      "name": "秋日海岸出游",
      "avatar": "https://example.com/uploads/avatars/group/6284173029/1792301400.webp",
      "member_count": 2
    },
    "membership_status": "not_member",
    "join_mode": "direct",
    "can_join": true
  }
}

返回对象字段

数组中的每个对象使用同一套字段。点击名称跳到说明：

邀请中可见的群信息

邀请中可见的群信息（InviteGroup）

字段	类型	说明
conversation_id	string	群会话 ID。
group_id	string	公开群 ID。
name	string	群名称。
avatar	string	群头像地址。
member_count	integer	群成员人数。

错误处理

先检查 HTTP 状态，再检查 code。业务失败可能仍为 HTTP 200；非 0 的 code 都不能当成功。完整错误码见请求约定。

返回群与成员接口列表 · HTTP 请求约定