API 参考
圈组

群组功能(高级群)(已不再维护)

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

本文已不再维护,请前往创建群组及其同级目录查看高级群相关 API 说明。

网易云信 IM 服务端支持群组(高级群)功能。

接口限制

  • 1 秒内默认最多可调用本页面所列的群组管理操作接口(如创建群组接口)100次。
  • 所有群操作一个 IP 一分钟操作次数超过 6000 次,会返回416错误码。
  • 如需上调上限,请在官网首页通过微信、在线消息或电话等方式咨询商务人员。

创建群

功能描述

创建高级群,以邀请的方式发送给用户。

  • custom 字段是给第三方的扩展字段,第三方可以基于此字段扩展高级群的功能,构建自己需要的群。
  • 建群成功会返回tid,需要保存,以便于加人与踢人等后续操作。
  • 每个用户可创建的群数量有限制,限制值由 IM 套餐的群组配置决定,可登录管理后台查看。
  • 如果创建时邀请的成员中存在加群数量超过限制的情况,会返回faccid。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tnameString 群名称,最大长度64字符
ownerString 群主用户帐号,最大长度32字符
membersString 邀请的群成员列表。\["aaa","bbb"\](JSONArray对应的accid,如果解析出错会报414),members与owner总和上限为200。members中无需再加owner自己的账号。
announcementString 群公告,最大长度1024字符
introString 群描述,最大长度512字符
msgString 邀请发送的文字,最大长度150字符
magreeint 管理后台建群时,0不需要被邀请人同意加入群,1需要被邀请人同意才可以加入群。其它会返回414
joinmodeint 群建好后,sdk操作时,0不用验证,1需要验证,2不允许任何人加入。其它返回414
customString 自定义高级群扩展属性,第三方可以跟据此属性自定义扩展自己的群属性。(建议为json),最大长度1024字符
icon String 群头像,最大长度1024字符
beinvitemode int 被邀请人同意方式,0-需要同意(默认),1-不需要同意。其它返回414
invitemode int 谁可以邀请他人入群,0-管理员(默认),1-所有人。其它返回414
uptinfomode int 谁可以修改群资料,0-管理员(默认),1-所有人。其它返回414
upcustommode int 谁可以更新群自定义属性,0-管理员(默认),1-所有人。其它返回414
teamMemberLimit int 该群最大人数(包含群主),范围:2至应用定义的最大群人数(默认:200)。其它返回414
attach String自定义扩展字段,最大长度512
bid String 反垃圾业务ID,JSON字符串,{"textbid":"","picbid":""},若不填则使用原来的反垃圾配置

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dn***mgq3" -H "Nonce: 4tg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9d***83f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tname=myteam&owner=zhangsan&members=["aaa","bbb"]&msg=welcome&magree=0&joinmode=0' 'https://api.netease.im/nimserver/team/create.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200, 
  "tid":"11001",
  "faccid":{
         "accid":["a","b","c"],
         "msg":"team count exceed"
     }
}

拉人入群

功能描述

邀请其他用户加入群组。

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

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 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 邀请人的用户帐号,最大长度32字符,按照群属性invitemode传入
membersString \["aaa","bbb"\](JSONArray对应的accid,如果解析出错会报414),一次最多拉200个成员
magreeint 管理后台建群时,0不需要被邀请人同意加入群,1需要被邀请人同意才可以加入群。其它会返回414
msgString 邀请发送的文字,最大长度150字符
attach String 自定义扩展字段,最大长度512

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9***gq3" -H "Nonce: 4t***23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9d***86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&members=["aaa","bbb"]&msg=welcome&magree=0' 'https://api.netease.im/nimserver/team/add.action'

返回示例

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

踢人出群

功能描述

