API 参考
圈组

圈组身份组管理

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

本文已废弃,请前往服务器身份组及相关文档查看。

身份组是圈组功能的权限管理系统。您可通过身份组,实现对服务器成员和频道成员的精细化权限控制。

创建服务器身份组

请求说明

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

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

接口描述

创建服务器身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
typeint类型:2为自定义身份组,目前只能设置为2
nameString身份组名称
iconString身份组图标url
extString自定义扩展,最大长度1024
priorityString优先级数字,正数。数字越小,优先级越大,最小为1,everyone身份组为0,但不参与比较

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&type=2&name="新身份组1"&icon="iconurl"&ext="ext"&priority=12' 'http://api.netease.im/nimserver/qchat/createServerIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
	"code": 200,
	"identify": {
		"ext": "ext",//扩展字段
		"membercount": 1,//身份组的成员数
		"createtime": 1,//创建时间
		"roleId": 1,//身份组的唯一标识
		"auths": "{\"1\":-1, \"2\":1}",//身份组的权限,key为权限的枚举值,value为1允许,-1拒绝,服务器身份组只有允许和拒绝
		"name": "name",//身份组名称
		"icon": "icon",//身份组图标url
		"priority": 1,//身份组的优先级,优先级数字越小优先级越高,1为最高,everyone为特殊身份组为0不参与其他身份组的比较
		"type": 1,//身份组的类型1:everyone身份组,2:自定义身份组
		"updatetime": 1//更新时间
	}
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


删除服务器身份组

请求说明

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

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

接口描述

删除服务器身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
roleIdint身份组唯一标识

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&roleId=2' 'http://imtest.netease.im/nimserver/qchat/removeServerIdentify.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


更新服务器身份组

请求说明

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

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

仅自定义身份组(即 type2 的身份组)支持调用该接口更新身份组信息。创建服务器时默认创建的 @everyone 身份组 (即 type1 的身份组)不支持调用该接口更新其信息。@everyone 身份组仅支持修改其权限。如果调用该接口更新 @everyone 身份组的信息(身份组的名称,图标,自定义扩展,优先级), 将报错(错误码 403)。

接口描述

更新服务器身份组信息,包括身份组名称、身份组图标、身份组权限等。

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
roleIdString服务器身份组唯一标识
nameString身份组名称
iconString身份组图标url
extString自定义扩展,最大长度1024
authsString

用于修改权限的 JSON 字段, 其格式为 {resource1:type1,resource2:type2,resource3:type3}。

  • resource 表示权限, 其取值代表的具体权限如下:
    • 1:管理服务器
    • 2:管理频道
    • 3:管理角色
    • 4:发送消息
    • 5:修改自己在圈组服务器的成员信息
    • 6:邀请他人加入圈组服务器
    • 7:将他人踢出圈组服务器
    • 8:修改他人在圈组服务器的成员信息
    • 9:撤回他人消息
    • 10:删除他人消息
    • 11:@ 他人
    • 12:@ 所有人
    • 13:管理黑白名单
    • 14:封禁他人
    • 15:实时互动频道:建立自己连接的权限
    • 16:实时互动频道:断开他人连接的权限
    • 17:实时互动频道:开启自己麦克风的权限
    • 18:实时互动频道:开启自己摄像头的权限
    • 19:实时互动频道:开启/关闭他人麦克风的权限
    • 20:实时互动频道:开启/关闭他人摄像头的权限
    • 21:实时互动频道:开启/关闭全员麦克风的权限
    • 22:实时互动频道:开启/关闭全员摄像头的权限
    • 23:实时互动频道:打开自己屏幕共享的权限
    • 24:实时互动频道:关闭他人屏幕共享的权限
    • 25:申请邀请管理权限
    • 26:申请邀请历史查看权限,有这个权限才可以查询server级别的申请/邀请记录
  • type 表示操作类型,其取值代表的操作如下:

    • -1:不授权(deny)
    • 1:授权(allow)

注:单次最多可批量更新当前身份组的所有权限。

