该接口用于批量查询指定群组的详细信息列表。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求

URL

GET https://open.yunxinapi.com/im/v2/teams

Header

请求 Header 的参数说明请参见请求 Header。

查询参数

参数名称	类型	是否必选	描述
team_ids	Array of strings	必选	需要查询的群组 ID 列表。高级群一次最多查询 30 个群组，超大群一次最多查询 20 个群组。
team_type	Integer	必选	群组类型。1：高级群；2：超大群。

响应

Header

响应 Header 的参数说明请参见响应 Header。

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
invalid_tids	Array of longs	查询失败的群 ID 列表。	否
- team_info_list	Array of objects	查询成功的群组信息列表。	是
team_id	Long	群组 ID，云信服务器返回。	是
team_type	Integer	群组类型。1：高级群；2：超大群。	是
name	String	群组名称。	是
icon	String	群组头像的 URL 地址。	否
announcement	String	群组公告	否
intro	String	群组简介。	否
members_limit	Integer	群组成员数上限（包含群主）。	否
server_extension	String	自定义群扩展字段，第三方可以跟据此属性自定义扩展自己的群属性，建议封装成 JSON 格式，{key:value}。	否
extension	String	自定义扩展字段。	否
create_time	Long	群组创建时间戳。	是
update_time	Long	群组更新时间戳。	是
- configuration	Object	群组配置项。	是
join_mode	Integer	群组创建完成后，通过 SDK 侧操作申请入群的验证方式。 0：无需验证，直接入群。 1：需要群主或管理员验证通过才能入群。 2：不允许任何人申请入群。	是
agree_mode	Integer	群组创建完成后，邀请入群时是否需要被邀请人的同意。 0：需要被邀请人同意才能入群。 1：不需要被邀请人同意，直接入群。	否
invite_mode	Integer	邀请权限，即谁可以邀请他人入群。 0：群主和管理员。 1：所有人。	否
update_team_info_mode	Integer	客户端修改群组信息的权限，即谁可以修改群组信息。 0：群主和管理员。 1：所有人。	否
update_extension_mode	Integer	客户端修改群自定义扩展信息（server_extension&extension）权限，即谁可以修改群自定义扩展信息。 0：群主和管理员。 1：所有人。	否
chat_banned_mode	String	群组禁言状态。 0：取消全员禁言。 1：全员禁言（不包括群主和管理员）。 3：全员禁言。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "icon": null,
        "announcement": null,
        "members_limit": 1000,
        "intro": null,
        "name": "test",
        "team_id": 17889,
        "configuration": {
            "update_team_info_mode": 0,
            "invite_mode": 1,
            "join_mode": 0,
            "invite_mode": 1,
            "update_extension_mode": 0,
            "chat_banned_status": 0
        },
        "create_time": 1506652312445,
        "update_time": 1521082125400
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频控超出限制	rate limit exceeded
108311	超大群服务未开通	super team service disabled
500	服务端内部错误	internal server error
503	服务器繁忙	server busy