高级群踢人出群,需要提供群主accid和被踢除人的accid。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 管理员的accid,用户帐号,最大长度32字符
memberString被移除人的accid,用户账号,最大长度32字符;注:member或members任意提供一个,优先使用member参数
membersString["aaa","bbb"](JSONArray对应的accid,如果解析出错,会报414)一次最多操作200个accid; 注:member或members任意提供一个,优先使用member参数
attach String 自定义扩展字段,最大长度512

示例

请求示例(curl)

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

返回示例

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

解散群

功能描述

删除整个群,会解散该群,需要提供群主accid。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主用户帐号,最大长度32字符
attach String自定义扩展字段,最大长度512

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9***mgq3" -H "Nonce: 4tg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b***83f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan' 'https://api.netease.im/nimserver/team/remove.action'

返回示例

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

修改群组信息

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回
tnameString 群名称,最大长度64字符
ownerString 群主用户帐号,最大长度32字符
announcementString 群公告,最大长度1024字符
introString 群描述,最大长度512字符
joinmodeint 群建好后,sdk操作时,0不用验证,1需要验证,2不允许任何人加入。其它返回414
customString 自定义高级群扩展属性,第三方可以跟据此属性自定义扩展自己的群属性。(建议为json),最大长度1024字符
icon String 群头像,最大长度1024字符
beinvitemode int 被邀请人同意方式,0-需要同意(默认),1-不需要同意。其它返回414
invitemode int 谁可以邀请他人入群,0-管理员(默认),1-所有人。其它返回414
uptinfomode int 谁可以修改群资料,0-管理员(默认),1-所有人。其它返回414
upcustommode int 谁可以更新群自定义属性,0-管理员(默认),1-所有人。其它返回414
teamMemberLimit int 该群最大人数(包含群主),范围:2至应用定义的最大群人数(默认:200)。其它返回414
attach String自定义扩展字段,最大长度512
bid String 反垃圾业务ID,JSON字符串,{"textbid":"","picbid":""},若不填则使用原来的反垃圾配置

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9***3mgq3" -H "Nonce: 4t***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3***c55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&tname=mygroup&owner=zhangsan' 'https://api.netease.im/nimserver/team/update.action'

返回示例

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

群信息与成员列表查询

功能描述

查询高级群的群组信息和群成员列表。

  • 一次最多查询30个群相关的信息,跟据ope参数来控制是否带上群成员列表。
  • 查询群成员会使查询时间增加,所以如果不需要群成员列表可以只查群信息。
  • 此接口受频率控制,某个应用一分钟最多查询30次,超过会返回416,并且被屏蔽一段时间。
  • 群成员的群列表信息中增加管理员成员admins的返回。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidsString群id列表,如["3083","3084"]
opeint1表示带上群成员列表,0表示不带群成员列表,只返回群信息
ignoreInvalidBoolean是否忽略无效的tid,默认为false。设置为true时将忽略无效tid,并在响应结果中返回无效的tid
sizeNumber群内当前人数

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9***3mgq3" -H "Nonce: 4tg***23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9d***83f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tids=["3083","3084","3085"]&ope=1&ignoreInvalid=true' "https://api.netease.im/nimserver/team/query.action"

返回示例

