群组功能（超大群） - IM 即时通讯（含 UI）

开发者中心

IM 即时通讯（含 UI）

服务端 API

群组功能（超大群）

更新时间： 2024/03/14 16:34:39

网易云信 IM 服务端支持群组（超大群）功能。

接口调用限制

1秒内默认最多可调用本页面所列的超大群管理操作接口（如创建超大群接口）100次。如需上调上限，请在官网首页通过微信、在线消息或电话等方式咨询商务人员。

创建超大群

功能描述

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

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

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

参数	类型	必须	说明
owner	String	是	群主用户帐号，最大长度32字符
inviteAccids	String	是	邀请的群成员列表。\["aaa","bbb"\](JSONArray对应的accid，如果解析出错会报414)，inviteAccids与owner总和上限为200。inviteAccids中无需再加owner自己的账号。
tname	String	是	群名称，最大长度64字符
intro	String	否	群描述，最大长度512字符
announcement	String	否	群公告，最大长度1024字符
serverCustom	String	否	自定义群扩展属性，第三方可以根据此属性自定义扩展自己的群属性，最大长度1024字符
icon	String	否	群头像，最大长度1024字符
msg	String	是	邀请发送的文字，最大长度150字符
joinmode	String	是	申请入群模式，0-入群不需要申请，1-入群需要申请，2-不允许申请入群。其它返回414
beinvitemode	String	否	邀请同意模式，0-邀请需要同意(默认)，1-邀请不需要同意。其它返回414
invitemode	String	否	谁可以邀请他人入群，0-管理员(默认),1-所有人。其它返回414
uptinfomode	String	否	谁可以修改群资料，0-管理员(默认),1-所有人。其它返回414
upcustommode	String	否	谁可以更新群自定义属性，0-管理员(默认),1-所有人。其它返回414
tlevel	String	否	群人数级别，默认200
code	int	-	状态码
tid	String	-	云信服务器产生，群唯一标识，创建群时会返回，最大长度128字符
accid	String	否	由于加群数量超限导致无法正常加入房间的用户列表
bid	String	否	反垃圾业务ID，JSON字符串，{"textbid":"","picbid":""}，若不填则使用原来的反垃圾配置

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9***3mgq3" -H "Nonce: 4tg***23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***3f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'owner=zhangsan&inviteAccids=["aaa","bbb"]&tname=myteam&msg=welcome&joinmode=0' 'https://api.netease.im/nimserver/superteam/create.action'

返回示例

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

解散超大群

功能描述

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

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

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

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***03mgq3" -H "Nonce: 4tg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b***583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan' 'https://api.netease.im/nimserver/superteam/dismiss.action'

返回示例

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

拉人入群

功能描述

拉人入群，可以批量拉人；当群成员达到上限时，再邀请人入群会返回失败。

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

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 的设置如下：

参数	类型	必须	说明
tid	String	是	云信服务器产生，群唯一标识，创建群时会返回，最大长度128字符
owner	String	是	邀请人的用户帐号，最大长度32字符
inviteAccids	String	是	被拉入群的accid(JSONArray)，\["aaa","bbb"\]，一次最多操作200个
msg	String	是	邀请发送的文字，最大长度150字符

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9dnk***0803mgq3" -H "Nonce: 4tg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b***c55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&inviteAccids=["aaa","bbb"]&msg=welcome' 'https://api.netease.im/nimserver/superteam/invite.action'

返回示例

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

踢人出群

功能描述

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

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

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

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***mgq3" -H "Nonce: 4tgg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9d***5583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&kickAccids=["aaa","bbb"]' 'https://api.netease.im/nimserver/superteam/kick.action'

返回示例

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

修改超大群信息

功能描述

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

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

参数	类型	必须	说明
tid	String	是	云信服务器产生，群唯一标识，创建群时会返回，最大长度128字符
owner	String	是	群主或管理员用户帐号，最大长度32字符
tname	String	否	群名称，最大长度64字符
intro	String	否	群描述，最大长度512字符
announcement	String	否	群公告，最大长度1024字符
serverCustom	String	否	自定义群扩展属性，第三方可以根据此属性自定义扩展自己的群属性，最大长度1024字符
icon	String	否	群头像，最大长度1024字符
joinmode	String	否	申请入群模式，0-入群不需要申请，1-入群需要申请，2-不允许申请入群。其它返回414
invitemode	String	否	谁可以邀请他人入群，0-管理员(默认),1-所有人。其它返回414
uptinfomode	String	否	谁可以修改群资料，0-管理员(默认),1-所有人。其它返回414
upcustommode	String	否	谁可以更新群自定义属性，0-管理员(默认),1-所有人。其它返回414
beinvitemode	String	否	邀请同意模式，0-邀请需要同意(默认)，1-邀请不需要同意。其它返回414
bid	String	否	反垃圾业务ID，JSON字符串，{"textbid":"","picbid":""}，若不填则使用原来的反垃圾配置

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***mgq3" -H "Nonce: 4tgg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6***5583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&tname=mygroup' 'https://api.netease.im/nimserver/superteam/updateTinfo.action'

