API 参考
圈组

拉人入群

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

功能描述

邀请其他用户加入高级群,可以批量邀请。

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

API 使用限制

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

除发送群消息 API 外,其他所有高级群 API 都属于高级群操作 API。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必填说明
tidLong云信服务器产生,群组唯一标识,创建群时会返回,最大长度 64 位长整型
ownerString邀请人的用户帐号,accid,最大长度 32 位字符,按照群属性 invitemode(0:只有群主和管理员可以邀请他人入群,1:所有人都可以邀请)配置传入
membersString被邀请入群的用户列表,\["aaa","bbb"\](JSONArray 对应的 accid,如果解析出错会报 414),一次最多邀请 200 个成员
magreeInteger邀请用户入群时的验证模式
0,不需要被邀请人同意加入群(默认);1,需要被邀请人同意才可以加入群
只有当 magree =1 且群属性 beinvitemode !=0 时,邀请用户入群时才需要被邀请方同意,其他情况下入群都不需要被邀请方的同意
msgString邀请发送的文字,最大长度 150 位字符
attach String自定义扩展字段,最大长度 512 位字符

返回参数

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

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk***0803mgq3" -H "Nonce: 4tgggerg**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&members=%5B%22lisi%22%2C%22wangwu%22%5D&msg=%E8%AF%B7%E5%8A%A0%E7%BE%A4&magree=0' 'HTTPS://api.netease.im/nimserver/team/add.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200
    "faccid":{   //如果邀请的人中存在加群数量超限的情况,会返回faccid
         "accid":["a","b","c"],
         "msg":"team count exceed"
     }
}

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
"code": 414,  // 参数错误
"desc": "xxxx  is empty" 
}

状态码

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

状态码 说明 处理建议
200 请求成功 -
403 禁止操作 群名等信息违规,未过审查,请检查相关信息
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超出限制 降低访问频率
500 服务出错 -
801 群人数达到上限:
如果「单次邀请进群人数」大于「群最高人数」减去「群内已有人数」时,该次邀请的账号全都无法入群
根据对应提示信息做出处理
802 没有权限 -
806 超出限制:
被邀请的用户拥有的群组数量已达上限
根据对应提示信息做出处理
此文档是否对你有帮助?
有帮助
去反馈
  • 功能描述
  • API 使用限制
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 请求失败返回示例
  • 状态码