功能说明
App 管理员可以通过该接口在房间里模糊搜索成员。
请求 URL 示例
https://xxxxxx/v4/live_engine_http_srv/search_room_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 中国: console.tim.qq.com 新加坡: adminapisgp.im.qcloud.com 美国: adminapiusa.im.qcloud.com |
v4/live_engine_http_srv/search_room_member | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
2次/秒。
请求包示例
基础形式
{"RoomId":"search_test", //房间id"Keyword":"brennanli", //关键字搜索, 用户的账号昵称或者账号id, 账号昵称支持模糊搜索,账号id支持精确匹配"Next":"" //用于分页查询的参数, 用于指定下一页数据的起始位置, 首次请求时,Next 字段为空,每次请求后,服务器返回响应中的 Next 字段值。客户端需将该值作为下一次请求的 Next 参数, 直到 Next 为空才停止}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
RoomId | String | 必填 | 房间 ID |
Keyword | String | 必填 | 关键字匹配,可填写账号昵称或者账号 ID,其中账号昵称支持模糊搜索 |
Next | String | 必填 | 用于分页查询的参数,用于指定下一页数据的起始位置 |
注意:
该接口能力支持版本为:体验版 + LiveKit 大规模直播版,当前需要提单联系平台手动打开。
应答包体示例
基础形式
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-1ea25224fab7403f939986c2f7266ce2-O-Seq-1645192760","Response": {"Next": "","MemberList": [{"Member_Account": "brennanli1","NickName": "brennanliqbrennanliqbrennanliqbrennanliqbrennanliqbrennanliq"},{"Member_Account": "brennanli","NickName": "brennanli_nick"}]}}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
RequestId | String | 唯一请求 ID,每次请求都会返回, 定位问题时需要提供该次请求的 RequestId |
Next | String | 分页列表的参数,为空时候表示结束 |
MemberList | Array | 搜索到的成员信息列表 |
Member_Account | String | 成员的账号 ID |
NickName | String | 成员的账号昵称 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 含义说明 |
100001 | 服务器内部错误,请重试 |
100002 | 请参数非法,请根据错误描述检查请求是否正确 |
100007 | 当前付费套餐包不支持该能力 |