bidString用户配置的对某些资料内容另外的反垃圾的业务 ID, JSON 格式, 如 {"textbid":"","picbid":""}

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&roleId=2&name="新身份组1"&icon="iconurl"&ext="ext"&auths="{\"1\":1}"' 'http://imtest.netease.im/nimserver/qchat/updateServerIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
	"code": 200,
	"identify": {
		"ext": "ext",//扩展字段
		"membercount": 1,//身份组的成员数
		"createtime": 1,//创建时间
		"roleId": 1,//身份组的唯一标识
		"auths": "{\"1\":-1, \"2\":1}",//身份组的权限,key为权限的枚举值,value为1允许,-1拒绝,服务器身份组只有允许和拒绝
		"name": "name",//身份组名称
		"icon": "icon",//身份组图标url
		"priority": 1,//身份组的优先级,优先级数字越小优先级越高,1为最高,everyone为特殊身份组为0不参与其他身份组的比较
		"type": 1,//身份组的类型1:everyone身份组,2:自定义身份组
		"updatetime": 1//更新时间
	}
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表



分页查询服务器身份组

请求说明

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

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

接口描述

分页查询服务器身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
priorityLong优先级从小到大(数值)排序,分页的锚点,每页的页尾数据的优先级,不传或者传0默认为首页,首页会返回everyone身份组放在返回结果集的首条
limitInteger每页限制查询多少条,不传时默认为200,最大限制为200
channelIdString可选,以channelId的名义查询。若设置该字段,则只需要有该channel的管理权限即可,否则需要有server的管理权限
categoryIdString可选,以categoryId的名义查询。若设置该字段,则只需要有该channel category的管理权限即可,否则需要有server的管理权限

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&priority=1&limit=10' 'http://api.netease.im/nimserver/qchat/getServerIdentifyPages.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
	"serverIdentifies":[{
		"ext": "ext",//扩展字段
		"membercount": 1,//身份组的成员数
		"createtime": 1,//创建时间
		"roleId": 1,//身份组的唯一标识
		"auths": "{\"1\":-1, \"2\":1}",//身份组的权限,key为权限的枚举值,value为1允许,-1拒绝,服务器身份组只有允许和拒绝
		"name": "name",//身份组名称
		"icon": "icon",//身份组图标url
		"priority": 1,//身份组的优先级,优先级数字越小优先级越高,1为最高,everyone为特殊身份组为0不参与其他身份组的比较
		"type": 1,//身份组的类型1:everyone身份组,2:自定义身份组
		"updatetime": 1,//更新时间
		"ismember": 0//操作者是否属于服务器成员,0不属于,1属于
	}]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


创建频道身份组

请求说明

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

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

接口描述

创建频道身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
serverRoleIdString继承自服务器哪个身份组的id
channelIdString频道的唯一标识

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&serverRoleId=2&channelId=10001' 'http://api.netease.im/nimserver/qchat/createChannelIdentify.action'

返回说明

http 响应:json

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

