群组功能(超大群)

创建群

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

创建超大群,可创建的群数量有限制;创建时一次最多操作200人。

参数说明


参数类型必须说明
ownerString 群主用户帐号,最大长度32字符
inviteAccidsString 被拉入群的accid(JSONArray),["aaa","bbb"]
tnameString 群名称,最大长度64字符
introString 群描述,最大长度512字符
announcementString 群公告,最大长度1024字符
serverCustomString 自定义群扩展属性,第三方可以根据此属性自定义扩展自己的群属性,最大长度1024字符
icon String 群头像,最大长度1024字符

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'owner=zhangsan&inviteAccids=["aaa","bbb"]&tname=myteam' 'https://api.netease.im/nimserver/superteam/create.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200, 
  "tid":"10001",
  "faccid":{
         "accid":["aa","bb","cc"],
         "msg":"team count exceed"
     }
}

如果创建时被邀请的人中存在加群数量超限的情况,会返回faccid

主要的返回码

200、403、414、416、431、500、801、806

具体请参考code状态表


解散群

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

解散超大群,需要提供群主账号。

参数说明

参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主用户帐号,最大长度32字符

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan' 'https://api.netease.im/nimserver/superteam/dismiss.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


拉人入群

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

拉人入群,需要提供群主或管理员账号,可以批量拉人;当群成员达到上限时,再邀请人入群会返回失败。

参数说明

参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主或管理员用户帐号,最大长度32字符
inviteAccidsString 被拉入群的accid(JSONArray),["aaa","bbb"],一次最多操作200个

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&inviteAccids=["aaa","bbb"]' 'https://api.netease.im/nimserver/superteam/invite.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "faccid":{
         "accid":["aa","bb","cc"],
         "msg":"team count exceed"
     }
}

如果被邀请的人中存在加群数量超限的情况,会返回faccid

主要的返回码

200、403、414、416、431、500、801

具体请参考code状态表


踢人出群

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

踢人出群,需要提供群主或管理员账号,可以批量踢人。

参数说明

参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主或管理员用户帐号,最大长度32字符
kickAccidsString 被踢出群的accid(JSONArray),["aaa","bbb"],一次最多操作200个

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&kickAccids=["aaa","bbb"]' 'https://api.netease.im/nimserver/superteam/kick.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


修改群信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

修改群信息,需要提供群主或管理员账号。

参数说明


参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主或管理员用户帐号,最大长度32字符
tnameString 群名称,最大长度64字符
introString 群描述,最大长度512字符
announcementString 群公告,最大长度1024字符
serverCustomString 自定义群扩展属性,第三方可以根据此属性自定义扩展自己的群属性,最大长度1024字符
icon String 群头像,最大长度1024字符

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&tname=mygroup' 'https://api.netease.im/nimserver/superteam/updateTinfo.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


获取群信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

获取群信息,可以批量查询,一次最多操作20个。

参数说明

参数类型必须说明
tidsString tid列表,如["3083","3084"]

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tids=["10001","10002"]' "https://api.netease.im/nimserver/superteam/getTinfos.action"

返回说明

http 响应:json

