圈组

搜索服务器成员

更新时间: 2026/04/21 14:27:57

云信服务端提供 API,支持用户按照关键词搜索服务器成员。

请求 URL

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

请求参数

  • POST 请求中 Headers 的设置请参考 API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
accidString用户的 IM 帐号,如果传入校验该用户是否为服务器成员。
serverIdString服务器 ID。
keywordString搜索关键词。
limitLong本次搜索的数量上限,默认值喝最大值都为 100。

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk**lw0803mgq3" -H "Nonce: 4tggge**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9ab***6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&serverId=1513535&keyword=zhang&limit=10' 'https://api.yunxinapi.com/nimserver/qchat/searchServerMember.action'

返回参数

参数
类型 说明
code Integer 状态码。
- members Object 搜索到的用户信息。
serverId Long 服务器 ID。
accid String 成员的 IM 账号。
nick String 成员昵称。
avatar String 成员头像的 URL。
custom String 成员自定义扩展字段。
type Integer 成员类型:0-普通成员,1-服务器所有者。
joinTime Long 成员加入服务器的时间。
inviter String 该成员的邀请者的 IM 账号。
validFlag Integer 有效标志:0-无效,1-有效。如成员已不在服务器内,则为无效。
createTime Long 成员信息在数据库的创建时间。
updateTime Long 成员信息在数据库的更新时间。

返回示例

HTTP 响应:JSON

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "members": [{
            "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 对象不存在
  • 检查是否存在必传参数为空的问题
  • 检查传入的 IM 账号或服务器 ID 是否存在
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超限 降低调用频率
431 HTTP 重复请求 -
此文档是否对你有帮助?
有帮助
去反馈
  • 请求 URL
  • 请求参数
  • cURL 请求示例
  • 返回参数
  • 返回示例
  • 状态码