json//查询不带群成员的群列表信息
{
    "code": 200,
    "tinfos": [
        {
            "tname": "aa",
            "announcement": "aa",
            "owner": "v4",
            "maxusers": 50,
            "joinmode": 1,
            "tid": 3083,
            "intro": "test",
            "size": 4,
            "custom": "",
            "clientCustom": "",
            "mute": true,
            "createtime": 1506652312445,
            "updatetime": 1521082125400
        },
        {
            "tname": "bb",
            "announcement": "bb",
            "owner": "v4",
            "maxusers": 50,
            "joinmode": 1,
            "tid": 3084,
            "intro": "test",
            "size": 3,
            "custom": "",
            "clientCustom": "",
            "mute": false,
            "createtime": 1506652312445,
            "updatetime": 1521082125400
        }
    ],
    "invalidTids":[3085] //参数ignoreInvalid=true时才有该字段
}
//查询带群成员的群列表信息
//members字段中的元素包含管理员,但不包含创建者
{
    "code": 200,
    "tinfos": [
        {
            "tname": "aa",
            "announcement": "aa",
            "owner": "v4",
            "maxusers": 50,
            "joinmode": 1,
            "tid": 3083,
            "intro": "test",
            "size": 3,
            "custom": "",
            "clientCustom": "",
            "mute": true,
            "createtime": 1506652312445,
            "updatetime": 1521082125400,
            "admins": [
                "v3"
            ],
            "members": [
                "v1",
                "v2",
                "v3"
            ]
        },
        {
            "tname": "bb",
            "announcement": "bb",
            "owner": "v4",
            "maxusers": 50,
            "joinmode": 1,
            "tid": 3084,
            "intro": "test",
            "size": 3,
            "custom": "",
            "clientCustom": "",
            "mute": false,
            "createtime": 1506652312445,
            "updatetime": 1521082125400,
            "admins": [
                "v3"
            ],
            "members": [
                "v1",
                "v2",
                "v3"
            ]
        }
    ],
    "invalidTids":[3085] //参数ignoreInvalid=true时才有该字段
}

获取群组详细信息

功能描述

查询指定群的详细信息(群信息+成员详细信息)。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidlong 群id,群唯一标识,创建群时会返回

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9**gq3" -H "Nonce: 4tgg**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db**55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=3088' "https://api.netease.im/nimserver/team/queryDetail.action"

返回示例

json{
    "code": 200,
    "tinfo": {
        "icon": null,
        "announcement": null,
        "uptinfomode": 0,
        "maxusers": 1000,
        "intro": null,
        "upcustommode": 0,
        "tname": "test",
        "beinvitemode": 1,
        "joinmode": 0,
        "tid": 17889,
        "invitemode": 1,
        "mute": false,
        "custom":"",
        "clientCustom":"",
        "createtime": 1506652312445,
        "updatetime": 1521082125400,
        "owner": {
            "createtime": 1506652312445,
            "updatetime": 1506655709409,
            "nick": "nick1",
            "accid": "user1",
            "mute": false,
            "custom": null
        },
        "admins": [
            {
                "createtime": 1506652312445,
                "updatetime": 1506671333528,
                "nick": "usernick2",
                "accid": "user2",
                "mute": false,
                "custom": ""
            }
        ],
        "members": [
            {
                "createtime": 1506652312445,
                "updatetime": 1506671333528,
                "nick": "usernick3",
                "accid": "user3",
                "mute": false,
                "custom": null
            },
            {
                "createtime": 1506652312445,
                "updatetime": 1506652312445,
                "nick": "usernick4",
                "accid": "user4",
                "mute": false,
                "custom": null
            }
        ]
    }
}

获取群组已读消息的已读详情信息

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidlong 群id,群唯一标识,创建群时会返回
msgidlong 发送群已读业务消息时服务器返回的消息ID
fromAccidString 消息发送者账号
snapshotBoolean 是否返回已读、未读成员的accid列表,默认为false

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9d***3mgq3" -H "Nonce: 4tg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9***86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&msgid=1200510468189&fromAccid=user12&snapshot=true' "https://api.netease.im/nimserver/team/getMarkReadInfo.action"

返回示例

json{
    "code": 200,
    "data": {
        "readSize": 2,
        "unreadSize": 1,
        "readAccids": [
            "user1","user2"
        ],
        "unreadAccids": [
            "user3"
        ],
    }
}

转让群主

功能描述

转换群主身份。群主转让后可以选择离开此群,或者留下来成为普通成员。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主用户帐号,最大长度32字符
newownerString 新群主帐号,最大长度32字符
leaveint 1:群主解除群主后离开群,2:群主解除群主后成为普通成员。其它414
attach String自定义扩展字段,最大长度512

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9d***03mgq3" -H "Nonce: 4tgg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9***86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&newowner=lisi&leave=1' 'https://api.netease.im/nimserver/team/changeOwner.action'