{
	"code": 200,
	"identify": {
		"serverId": 2,//服务器唯一标识
		"channelId": 1,//频道唯一标识
		"createtime": 1,//创建时间
		"roleId": 1,//频道身份组唯一标识
		"auths": "{\"1\":-1, \"2\":1}",//频道身份组的权限,key为权限的枚举值,value为1允许,-1拒接,0忽略(也叫继承服务器权限)
		"serverRoleId": 1,//继承自服务器身份组的id
		"name": "name",//继承自服务器身份组的名称
		"icon": "icon",//继承自服务器身份组的头像
		"ext": "ext",//继承自服务器身份组的扩展字段
		"type": 1,//继承自服务器身份组的类型,1everyone身份组,2自定义身份组
		"updatetime": 1
	}
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


删除频道身份组

请求说明

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

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

接口描述

删除频道身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
roleIdString频道身份组的id,新建和查询频道身份组返回的roleid,非服务器身份组的roleid
channelIdString频道的唯一标识

curl请求示例

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 'serverId=1513535&accid="accid"&roleId=2&channelId=10001' 'http://api.netease.im/nimserver/qchat/deleteChannelIdentify.action'

返回说明

http 响应:json

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

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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


更新频道身份组

请求说明

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

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

接口描述

更新频道身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
roleIdString频道身份组的id,新建和查询频道身份组返回的roleid,非服务器身份组的roleid
channelIdString频道的唯一标识
authsString

用于修改权限的 JSON 字段, 其格式为 {resource1:type1,resource2:type2,resource3:type3}。

  • resource 表示权限, 其有效取值代表的具体权限如下:
    • 2:管理频道
    • 3:管理角色
    • 4:发送消息
    • 9:撤回他人消息
    • 10:删除他人消息
    • 11:@ 他人
    • 12:@ 所有人
    • 13:管理黑白名单
    • 15:实时互动频道:建立自己连接的权限
    • 16:实时互动频道:断开他人连接的权限
    • 17:实时互动频道:开启自己麦克风的权限
    • 18:实时互动频道:开启自己摄像头的权限
    • 19:实时互动频道:开启/关闭他人麦克风的权限
    • 20:实时互动频道:开启/关闭他人摄像头的权限
    • 21:实时互动频道:开启/关闭全员麦克风的权限
    • 22:实时互动频道:开启/关闭全员摄像头的权限
    • 23:实时互动频道:打开自己屏幕共享的权限
    • 24:实时互动频道:关闭他人屏幕共享的权限
  • type 表示操作类型,其取值代表的操作如下:

    • -1:不授权(deny)
    • 1:授权(allow)
    • 0: 继承圈组服务器维度下对应权限的授权状态

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&roleId=2&channelId=10010&auths="{\"1\":1}"' 'http://api.netease.im/nimserver/qchat/updateChannelIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
	"code": 200,
	"identify": {
		"serverId": 2,//服务器唯一标识
		"channelId": 1,//频道唯一标识
		"createtime": 1,//创建时间
		"roleId": 1,//频道身份组唯一标识
		"auths": "{\"1\":-1, \"2\":1}",//频道身份组的权限,key为权限的枚举值,value为1允许,-1拒接,0忽略(也叫继承服务器权限)
		"serverRoleId": 1,//继承自服务器身份组的id
		"name": "name",//继承自服务器身份组的名称
		"icon": "icon",//继承自服务器身份组的头像
		"ext": "ext",//继承自服务器身份组的扩展字段
		"type": 1,//继承自服务器身份组的类型,1everyone身份组,2自定义身份组
		"updatetime": 1
	}
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


分页查询频道身份组

请求说明

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

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

接口描述

分页查询频道身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
channelIdString频道的唯一标识
timetagString频道身份组按照创建时间由大到小排序,分页的锚点,每页页尾数据的创建时间,不传或者传0默认为首页,首页会将everyone身份组放在返回结果第一条返回,比其他页多一条数据
limitString每页限制查询的数量,不传时默认为200条,最大为200

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&channelId=10010&timetag=1111111111111&limit=10' 'http://api.netease.im/nimserver/qchat/getChannelIdentifyPages.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
	"identifies":[{
		"serverId": 2,//服务器唯一标识
		"channelId": 1,//频道唯一标识
		"createtime": 1,//创建时间
		"roleId": 1,//频道身份组唯一标识
		"auths": "{\"1\":-1, \"2\":1}",//频道身份组的权限,key为权限的枚举值,value为1允许,-1拒接,0忽略(也叫继承服务器权限)
		"serverRoleId": 1,//继承自服务器身份组的id
		"name": "name",//继承自服务器身份组的名称
		"icon": "icon",//继承自服务器身份组的头像
		"ext": "ext",//继承自服务器身份组的扩展字段
		"type": 1,//继承自服务器身份组的类型,1everyone身份组,2自定义身份组
		"updatetime": 1
	}]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


创建频道分组身份组

请求说明

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

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

接口描述

创建频道分组身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
serverRoleIdString继承的服务器身份组ID
categoryIdString频道分组唯一标识

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&serverRoleId=2&categoryId=10001' 'http://api.netease.im/nimserver/qchat/createChannelCategoryIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "identify": {
        "serverId": 2,
        "categoryId": 1,
        "createtime": 1,
        "roleId": 1,
        "auths": "{\"1\":-1, \"2\":1}",
        "serverRoleId": 1,
        "name": "name",
        "icon": "icon",
        "ext": "ext",
        "type": 1,
        "updatetime": 1
    }
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


