在线调试

创建群组

更新时间: 2025/04/09 15:26:38

该接口已废弃,如需创建群组请参考新的 创建群组 API。


该接口用于创建群组,包括高级群和超大群。创建群组时,可通过设置群成员列表邀请用户入群。创建群组成功后,网易云信服务器会返回 `team_id`(群唯一标识),该字段需要保存,以便于加人与踢人等后续操作。
  • 超大群功能需要单独开通后才能使用,具体请参考 开通和配置群组功能
  • 如果创建时邀请的成员中存在加群数量超过限制的情况(每人最多加入 5000 个群组),会返回加群失败成员的账号。
  • 每个用户可创建的群数量有限制(默认最多创建 100 个群组),若需要扩展创建群组的数量,请前往网易云信控制台进行配置。

调用频率

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

请求信息

请求 URL

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

请求头参数

请求 Header 的参数说明请参考 请求 Header

请求体参数

参数名称 类型 是否必选 描述
owner_account_id String 群主(创建者)的 IM 账号 ID。
team_type Integer 群组类型。1:高级群。2:超大群。
name String 群组名称,长度上限 64 位字符。
icon String 群组头像的 URL 地址,例如 "https://netease/xxx.png",长度上限 1024 位字符。
announcement String 群组公告,长度上限 1024 位字符。
intro String 群组简介,长度上限 512 位字符。
members_limit Integer 群组成员数上限(包含群主),默认为 200。可设置范围的为:[2 ~ 200]。若需要扩展群容量,请前往网易云信控制台配置。配置好后,该参数颗设置的范围为:[2 ~ 控制台设置的群人数上限]。
server_extension String 自定义群组扩展字段,第三方可以跟据此属性自定义扩展自己的群属性,建议封装成 JSONObject 格式,{key:value}。长度上限 1024 位字符
invite_account_ids Array of strings 创建群组时邀请入群的成员列表。
  • 单个元素为成员的网易云信账号 ID。
  • 无需添加群主(owner_account_id),群主(创建者)默认入群。
  • 群成员(包括群主)总数不超过 members_limit
  • invite_msg String 邀请入群的附言,长度上限 150 位字符。
    extension String 自定义扩展字段,即自定义的通知字段,JSON 格式,不会持久化。长度上限 512 位字符。对应客户端 SDK 通知消息附件 V2NIMMessageNotificationAttachmentserverExtension 字段。该字段仅针对高级群,对超大群无效。
    - 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:所有人。
  • - antispam_configuration Object 安全通相关配置项。
    enabled Boolean 是否开启安全通,默认为 true,即默认使用安全通功能。如果需要设置单条消息不过安全通,则设置为 false。只有在 网易云信控制台 开通安全通业务的用户,该字段才有效,如未开启安全通业务,该字段无效。
    - business_id_map Array of objects 安全通业务列表。
    type Integer 检测类型。1:文本。2:图片。
    business_id String 安全通业务 ID,可以指定当前群组信息过安全通某个检测策略。
    默认情况下网易云信控制后台会生成默认业务,开通安全通后,客户端不需要配置业务 ID 就能默认走该策略,若需要自定义检测策略,请 提交工单 联系网易云信技术支持工程师进行配置,配置好后传入对应的安全通业务 ID,表示当前群组信息过安全通的指定检测策略。

    请求体示例

    JSON{
        "owner_account_id":"123456",
        "team_type":1,
        "invite_msg": "哈哈哈",
        "name":"test",
        "invite_account_ids":["1234567"],
        "configuration":{
           "join_mode":0
        },
    }
    

    响应信息

    响应头参数

    响应 Header 的参数说明请参考 响应 Header

    响应体参数

    参数名称 类型 说明 是否必返回
    code Integer 状态码,200 表示请求成功。
    msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
    - data Object 返回的 JSON 数据对象,请求失败则返回空对象。
    - failed_list Array of objects 拉入群组失败的网易云信账号信息列表。
    account_id String 错误的网易云信账号 ID。
    error_code Integer 操作失败的错误码。
    error_msg String 操作失败的错误信息。
    - team_info Object 创建成功的群组信息。
    team_id String 群组 ID,网易云信服务器返回。
    owner_account_id String 群主的网易云信账号 ID。
    name String 群组名称。
    icon String 群组头像的 URL 地址。
    announcement String 群组公告
    intro String 群组简介。
    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 Integer 群组禁言状态。
  • 0:取消全员禁言。
  • 1:全员禁言,不包括群主和管理员。
  • 3:全员禁言。
  • 响应体示例

    JSON{
        "code": 200,
        "msg": "success",
        "data": {
            "failed_list": ["a", "b", "c"],
            "team_info": {
                "team_id": "123456",
                "icon": null,
                "announcement": null,
                "server_extension": "",
                "extension": "",
                "intro": null,
                "name": "test",
                "configuration": {
                    "update_team_info_mode": 0,
                    "invite_mode": 1,
                    "join_mode": 0,
                    "agree_mode": 1,
                    "update_extension_mode": 0,
                    "chat_banned_mode": 0
                }
            }
        }
    }
    

    错误码

    错误码 错误码描述 错误信息示例
    200 请求成功 success
    414 参数错误 parameter error
    416 频率超限 rate limit exceeded
    102404 用户不存在 account not exist
    108304 未配置大容量超大群的数量 extended super team limit not configured
    108305 加入群组超过上限 joined team limit exceeded
    108311 超大群服务未开通 super team service disabled
    108434 大容量超大群数量超限 extended super team limit
    108435 创建群组超过上限 created team limit
    108437 群人数超过上限 team invitation limit
    108451 群组信息未过反垃圾审核 team hit antispam
    500 服务端内部错误 internal server error
    503 服务器繁忙 server busy
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 调用频率
    • 请求信息
    • 请求 URL
    • 请求头参数
    • 请求体参数
    • 请求体示例
    • 响应信息
    • 响应头参数
    • 响应体参数
    • 响应体示例
    • 错误码