API 参考
在线调试

拉人入群

更新时间: 2024/07/17 17:08:56

功能描述

在创建群组成功后,群主和管理员可以邀请他人进入群组,一次最多可以邀请 200 个用户。

  • 当群成员数量达到上限后,再邀请人入群时会返回失败。
  • 当群成员数量达到上限后,被邀请人“接受邀请"的操作也将返回失败。
  • 如果被邀请用户的加群数量达到上限后,再邀请该用户会返回失败,并返回该用户的云信账号 ID。

调用频率

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

请求

URL

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

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

请求体参数

参数名称 类型 是否必选 描述
operator_id String 必选 操作者(邀请人)账号 ID。
请根据群组的 invite_mode 属性传入:
  • 若 invite_mode = 0,即只有群主和管理员可以邀请,那么该字段必须传入群主或管理员的云信账号 ID。
  • 若 invite_mode = 1,即所有成员都可以邀请,那么该字段传入任意群成员的云信账号 ID。
  • team_id Long 必选 群组 ID,创建群组成功时,云信服务器会自动生成并返回。
    team_type Integer 必选 群组类型。1:高级群;2:超大群。
    invite_account_ids Array of strings 必选 邀请入群的成员列表。一次最多可以邀请 200 个用户。
    msg String 必选 邀请入群的附言,长度上限 150 位字符。
    extension String 可选 自定义扩展字段,即自定义的通知字段,JSON 格式,不会持久化。长度上限 512 位字符。该字段仅针对高级群,对超大群无效。

    请求体示例

    json{
        "invite_account_ids": [
            "accid1",
            "accid2"
        ],
        "operator_id":"accid3",
        "msg": "邀请你们进来",
        "team_id":1100,
        "extension":"{}",
        "team_type":1
    }
    

    响应

    Header

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

    响应体参数

    参数名称 类型 描述 是否必返回
    code Integer 状态码,200 表示请求成功。
    msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
    data Object 返回的 JSON 数据对象,请求失败则返回空对象。

    响应体示例

    json{
        "code": 200,
        "msg": "success",
        "data": {
            "success_list": [
                "accoutn_id1",
                "accoutn_id2"
            ],
            "failed_list": [
                {
                    "account_id": "accoutn_id1",
                    "error_code": 102404,
                    "error_msg": "%s not valid"
                }
            ]
        }
    }
    

    错误码

    错误码 错误码描述 错误信息示例
    200 请求成功 success
    414 参数错误 parameter error
    416 频率超限 rate limit exceeded
    102404 用户不存在 account not exist
    108311 超大群服务未开通 super team service disabled
    108404 群组不存在 team not exist
    109404 群成员不存在 team member not exist
    109306 没有群邀请权限 no team invite permission
    500 服务端内部错误 internal server error
    503 服务器繁忙 server busy
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能描述
    • 调用频率
    • 请求
    • URL
    • Header
    • 请求体参数
    • 请求体示例
    • 响应
    • Header
    • 响应体参数
    • 响应体示例
    • 错误码