删除频道分组身份组

请求说明

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

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

接口描述

删除频道分组身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
roleIdString频道分组身份组唯一标识
categoryIdString频道分组唯一标识

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&roleId=2&categoryId=10001' 'http://api.netease.im/nimserver/qchat/deleteChannelCategoryIdentify.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


修改频道分组身份组权限

请求说明

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

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

接口描述

修改频道分组身份组权限

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
roleIdString频道分组身份组唯一标识
categoryIdString频道分组唯一标识
authsString

用于修改权限的 JSON 字段, 其格式为 {resource1:type1,resource2:type2,resource3:type3}。

  • resource 表示权限, 其取值代表的具体权限如下:
    • 2:管理频道
    • 3:管理角色
    • 4:发送消息
    • 9:撤回他人消息
    • 10:删除他人消息
    • 11:@ 他人
    • 12:@ 所有人
    • 13:管理黑白名单
    • 15:实时互动频道:建立自己连接的权限
    • 16:实时互动频道:断开他人连接的权限
    • 17:实时互动频道:开启自己麦克风的权限
    • 18:实时互动频道:开启自己摄像头的权限
    • 19:实时互动频道:开启/关闭他人麦克风的权限
    • 20:实时互动频道:开启/关闭他人摄像头的权限
    • 21:实时互动频道:开启/关闭全员麦克风的权限
    • 22:实时互动频道:开启/关闭全员摄像头的权限
    • 23:实时互动频道:打开自己屏幕共享的权限
    • 24:实时互动频道:关闭他人屏幕共享的权限
  • type 表示操作类型,其取值代表的操作如下:

    • -1:不授权(deny)
    • 1:授权(allow)
    • 0:继承

注:单次最多可批量修改权限数为12。

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&roleId=2&categoryId=10010&auths="{\"1\":1}"' 'http://api.netease.im/nimserver/qchat/updateChannelCategoryIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "identify": {
        "serverId": 2,
        "categoryId": 1,
        "createtime": 1,
        "roleId": 1,
        "auths": "{\"1\":-1, \"2\":1}",
        "serverRoleId": 1,
        "name": "name",
        "icon": "icon",
        "ext": "ext",
        "type": 1,
        "updatetime": 1
    }
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


分页查询频道分组身份组信息

请求说明

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

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

接口描述

分页查询频道分组身份组信息

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
categoryIdString频道分组唯一标识
timetagString分页起始时间
limitString每页限制查询的数量,不传时默认为200,最大限制为200

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&channelId=10010&timetag=1111111111111&limit=10' 'http://api.netease.im/nimserver/qchat/getChannelCategoryIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "identifies":[{
        "serverId": 2,
        "categoryId": 1,
        "createtime": 1,
        "roleId": 1,
        "auths": "{\"1\":-1, \"2\":1}",
        "serverRoleId": 1,
        "name": "name",
        "icon": "icon",
        "ext": "ext",
        "type": 1,
        "updatetime": 1
    }]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


单用户定制权限管理

创建频道下某人的定制权限

请求说明

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

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

接口描述

在频道下为某个人定制权限

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
channelIdString频道的唯一标识
faccidString被操作的用户的accid

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&channelId=10010&faccid="faccid"' 'http://imtest.netease.im/nimserver/qchat/createUserIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
	"code": 200,
	"identify": {
		"serverId": 2,//服务器唯一标识
		"channelId": 1,//频道唯一标识
		"createtime": 1,//创建时间
		"accid": "accid",//用户的accid
		"auths": "{\"1\":-1, \"2\":1}",//个人定制权限,key为权限的枚举值,value为1允许,-1拒绝,0忽略
		"avatar": "name",//用户在服务器下的头像
		"inviter": "icon",//邀请者的用户账号
		"joinTime": 1,//用户加入服务器的时间
		"nick": "icon",//昵称
		"memberType": 1,//类型:0-普通成员,1-所有者
		"custom": "icon",//用户的自定义扩展字段
		"updatetime": 1//更新时间
	}
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