返回示例

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

获取超大群信息

功能描述

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

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

参数	类型	必须	说明
tids	String	是	tid列表，如["3083","3084"]

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9***03mgq3" -H "Nonce: 4t***23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3***583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tids=["10001","10002"]' "https://api.netease.im/nimserver/superteam/getTinfos.action"

返回示例

json{
    "code": 200,
    "tinfos": [
        {
            "clientCustom": null,
            "creator": "x001",
            "createtime": 1572927187464,
            "tlevel": 5000,
            "icon": null,
            "tname": "tname",
            "serverCustom": "serverCustom",
            "tid": 18035,
            "muteType": 0,
            "joinmode": 0,
            "intro": "intro",
            "updatetime": 1572927383188,
            "size": 100,
            "announcement": "announcement",
            "invitemode": 0,
            "uptinfomode": 0,
            "upcustommode": 0,            
            "beinvitemode": 0
        },
        {
            "clientCustom": null,
            "creator": "x002",
            "createtime": 1561684819840,
            "tlevel": 5000,
            "icon": null,
            "tname": "tnametest",
            "serverCustom": "serverCustomtest",
            "tid": 13003,
            "muteType": 0,
            "joinmode": 0,
            "intro": "introtest",
            "updatetime": 1562129915756,
            "announcement": "announcementtest",
            "invitemode": 0,
            "uptinfomode": 0,
            "upcustommode": 0,            
            "beinvitemode": 0
        }
    ]
}

修改超大群成员信息

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

参数	类型	必须	说明
tid	String	是	云信服务器产生，群唯一标识，创建群时会返回，最大长度128字符
accid	String	是	要修改的用户对应的accid
silentType	String	否	1:关闭消息提醒，0:打开消息提醒，其他值无效
nick	String	否	群成员昵称，最大长度32字符
custom	String	否	自定义扩展字段，最大长度32字符

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***03mgq3" -H "Nonce: 4tggg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***83f86" -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"

返回示例

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

获取超大群成员信息

功能描述

获取超大群成员信息，按加入群时间分页。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

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

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9dnk***0803mgq3" -H "Nonce: 4tg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=10003&timetag=1541234567812&limit=10' "https://api.netease.im/nimserver/superteam/getTlists.action"

返回示例

json{
    "code": 200,
    "tlists": [
        {
            "nick": "",
            "createtime": 1572927187464,
            "jointime": 1572927187464,
            "custom": null,
            "accid": "x002",
            "mute": 0,
            "type": 0,
            "updatetime": 1572927187464,
            "invitor": "x001",
            "tid": 18035
        },
        {
            "nick": "",
            "createtime": 1572927187464,
            "jointime": 1572927187464,
            "custom": null,
            "accid": "x001",
            "mute": 0,
            "type": 1,
            "updatetime": 1572927187464,
            "invitor": "x001",
            "tid": 18035
        }
    ]
}

发送普通消息

功能描述

给超大群发送普通消息，包括文本，图片，语音，视频和地理位置。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

参数	类型	必须	说明
tid	String	是	群tid
fromAccid	String	是	消息发送者accid，必须是群成员
type	String	是	0 表示文本消息, 1 表示图片， 2 表示语音， 3 表示视频， 4 表示地理位置信息， 6 表示文件， 100 自定义消息类型（特别注意，对于未对接易盾反垃圾功能的应用，该类型的消息不会提交反垃圾系统检测）
body	String	是	最大长度5000字符，JSON格式。具体请参考：消息格式示例
msgDesc	String	否	消息描述文本，针对非Text、Tip类型的消息有效，最大长度500字符。该描述信息可用于云端历史消息关键词检索。
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	String	否	可选，单条消息是否使用易盾反垃圾，可选值为0。 0：（在开通易盾的情况下）不使用易盾反垃圾，包括自定义消息。若不填此字段，即在默认情况下，若应用开通了易盾反垃圾功能，则使用易盾反垃圾来进行垃圾消息的判断。
yidunAntiCheating	String	否	可选，透传给易盾的反作弊检测参数，格式为json，长度限制1024字符（具体请参见易盾反垃圾防刷版专属字段）反作弊相关的email、phone、token、extension，抄送到yidunAntiCheating。其他用户增值信息，抄送到yidunAntiSpamExt。
yidunAntiSpamExt	String	否	可选，透传给易盾的反垃圾增强版的检测参数，格式为json，长度限制1024字符反作弊相关的email、phone、token、extension，抄送到yidunAntiCheating。其他用户增值信息，抄送到yidunAntiSpamExt。
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； 6. push: 该消息是否需要推送，默认true； 7. badge: 该消息是否需要计入到未读计数中，默认true； 8. needPushNick: 推送文案是否需要带上昵称，默认true；
ext	String	否	开发者扩展字段，长度限制1024字符
pushContent	String	否	推送内容，不超过500字符
pushPayload	String	否	推送对应的payload，必须是JSON，不能超过2k字符
isForcePush	String	否	发送消息时，是否强制推送
forcePushContent	String	否	发送消息时，强制推送的内容
forcePushAll	String	否	发送消息时，强推（@操作）列表是否为群里除发送者外的所有有效成员
forcePushList	String	否	发送消息时，强推（@操作）列表，格式为JSONArray，如"accid1","accid2"
env	String	否	所属环境，根据env可以配置不同的抄送地址
isCheckMute	String	否	发送群消息时，是否检查与群相关禁言。默认 true-检查；也可置为 false-不检查。如不检查，群内被禁言的用户可以发送消息。

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***03mgq3" -H "Nonce: 4tg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***f86" -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'

