功能说明
App 管理员可以通过该接口获取某个用户的收礼统计。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/live_engine_http_srv/get_gift_count?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/get_gift_count | 创建直播间接口 |
sdkappid | |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式,固定值为 json 。 |
最高调用频率
200次/秒。
请求包示例
基础形式
{"RoomId": "room_id","From_Account": "user1"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
RoomId | String | 必填 | 房间 ID。 |
From_Account | String | 必填 | 送礼人。 |
应答包体示例
基础形式
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720","Response": {"Sequence": 1,"TotalCount": 1,"TotalCoins": 1,"GiftSenderCount": 1}}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果。 OK 表示处理成功。 FAIL 表示失败。 |
ErrorCode | Integer | 错误码。 0:表示成功。 非0:表示失败。 |
ErrorInfo | String | 错误信息。 |
RequestId | String | 唯一请求 ID,每次请求都会返回,定位问题时需要提供该次请求的 RequestId。 |
TotalCount | Integer | 礼物总数。 |
TotalCoins | Integer | 礼物总价值。 |
GiftSenderCount | Integer | 送礼总人数。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 含义说明 |
100001 | 服务器内部错误,请重试。 |
100002 | 请求参数非法,请根据错误描述检查请求是否正确。 |
100003 | 房间 ID 已存在,请选择其他房间 ID。 |