{
    "code": 200,
    "tinfos": [
        {
            "createtime": 1506652312445,
            "icon": null,
            "announcement": "aa",
            "updatetime": 1521082125400,
            "muteType": 0,
            "tname": "aa",
            "serverCustom": "",
            "tid": 10001,
            "clientCustom": "",
            "intro": "aa",
            "creator": "v57"
        },
        {
            "createtime": 1506652312445,
            "icon": null,
            "announcement": "bb",
            "updatetime": 1521082125400,
            "muteType": 0,
            "tname": "bb",
            "serverCustom": "",
            "tid": 10002,
            "clientCustom": "",
            "intro": "bb",
            "creator": "v57"
        }
    ]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


修改群成员信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

修改群成员信息。

参数说明

参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
accidString 要修改的用户对应的accid
silentTypeString 1:关闭消息提醒,0:打开消息提醒,其他值无效
nickString 群成员昵称,最大长度32字节

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=10003&accid=lisi&silentType=1&nick=jack' "https://api.netease.im/nimserver/superteam/updateTlist.action"

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


获取群成员信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

获取群成员信息,按加入群时间分页。

参数说明

参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
timetagString 时间戳,单位毫秒,查询的时间起点。
limitString 本次查询的条数上限(最多100条),小于等于0,或者大于100,会提示参数错误
reverseString 1:按时间正序排列,2:按时间降序排列。其它会提示参数错误。默认是1按时间正序排列

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=10003&timetag=1541234567812&limit=10' "https://api.netease.im/nimserver/superteam/getTlists.action"

返回说明

http 响应:json

{
    "code": 200,
    "tlists": [
        {
            "createtime": 1558938768520,
            "updatetime": 1558938768520,
            "jointime": 1558938768520,
            "nick": "",
            "accid": "v57",
            "tid": 10003,
            "type": 1,
            "mute": 0,
            "custom": ""
        },
        {
            "createtime": 1558938768520,
            "updatetime": 1558938768520,
            "jointime": 1558938768520,
            "nick": "",
            "accid": "v58",
            "tid": 10003,
            "type": 0,
            "mute": 0,
            "custom": ""
        }
    ]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


发送超大群消息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

给超大群发送消息,包括文本,图片,语音,视频和地理位置,具体消息参考下面描述

参数说明


参数类型必须说明
tidString群tid
fromAccidString消息发送者accid,必须是群成员
typeint 0 表示文本消息,
1 表示图片,
2 表示语音,
3 表示视频,
4 表示地理位置信息,
6 表示文件,
100 自定义消息类型(特别注意,对于未对接易盾反垃圾功能的应用,该类型的消息不会提交反垃圾系统检测)
bodyString 最大长度5000字符,JSON格式。
具体请参考: 消息格式示例
antispam String 对于对接了易盾反垃圾功能的应用,本消息是否需要指定经由易盾检测的内容(antispamCustom)。
true或false, 默认false。
只对消息类型为:100 自定义消息类型 的消息生效。
antispamCustom String 在antispam参数为true时生效。
自定义的反垃圾检测内容, JSON格式,长度限制同body字段,不能超过5000字符,要求antispamCustom格式如下:

{"type":1,"data":"custom content"}

字段说明:
1. type: 1:文本,2:图片。
2. data: 文本内容or图片地址。
useYidun int 可选,单条消息是否使用易盾反垃圾,可选值为0。
0:(在开通易盾的情况下)不使用易盾反垃圾而是使用通用反垃圾,包括自定义消息。

若不填此字段,即在默认情况下,若应用开通了易盾反垃圾功能,则使用易盾反垃圾来进行垃圾消息的判断
option String 发消息时特殊指定的行为选项,JSON格式,可用于指定消息的漫游,存云端历史,发送方多端同步,消息抄送等特殊行为;option中字段不填时表示默认值 ,option示例:

{"roam":true,"history":false,"sendersync":true,"route":false}

字段说明:
1. roam: 该消息是否需要漫游,默认true(需要app开通漫游消息功能);
2. history: 该消息是否存云端历史,默认true;
3. sendersync: 该消息是否需要发送方多端同步,默认true;
4. route: 该消息是否需要抄送第三方;默认true (需要app开通消息抄送功能);
5. persistent: 是否需要存离线消息,不设置该参数时默认true。
ext String 开发者扩展字段,长度限制1024字符

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=2576209540&fromAccid=user01&type=0&body={"msg":"hello"}' 'https://api.netease.im/nimserver/superteam/sendMsg.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "data":{
        "msgid":172801407253089179, /服务器消息ID
        "timetag": 1545635366312, //消息发送的时间戳
        "antispam":false //是否命中反垃圾
     }
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


查询超大群云端历史消息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

查询存储在云信服务器中的超大群历史消息,只能查询在保存时间范围内的消息。

参数说明

参数类型必须说明
tid String 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
accidString 查询用户对应的accid
begintimeString 开始时间,ms
endtime String 截止时间,ms
limit int 本次查询的消息条数上限(最多100条),小于等于0,或者大于100,会提示参数错误
reverse int 1按时间正序排列,2按时间降序排列,其它返回参数414错误,默认是按降序排列
type String 查询指定的多个消息类型,类型之间用","分割,不设置该参数则查询全部类型消息。 类型支持,1:图片,2:语音,3:视频,4:地理位置,5:通知,6:文件,10:提示,100:自定义

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&accid=zhangsan&begintime=1443599631111&endtime=1443599639999&limit=50' 'https://api.netease.im/nimserver/superteam/queryHistoryMsg.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200,
  "size":xxx, //总共消息条数
  "msgs":[各种类型的消息参见"历史消息查询返回的消息格式说明", JSONArray]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


主动退群

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

主动退群。

参数说明


参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
accidString 要退群的用户对应的accid

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&accid=lisi' 'https://api.netease.im/nimserver/superteam/leave.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


移交群主

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

移交群主,需要提供群主账号;群主可以选择离开此群,或是留下成为普通成员。

参数说明


参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主用户帐号,最大长度32字符
accidString 新群主的用户对应的accid
leaveString 1:群主移交群主后离开此群,2:群主移交群主后成为普通成员,其它会提示参数错误

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&accid=lisi&leave=1' 'https://api.netease.im/nimserver/superteam/changeOwner.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

主要的返回码

200、403、414、416、431、500、806

具体请参考code状态表


添加管理员

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

添加管理员,需要提供群主账号;可以批量添加。

参数说明

参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主用户帐号,最大长度32字符
managerAccidsString 要添加为管理员的accid(JSONArray),["aaa","bbb"],一次最多操作10个

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&managerAccids=["aaa","bbb"]' 'https://api.netease.im/nimserver/superteam/addManager.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

主要的返回码

200、403、414、416、431、500、815

具体请参考code状态表


解除管理员

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

解除管理员,需要提供群主账号;可以批量解除。

参数说明

参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主用户帐号,最大长度32字符
managerAccidsString 要解除掉管理员的accid(JSONArray),["aaa","bbb"],一次最多操作10个

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&managerAccids=["aaa","bbb"]' 'https://api.netease.im/nimserver/superteam/removeManager.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


禁言群

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

禁言群,需要提供群主账号。

参数说明


参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主用户帐号,最大长度32字符
muteTypeString 0:解除禁言,1:禁言普通成员,3:禁言整个群(包括群主)

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&muteType=1' 'https://api.netease.im/nimserver/superteam/mute.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


禁言群成员

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

禁言群成员,需要提供群主或管理员账号;可以批量禁言。

参数说明

参数类型必须说明
tidString 云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主或管理员用户帐号,最大长度32字符
muteAccidsString 要禁言的accid(JSONArray),["aaa","bbb"],一次最多操作10个
muteString 1:禁言,0:解禁

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&muteAccids=["aaa","bbb"]&mute=1' 'https://api.netease.im/nimserver/superteam/muteTlist.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code":200 
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表