返回示例

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

查询云端历史消息

功能描述

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

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

参数	类型	必须	说明
tid	String	是	云信服务器产生，群唯一标识，创建群时会返回，最大长度128字符
accid	String	是	查询用户对应的accid
begintime	String	是	开始时间，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）

curlcurl -X POST -H "AppKey: go9dn***803mgq3" -H "Nonce: 4tg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9***583f86" -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'

返回示例

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

主动退群

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

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

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9dn***3mgq3" -H "Nonce: 4tg***23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9d***3f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&accid=lisi' 'https://api.netease.im/nimserver/superteam/leave.action'

返回示例

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

转让超大群群主

功能描述

转让超大群群主，需要提供群主账号；群主可以选择离开此群，或是留下成为普通成员。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

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

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9***3" -H "Nonce: 4tgg***3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3***83f86" -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'

返回示例

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

添加超大群管理员

功能描述

添加超大群管理员，需要提供群主账号；可以批量添加。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

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

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***3mgq3" -H "Nonce: 4tgg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***83f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&managerAccids=["aaa","bbb"]' 'https://api.netease.im/nimserver/superteam/addManager.action'

返回示例

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

移除超大群管理员

功能描述

移除超大群管理员，需要提供群主账号；可以批量解除。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

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

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***3mgq3" -H "Nonce: 4t***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9***3f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&managerAccids=["aaa","bbb"]' 'https://api.netease.im/nimserver/superteam/removeManager.action'

返回示例

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

禁言超大群

功能描述

禁言超大群，需要提供群主账号。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

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

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9***mgq3" -H "Nonce: 4tgg***23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&muteType=1' 'https://api.netease.im/nimserver/superteam/mute.action'

返回示例

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

禁言群大群成员

功能描述

禁言超大群成员，需要提供群主或管理员账号；可以批量禁言。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

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

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***3mgq3" -H "Nonce: 4tgg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9***3f86" -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'

返回示例

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

发送自定义系统通知

功能描述

给超大群发送自定义系统通知，自定义系统通知区别于普通消息，方便开发者进行业务逻辑的通知。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

参数	类型	必须	说明
from	String	是	发送者accid, 用户帐号，最大长度32字符
to	String	是	群tid
attach	String	是	通知具体内容，第三方组装的字符串，是JSON串，最大长度4096字符
pushContent	String	否	推送内容，不超过500字符
pushPayload	String	否	推送对应的payload，必须是JSON，不能超过2k字符
sound	String	否	可以指定为客户端本地的声音文件，长度不要超过30个字符
option	String	否	发消息时特殊指定的行为选项，Json格式，可用于指定消息计数等特殊行为；option中字段不填时表示默认值。 option示例： {"badge":false,"needPushNick":false,"route":false} 字段说明： 1. badge:该消息是否需要计入到未读计数中，默认true； 2. needPushNick: 推送文案是否需要带上昵称，不设置该参数时默认false(注意与sendMsg.action接口有别)； 3. route: 该消息是否需要抄送第三方；默认true (需要app开通消息抄送功能)；
isForcePush	String	否	发自定义通知时，是否强制推送
forcePushContent	String	否	发自定义通知时，强制推送文案，最长500个字符
forcePushAll	String	否	发自定义通知时，强推列表是否为群里除发送者外的所有有效成员
forcePushList	String	否	发自定义通知时，强推列表，格式为JSONArray，如"accid1","accid2"

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***3mgq3" -H "Nonce: 4t***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9***f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'from=zhangsan&to=123&attach=%7B%22myattach%22%3A%22test%22+%7D' 'https://api.netease.im/nimserver/superteam/sendAttachMsg.action'

返回示例

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

撤回消息

功能描述

消息撤回，可以在一定时间内撤回超大群消息。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