返回示例

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

添加管理员

功能描述

将普通成员添加为群管理员,可以批量,但是一次添加最多不超过10个人。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主用户帐号,最大长度32字符
membersString \["aaa","bbb"\](JSONArray对应的accid,如果解析出错会报414),长度最大1024字符(一次添加最多10个管理员)
attach String自定义扩展字段,最大长度512

示例

请求示例(curl)

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

返回示例

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

移除管理员

功能描述

移除管理员身份,可以批量,但是一次解除最多不超过10个人 。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回,最大长度128字符
ownerString 群主用户帐号,最大长度32字符
membersString \["aaa","bbb"\](JSONArray对应的accid,如果解析出错会报414),长度最大1024字符(一次解除最多10个管理员)
attach String自定义扩展字段,最大长度512

示例

请求示例(curl)

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

返回示例

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

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

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
accidString 要查询用户的accid

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9d***3mgq3" -H "Nonce: 4tg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***83f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan' 'https://api.netease.im/nimserver/team/joinTeams.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{   "code":200 ,
    "count":2,
    "infos":
      [
          {"owner":"t2","tname":"test1","maxusers":50,"tid":3620,"size":3, "custom":""},
          {"owner":"t1","tname":"test2","maxusers":50,"tid":3622,"size":4, "custom":""}
      ]
}

修改群昵称

功能描述

修改指定账号在高级群中的昵称。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 群唯一标识,创建群时网易云信服务器产生并返回
ownerString 群主 accid
accidString 要修改群昵称的群成员 accid
nickString accid 对应的群昵称,最大长度32字符
customString 自定义扩展字段,最大长度1024字节

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9d***03mgq3" -H "Nonce: 4tg***23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db***83f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&accid=lisi&nick=jack' 'https://api.netease.im/nimserver/team/updateTeamNick.action'

返回示例

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

修改消息提醒开关

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回
accid String 要操作的群成员accid
ope int 1:关闭消息提醒,2:打开消息提醒,其他值无效

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9***3mgq3" -H "Nonce: 4tg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9d***3f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=11111&accid=lisi&ope=1' 'https://api.netease.im/nimserver/team/muteTeam.action'

返回示例

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

禁言群成员

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回
owner String 群主accid
accid String 禁言对象的accid
mute int 1-禁言,0-解禁
attach String自定义扩展字段,最大长度512

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9d***gq3" -H "Nonce: 4tg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3***83f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&accid=wangwu&mute=1' 'https://api.netease.im/nimserver/team/muteTlist.action'

返回示例

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

主动退群

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回
accid String 退群的accid
attach String自定义扩展字段,最大长度512

示例

请求示例(curl)

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

返回示例

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

将群组整体禁言

功能描述

禁言群组,普通成员不能发送消息,创建者和管理员可以发送消息。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回
owner String 群主的accid
mute String true:禁言,false:解禁(mute和muteType至少提供一个,都提供时按mute处理)
muteType int 禁言类型 0:解除禁言,1:禁言普通成员 3:禁言整个群(包括群主)
attach String自定义扩展字段,最大长度512

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9d***3mgq3" -H "Nonce: 4tgg***23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9d***5583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=zhangsan&mute=1'  'https://api.netease.im/nimserver/team/muteTlistAll.action'

返回示例

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

获取群组禁言列表

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
tidString 网易云信服务器产生,群唯一标识,创建群时会返回
owner String 群主的accid

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9d***03mgq3" -H "Nonce: 4tg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9***583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=wangwu'  'https://api.netease.im/nimserver/team/listTeamMute.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{
  "code":200, 
  "mutes":[ 
    {"nick":"nick1","accid":"user1","tid":17874,"type":0}, 
    {"nick":"nick2","accid":"user2","tid":17874,"type":0} 
  ]
}

状态码

上述接口在 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)
  • 返回示例
  • 状态码