批量查询服务器成员信息
更新时间: 2024/07/17 17:57:35
云信服务端提供 API,支持传入用户的 IM 账号和对应的服务器 ID 查询用户是否在对应的服务器内。
URL
httpPOST https://api.netease.im/nimserver/qchat/getServerMembers.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8
请求参数
- POST 请求中 Headers 的设置请参考API调用方式。
- POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
serverIdAccids | JSON Array | 是 | “服务器ID | IM 账号”列表,JSON Array 格式,示例:["123|lisi","234|wangwu"] |
返回参数
参数 |
说明 |
---|---|
code | 状态码 |
serverMembers | 返回的服务器成员列表,具体字段说明参见“修改自己的成员信息”接口返回参数中的 serverMember 字段说明 |
示例
cURL 请求示例
curlcurl -X POST -H "AppKey: go9dnk49b**w0803mgq3" -H "Nonce: 4tggger**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverIdAccids=["123|lisi","234|wangwu"]' 'https://api.netease.im/nimserver/qchat/getServerMembers.action'
返回示例
HTTP 响应:JSON
json"Content-Type": "application/json; charset=utf-8"
{
"code":200,
"serverMembers": [
{
"serverId": 123,
"accid": "lisi",
"nick": "nick",
"avatar": "avatar",
"custom": "custom",
"type": 0,
"joinTime": 1234,
"inviter": "zhangsan",
"validFlag": 1,
"createTime": 1234,
"updateTime": 1234
},
{
"serverId": 123,
"accid": "lisi",
"nick": "nick",
"avatar": "avatar",
"custom": "custom",
"type": 0,
"joinTime": 1234,
"inviter": "zhangsan",
"validFlag": 1,
"createTime": 1234,
"updateTime": 1234
}
]
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务强相关的状态码。完整状态码请参见状态码。
状态码 | 说明 | 处理建议 |
---|---|---|
200 | 请求成功 | - |
403 | 非法操作或没有权限 | 检查是否已开通圈组功能 |
404 | 对象不存在 |
|
414 | 参数错误 | 根据提示信息,检查传入参数的格式和限制条件 |
416 | 调用频率超限 | 降低调用频率 |
431 | HTTP 重复请求 | - |
此文档是否对你有帮助?