删除频道下某人的定制权限

请求说明

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

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

接口描述

删除频道下某人的定制权限

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
channelIdString频道的唯一标识
faccidString被操作的用户的accid

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&channelId=10010&faccid="faccid"' 'http://imtest.netease.im/nimserver/qchat/deleteUserIdentify.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


更新频道下用户定制权限

请求说明

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

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

接口描述

更新频道下用户定制权限

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
channelIdString频道的唯一标识
faccidString被操作的用户的accid
authsString

用于修改权限的 JSON 字段, 其格式为 {resource1:type1,resource2:type2,resource3:type3}。

  • resource 表示权限, 其取值代表的具体权限如下:
    • 2:管理频道
    • 3:管理角色
    • 4:发送消息
    • 9:撤回他人消息
    • 10:删除他人消息
    • 11:@ 他人
    • 12:@ 所有人
    • 13:管理黑白名单
    • 15:实时互动频道:建立自己连接的权限
    • 16:实时互动频道:断开他人连接的权限
    • 17:实时互动频道:开启自己麦克风的权限
    • 18:实时互动频道:开启自己摄像头的权限
    • 19:实时互动频道:开启/关闭他人麦克风的权限
    • 20:实时互动频道:开启/关闭他人摄像头的权限
    • 21:实时互动频道:开启/关闭全员麦克风的权限
    • 22:实时互动频道:开启/关闭全员摄像头的权限
    • 23:实时互动频道:打开自己屏幕共享的权限
    • 24:实时互动频道:关闭他人屏幕共享的权限
  • type 表示操作类型,其取值代表的操作如下:

    • -1:不授权(deny)
    • 1:授权(allow)
    • 0: 继承频道维度下对应权限的授权状态

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&channelId=10010&faccid="faccid"&auths="{\"1\":1}"' 'http://imtest.netease.im/nimserver/qchat/updateUserIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
	"code": 200,
	"identify": {
		"serverId": 2,//服务器唯一标识
		"channelId": 1,//频道唯一标识
		"createtime": 1,//创建时间
		"accid": "accid",//用户的accid
		"auths": "{\"1\":-1, \"2\":1}",//个人定制权限,key为权限的枚举值,value为1允许,-1拒绝,0忽略
		"avatar": "name",//用户在服务器下的头像
		"inviter": "icon",//邀请者的用户账号
		"joinTime": 1,//用户加入服务器的时间
		"nick": "icon",//昵称
		"memberType": 1,//类型:0-普通成员,1-所有者
		"custom": "icon",//用户的自定义扩展字段
		"updatetime": 1//更新时间
	}
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


分页查询频道下用户的定制权限

请求说明

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

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

接口描述

分页查询频道下用户们的定制权限

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
channelIdString频道的唯一标识
timetagString个人定制权限按照创建时间由大到小排序,分页的锚点,每页页尾数据的创建时间,不传或者传0默认为查询服务器当前时间之前的limit条数据
limitString每页查询的数量

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&channelId=10010&timetag=11111111111&limit=20' 'http://imtest.netease.im/nimserver/qchat/getUserIdentifyPages.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
	"identifies":[{
		"serverId": 2,//服务器唯一标识
		"channelId": 1,//频道唯一标识
		"createtime": 1,//创建时间
		"accid": "accid",//用户的accid
		"auths": "{\"1\":-1, \"2\":1}",//个人定制权限,key为权限的枚举值,value为1允许,-1拒绝,0忽略
		"avatar": "name",//用户在服务器下的头像
		"inviter": "icon",//邀请者的用户账号
		"joinTime": 1,//用户加入服务器的时间
		"nick": "icon",//昵称
		"memberType": 1,//类型:0-普通成员,1-所有者
		"custom": "icon",//用户的自定义扩展字段
		"updatetime": 1//更新时间
	}]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


把某些人拉进某服务器身份组

