服务端
API 参考
圈组

身份组成员管理

更新时间: 2024/06/05 10:53:25

添加服务器身份组成员

将某些用户拉入某个服务器身份组。

调用该 API 必须先拥有管理角色权限(服务器创建者默认拥有该权限)。

URL

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

请求参数

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

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

参数
类型
必须
说明
accidString操作者accid
serverIdString服务器唯一标识
roleIdString服务器身份组唯一标识
faccidsString被操作的用户的accid集合,jsonarray格式 ["accid1","accid2"]一次最多传入 100 个账号 ID。

示例

curl请求示例

curlcurl -X POST -H "AppKey: go9dnk4**3mgq3" -H "Nonce: 4tggge**23t23t" -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集合
}

状态码

该 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码

该 API 的主要状态码如下: 200、403、414、416、431、500

移除服务器身份组成员

将某些用户从某个服务器身份组中移出。

调用该 API 必须先拥有管理角色权限(服务器创建者默认拥有该权限)。

URL

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

请求参数

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

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

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

示例

cURL请求示例

curlcurl -X POST -H "AppKey: go9dnk49b**lw0803mgq3" -H "Nonce: 4tgg**323t23t" -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集合
}

状态码

该 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码

该 API 的主要状态码如下: 200、403、414、416、431、500

分页查询服务器身份组成员

分页查询某个服务器身份组中的成员列表。

  • 调用该 API 必须先拥有管理角色权限(服务器创建者默认拥有该权限)。
  • 仅自定义身份组(即 type2 的身份组)支持调用该接口查询成员名单。创建服务器时默认创建的 @everyone 身份组 (即 type1 的身份组)不支持调用该接口查询成员名单。如果调用该接口进行查询,将报错(错误码 403)。

URL

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

请求参数

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

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

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

示例

cURL请求示例

curlcurl -X POST -H "AppKey: go9dnk4**w0803mgq3" -H "Nonce: 4tggge**3t23t" -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"
{
    "code":200,
	"serverMembers":[{
	"accid": "lisi", //成员的用户帐号
	"nick": "nick", //昵称
	"avatar": "avatar", //头像
	"custom": "custom", //自定义扩展
	"memberType": 0, //类型:0-普通成员,1-所有者
	"joinTime": 1234, //加入时间
	"inviter": "zhangsan", //邀请者的用户帐号
	"createTime": 1234, //创建时间
	"updateTime": 1234 //更新时间
	}]
}

状态码

该 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码

该 API 主要状态码如下: 200、403、414、416、431、500

分页查询用户所属的身份组

分页查询某个用户所属的身份组列表。

调用该 API 必须先拥有管理角色权限(服务器创建者默认拥有该权限)。

URL

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

请求参数

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

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

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

示例

cURL请求示例

curlcurl -X POST -H "AppKey: go9dnk49b**0803mgq3" -H "Nonce: 4tggge**23t" -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//操作者是否在这个身份组中
	}]
}

状态码

该 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码

该 API 主要状态码如下: 200、403、414、416、431、500

此文档是否对你有帮助?
有帮助
去反馈
  • 添加服务器身份组成员
  • URL
  • 请求参数
  • 示例
  • curl请求示例
  • 返回示例
  • 状态码
  • 移除服务器身份组成员
  • URL
  • 请求参数
  • 示例
  • cURL请求示例
  • 返回示例
  • 状态码
  • 分页查询服务器身份组成员
  • URL
  • 请求参数
  • 示例
  • cURL请求示例
  • 返回示例
  • 状态码
  • 分页查询用户所属的身份组
  • URL
  • 请求参数
  • 示例
  • cURL请求示例
  • 返回示例
  • 状态码