查询群

查询群聊相关信息，如群名称、群公告、群类型、群头像等

注意事项：

• 调用此接口需要开启机器人能力
• 机器人或用户需要在群内，否则只会返回一些基础信息（群名称、群头像等）。机器人身份使用tenant_access_token识别，用户身份使用user_access_token识别

请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/im/v2/chats/group/:chat_id
HTTP Method	GET
支持的应用类型	自建应用 商店应用
权限要求	获取与更新群组信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token app_access_token user_access_token 值格式："Bearer access_token" 示例值： "Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	描述
user_id_type	string	用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：open_id 当值为 user_id，字段权限要求： 获取用户 user ID

路径参数（url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值）

名称	类型	描述
chat_id	string	群ID 示例值："1c5f7b01b3d64d821kQbD_bo"

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
traceId	string	链路ID
success	boolean	请求是否成功
data	-	-
∟chat_id	string	群ID
∟avatar	string	群头像 URL
∟name	string	群名称
∟bulletin	string	群公告
∟owner_id	string	群主 ID
∟chat_type	string	是否为公开群

响应体示例

基础信息

{
    "code": 0,
    "success": true,
    "data": {
        "chat_id": "1c5f7b01b3d6d821kQbD_bo",
        "avatar": "https://bosshi-admin-qa.weizhipin.com/api/media/public/v2/TsD7SJk0EruzgL1NNZ7-FSjzYKYYf9As3mkmbuNe78g_4VZTaGwwuGCfPxzBcPZzugyGg~~.png",
        "name": "这是群名称",
        "chat_type": "private"
    },
    "msg": "操作成功",
    "traceId": "AAG4zJSKKnYmB33O"
}

详细信息

{
    "code": 0,
    "success": true,
    "data": {
        "chat_id": "1c5f7b013d64d821kQbD_bo",
        "avatar": "https://bosshi-admin-qa.weizhipin.com/api/media/public/v2/TsD7SJk0EruzgL1NNZ7-FSjzYKYYf9As3mkmbNe78g_4VZTaGww4uGCfPxzBcPZzugyGg~~.png",
        "name": "这是群名称",
        "chat_type": "public",
        "bulletin": "这是群公告",
        "owner_id": "zhangsan@kanzhun.com"
    },
    "msg": "操作成功",
    "traceId": "_Ap-f_WKRWQMpgAB"
}