请求说明

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

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

接口描述

把某些人拉进某服务器身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
roleIdString服务器身份组唯一标识
faccidsString被操作的用户的accid集合,jsonarray格式 ["accid1","accid2"]

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&roleId=1&faccids="[\"accid1\",\"accid2\"]"' 'http://imtest.netease.im/nimserver/qchat/createServerIdentifyMember.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
	"successAccids":"[\"accid1\",\"accid2\"]",//添加成功的accid集合
	"failAccids":"[\"accid1\",\"accid2\"]"//添加失败的acci集合
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


创建频道分组下某人的定制权限

请求说明

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

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

接口描述

在频道分组下为某个人定制权限

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
categoryIdString频道分组的唯一标识
targetAccidString被操作的用户accid

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&categoryId=10010&targetAccid="faccid"' 'http://api.netease.im/nimserver/qchat/createChannelCategoryUserIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "identify": {
        "serverId": 2,
        "categoryId": 1,
        "createtime": 1,
        "accid": "accid",
        "auths": "{\"1\":-1, \"2\":1}",
        "avatar": "name",
        "inviter": "icon",
        "joinTime": 1,
        "nick": "icon",
        "memberType": 1,
        "custom": "icon",
        "updatetime": 1
    }
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


删除频道分组下某人的定制权限

请求说明

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

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

接口描述

删除频道分组下某人的定制权限

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
categoryIdString频道分组的唯一标识
targetAccidString被删除的用户的accid

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&categoryId=10010&targetAccid="faccid"' 'http://api.netease.im/nimserver/qchat/deleteChannelCategoryUserIdentify.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


修改频道分组下某人的定制权限

请求说明

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

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

接口描述

修改频道分组下某人的定制权限

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
categoryIdString频道分组的唯一标识
targetAccidString被修改的用户的accid
authsString

用于修改权限的 JSON 字段, 其格式为 {resource1:type1,resource2:type2,resource3:type3}。

  • resource 表示权限, 其取值代表的具体权限如下:
    • 2:管理频道
    • 3:管理角色
    • 4:发送消息
    • 9:撤回他人消息
    • 10:删除他人消息
    • 11:@ 他人
    • 12:@ 所有人
    • 13:管理黑白名单
    • 15:实时互动频道:建立自己连接的权限
    • 16:实时互动频道:断开他人连接的权限
    • 17:实时互动频道:开启自己麦克风的权限
    • 18:实时互动频道:开启自己摄像头的权限
    • 19:实时互动频道:开启/关闭他人麦克风的权限
    • 20:实时互动频道:开启/关闭他人摄像头的权限
    • 21:实时互动频道:开启/关闭全员麦克风的权限
    • 22:实时互动频道:开启/关闭全员摄像头的权限
    • 23:实时互动频道:打开自己屏幕共享的权限
    • 24:实时互动频道:关闭他人屏幕共享的权限
  • type 表示操作类型,其取值代表的操作如下:

    • -1:不授权(deny)
    • 1:授权(allow)
    • 0: 继承

注:单次最多可批量修改权限数为12。

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&categoryId=10010&targetAccid="faccid"&auths="{\"1\":1}"' 'http://api.netease.im/nimserver/qchat/updateChannelCategoryUserIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "identify": {
        "serverId": 2,
        "categoryId": 1,
        "createtime": 1,
        "accid": "accid",
        "auths": "{\"1\":-1, \"2\":1}",
        "avatar": "name",
        "inviter": "icon",
        "joinTime": 1,
        "nick": "icon",
        "memberType": 1,
        "custom": "icon",
        "updatetime": 1
    }
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


分页查询频道分组下某人的定制权限

请求说明

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

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

接口描述

分页查询频道分组下某人的定制权限

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
categoryIdString频道分组的唯一标识
timetagString分页的起始timetag
limitString每页限制查询的数量,不传时默认为200条,最大为200

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&categoryId=10010&timetag=11111111111&limit=20' 'http://api.netease.im/nimserver/qchat/getChannelCategoryUserIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "identifies":[{
        "serverId": 2,
        "categoryId": 1,
        "createtime": 1,
        "accid": "accid",
        "auths": "{\"1\":-1, \"2\":1}",
        "avatar": "name",
        "inviter": "icon",
        "joinTime": 1,
        "nick": "icon",
        "memberType": 1,
        "custom": "icon",
        "updatetime": 1
    }]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