参数	类型	必须	说明
deleteMsgid	String	是	要撤回消息的msgid
timetag	String	是	要撤回消息的创建时间(创建时间为云信服务器生成的消息发送时间戳)
from	String	是	发送者accid, 用户帐号，最大长度32字符
to	String	是	群tid
msg	String	否	可以带上对应的描述
ignoreTime	String	否	1表示忽略撤回时间检测，0表示不忽略，其它为非法参数，默认0，如果需要撤回时间检测，不填即可
pushContent	String	否	推送内容，不超过500字符
pushPayload	String	否	推送对应的payload，必须是JSON，不能超过2k字符

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9***mgq3" -H "Nonce: 4tg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3***583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'deleteMsgid=10386192&timetag=1481528155741&from=123&to=t4&msg=这是一条撤回消息' 'https://api.netease.im/nimserver/superteam/recallMsg.action'

返回示例

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

变更超大群人数级别

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

参数	类型	必须	说明
tid	String	是	云信服务器产生，群唯一标识，创建群时会返回，最大长度128字符
owner	String	是	群主用户帐号，最大长度32字符
tlevel	String	是	群人数级别，[2,200(默认)]

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***gq3" -H "Nonce: 4tg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***3f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&tlevel=200' 'https://api.netease.im/nimserver/superteam/changeLevel.action'

返回示例

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

获取某用户所加入的群信息

功能描述

获取某个用户所加入超大群的群信息。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

参数	类型	必须	说明
accid	String	是	用户帐号，最大长度32字符

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9***q3" -H "Nonce: 4tg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9***3f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan' 'https://api.netease.im/nimserver/superteam/joinTeams.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{   
    "code":200 ,
    "count":2,
    "tinfos": [
        {
            "clientCustom": null,
            "creator": "x001",
            "createtime": 1572927187464,
            "tlevel": 5000,
            "icon": null,
            "tname": "tname",
            "serverCustom": "serverCustom",
            "tid": 18035,
            "muteType": 0,
            "joinmode": 0,
            "intro": "intro",
            "updatetime": 1572927383188,
            "announcement": "announcement",
            "invitemode": 0,
            "uptinfomode": 0,
            "upcustommode": 0,            
            "beinvitemode": 0
        },
        {
            "clientCustom": null,
            "creator": "x002",
            "createtime": 1561684819840,
            "tlevel": 5000,
            "icon": null,
            "tname": "tnametest",
            "serverCustom": "serverCustomtest",
            "tid": 13003,
            "muteType": 0,
            "joinmode": 0,
            "intro": "introtest",
            "updatetime": 1562129915756,
            "announcement": "announcementtest",
            "invitemode": 0,
            "uptinfomode": 0,
            "upcustommode": 0,            
            "beinvitemode": 0
        }
    ]
}

获取禁言群成员信息

功能描述

获取超大群的禁言成员信息，按加入群时间分页。

URL

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

请求参数

POST 请求中 Headers 的设置请参考接口概述。
POST 请求中 Body 的设置如下：

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

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go***gq3" -H "Nonce: 4tg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9***583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=10003&timetag=1541234567812&limit=10' "https://api.netease.im/nimserver/superteam/getMuteTlists.action"

返回示例

json{
    "code": 200,
    "muteTlists": [
        {
            "nick": "",
            "createtime": 1572927187464,
            "jointime": 1572927187464,
            "custom": null,
            "accid": "x002",
            "mute": 0,
            "type": 0,
            "updatetime": 1572927187464,
            "invitor": "x001",
            "tid": 18035
        },
        {
            "nick": "",
            "createtime": 1572927187464,
            "jointime": 1572927187464,
            "custom": null,
            "accid": "x001",
            "mute": 0,
            "type": 1,
            "updatetime": 1572927187464,
            "invitor": "x001",
            "tid": 18035
        }
    ]
}

状态码

上述接口在 HTTPS Body 中返回请求的状态码，状态码详情请参见状态码。

在线咨询

微信咨询

电话咨询

此文档是否对你有帮助？

有帮助

去反馈

接口调用限制
创建超大群
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
解散超大群
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
拉人入群
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
踢人出群
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
修改超大群信息
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
获取超大群信息
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
修改超大群成员信息
URL
请求参数
示例
请求示例（curl）
返回示例
获取超大群成员信息
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
发送普通消息
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
查询云端历史消息
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
主动退群
URL
请求参数
示例
请求示例（curl）
返回示例
转让超大群群主
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
添加超大群管理员
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
移除超大群管理员
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
禁言超大群
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
禁言群大群成员
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
发送自定义系统通知
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
撤回消息
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
变更超大群人数级别
URL
请求参数
示例
请求示例（curl）
返回示例
获取某用户所加入的群信息
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
获取禁言群成员信息
功能描述
URL
请求参数
示例
请求示例（curl）
返回示例
状态码