API 参考
圈组

拉人入群

更新时间: 2024/07/17 17:57:35

功能描述

邀请其他用户加入超大群,可以批量邀请。

  • 当群成员达到上限时,再邀请人入群返回失败。
  • 当群成员达到上限时,被邀请人“接受邀请"的操作也将返回失败。
  • 如果邀请的人中存在加群数量超限的情况,会返回 faccid(邀请失败的用户 ID)。

API 使用限制

单个应用中 1 秒内所有的超大群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。

  • 除超大群消息相关 API 外,其他所有超大群 API 都属于超大群操作 API。
  • 超大群消息相关 API 包括:发送超大群消息,发送超大群自定义系统通知,撤回超大群消息,根据用户 ID/消息 ID 查询超大群历史消息。

URL

POST https://api.netease.im/nimserver/superteam/invite.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数类型必填说明
tidLong云信服务器产生,超大群唯一标识,创建时会返回,最大长度 64 位长整型
ownerString邀请人的用户账号,accid,最大长度 32 位字符,按照群属性 invitemode(0,只有群主和管理员可以邀请他人入群(默认);1,所有人都可以邀请)配置传入
inviteAccidsString被邀请入群的用户列表,\["aaa","bbb"\](JSONArray 对应的 accid,如果解析出错会报 414),一次最多邀请 200 个成员
msgString邀请发送的文字,最大长度 150 位字符

返回参数

参数 类型 说明
code Integer 状态码
faccid String 邀请失败的账号 ID 列表,如果创建时邀请的成员中存在加群数量超过限制的情况,会返回邀请失败的 accid 以及附言(msg)

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk49b***0803mgq3" -H "Nonce: 4tggge**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&inviteAccids=%5B%22lisi%22%2C%22wangwu%22%5D' 'https://api.netease.im/nimserver/superteam/invite.action'

请求成功返回示例

json{
    "code":200,
    "faccid":{  // 如果添加的人数超出了群最大人数,则显示此字段
        "accid":["accid1","accid2"], 
        "msg":"team count exceed!"
    }
}

请求失败返回示例

{
    "code": 414,
    "desc": "inviteAccids size exceed!"  // inviteAccids 列表超过限制
}
{
    "code": 801  // 超大群人数超过限制
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码

状态码 说明 处理建议
200 请求成功 -
403 禁止操作:
  • owner 不是创建者或管理员
  • owner 没有邀请人的权限
  • 超大群功能未开通
  • app 权限错误
    根据对应提示信息做出处理
    414 参数错误 根据提示信息,检查传入参数的格式和限制条件
    416 调用频率超出限制 降低访问频率
    500 服务出错 -
    801 超出限制:
    超大群人数超过规定限制
    根据对应提示信息做出处理
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能描述
    • API 使用限制
    • URL
    • 请求参数
    • 返回参数
    • 示例
    • 请求示例(curl)
    • 请求成功返回示例
    • 请求失败返回示例
    • 状态码