身份组成员管理

将某些人移除某个服务器身份组

请求说明

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

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

接口描述

将某些人移除某个服务器身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
roleIdString服务器身份组唯一标识
faccidsString被操作的用户的accid集合,jsonarray格式 ["accid1","accid2"]

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&roleId=1&faccids="[\"accid1\",\"accid2\"]"' 'http://imtest.netease.im/nimserver/qchat/deleteServerIdentifyMember.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
	"successAccids":["accid1"],//移除成功的accid集合
	"failAccids":["accid2"]//移除失败的accid集合
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


分页查询某个服务器身份组中有哪些人

请求说明

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

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

仅自定义身份组(即 type2 的身份组)支持调用该接口查询成员名单。创建服务器时默认创建的 @everyone 身份组 (即 type1 的身份组)不支持调用该接口查询成员名单。如果调用该接口进行查询,将报错(错误码 403)。

接口描述

分页查询某个服务器身份组中有哪些人

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
roleIdString服务器身份组唯一标识
timetagString根据用户进入身份组的时间从大到小排序,分页的锚点,每页页尾数据的创建时间,不传或者传0默认查当前时间往前limit条数据
faccidString当一页数据页尾多条数据的创建时间相同时,根据用户的accid作为锚点来拉取下一页数据
limitString每页查询的条数,不填时为200,最大200

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&roleId=1&timetag=1111111111111&faccid="accid1"&limit=20' 'http://imtest.netease.im/nimserver/qchat/getServerIdentifyMemberPages.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
	"serverMembers":[{
	"serverId": 123, //服务器唯一标识 
	"accid": "lisi", //成员的用户帐号
	"nick": "nick", //昵称
	"avatar": "avatar", //头像
	"custom": "custom", //自定义扩展
	"type": 0, //类型:0-普通成员,1-所有者
	"joinTime": 1234, //加入时间
	"inviter": "zhangsan", //邀请者的用户帐号
	"validFlag": 1, //有效标志:0-无效,1-有效
	"createTime": 1234, //创建时间
	"updateTime": 1234 //更新时间
	}]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


分页查询某个用户在哪些身份组

请求说明

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

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

接口描述

分页查询某个用户在哪些身份组

参数说明

参数类型必须说明
accidString操作者accid
serverIdString服务器唯一标识
faccidString要查询那个用户的accid
timetagString根据用户加入不同身份组的时间从大到小排序,分页的锚点,每页页尾数据的创建时间,不传或者传0默认查当前时间往前limit条数据
limitString每页查询的条数,不填时为200,最大200

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&timetag=1111111111111&faccid="accid1"&limit=20' 'http://imtest.netease.im/nimserver/qchat/getUserServerIdentify.action'

返回说明

http 响应:json

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
	"serverIdentifies":[{
		"ext": "ext",//服务器身份组扩展字段
		"membercount": 1,//服务器身份组成员数
		"createtime": 1,//创建时间
		"roleId": 1,//服务器身份组唯一标识
		"auths": "{\"1\":-1, \"2\":1}",//服务器身份组的权限,key为权限的枚举值,value为1允许,-1不允许
		"name": "name",//服务器身份组的名称
		"icon": "icon",//服务器身份组的图标url
		"priority": 1,//优先级
		"type": 2,//类型,1是everyone身份组,2是自定义身份组
		"updatetime": 1,//更新时间
		"ismember": 0//操作者是否在这个身份组中
	}]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表

批量更新服务器身份组优先级

指定某个服务器批量更新该服务器的身份组优先级。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式

  • POST 请求中 Body 的设置如下:

参数类型是否必传说明
accidString操作者的云信 IM 账号
roleIdPrioritiesString服务器身份组唯一标识和优先级的列表,JSON 数组(roleId|priority),示例"["12345|0", "45678|1"]"
serverId long服务器唯一标识

返回参数

参数
类型
说明
code int 状态码
identifies String 身份组信息

其中 identifies 包含的参数说明如下:

参数
类型
说明
ext String 身份组自定义扩展
membercount Number 身份组成员数量
createtime Number 创建时间
roleId long 身份组 ID
auths String 身份组权限
name String 身份组名称
icon String 身份组图标的 URL
priority String 身份组的优先级,正数。数字越小,优先级越大,最小为1,everyone 身份组为 0,但不参与比较
type int 身份组类型
updatetime String 更新时间
ismember int 当前用户是否在该身份组中, 0-否,1-是

示例

cURL 请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9*****kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962c*****7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid="accid"&serverIdAccids=%5B%2254321|11%22%2C%2254322|22%22%5D' 'http://api.netease.im/nimserver/qchat/batchUpdateServerIdentifyPriority.action'

返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "identifies":[{
        "ext": "ext", //身份组自定义扩展
        "membercount": 1, //身份组成员数量
        "createtime": 1, //创建时间
        "roleId": 1, //身份组ID
        "auths": "{\"1\":-1, \"2\":1}", //身份组权限
        "name": "name", //身份组名称
        "icon": "icon", //身份组图标
        "priority": 1, //身份组优先级
        "type": 1, //身份组类型
        "updatetime": 1, //更新时间
        "ismember": 0 //自己是否在该身份组中,01是
    }]
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,状态码列表请参考状态码

查询某人是否拥有某些权限

查询某人是否拥有指定服务器或者指定服务器下某个频道的某些权限。

一次最多可查询 10 个权限。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式

  • POST 请求中 Body 的设置如下:

参数
类型
是否必传 说明
accid String 待查询用户的云信 IM 账号
serverId long 服务器唯一标识
channelId long 频道唯一标识,如果不填则表示查询服务器权限
resources String 可以转成 JSON 数组,每一项表示一个权限,最多10个。resource 的具体定义,请参见更新服务器身份组中对于 auths 参数的说明。

返回参数

参数 类型 说明
code int 状态码
isAllowResources String 由“权限枚举值”和“是否拥有权限”组成的 JSON 数组

示例

cURL 请求示例

curl -X POST -H "AppKey: go9dnk49b*****9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962c*****7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&channelId=1513535&accid=zhangsan&resources=%5B%2216%22%2C%2218%22%5D' 'http://api.netease.im/nimserver/qchat/queryIdentifyResources.action'

返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "isAllowResources": [
        {
            "resource": 1,  //权限枚举值
            "isAllow": true //是否有权限
        },
        {
            "resource": 2,
            "isAllow": true
        },
        {
            "resource": 3,
            "isAllow": true
        }
    ]
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,状态码列表请参考状态码

此文档是否对你有帮助?
有帮助
去反馈
  • 创建服务器身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 删除服务器身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 更新服务器身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 分页查询服务器身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 创建频道身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 删除频道身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 更新频道身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 分页查询频道身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 创建频道分组身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 删除频道分组身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 修改频道分组身份组权限
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 分页查询频道分组身份组信息
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 单用户定制权限管理
  • 创建频道下某人的定制权限
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 删除频道下某人的定制权限
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 更新频道下用户定制权限
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 分页查询频道下用户的定制权限
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 把某些人拉进某服务器身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 创建频道分组下某人的定制权限
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 删除频道分组下某人的定制权限
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 修改频道分组下某人的定制权限
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 分页查询频道分组下某人的定制权限
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 身份组成员管理
  • 将某些人移除某个服务器身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 分页查询某个服务器身份组中有哪些人
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 分页查询某个用户在哪些身份组
  • 请求说明
  • 接口描述
  • 参数说明
  • curl请求示例
  • 返回说明
  • 主要的返回码
  • 批量更新服务器身份组优先级
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • cURL 请求示例
  • 返回示例
  • 状态码
  • 查询某人是否拥有某些权限
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • cURL 请求示例
  • 返回示例
  • 状态码