このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

Get Gift Statistics

Feature Description
The App admin can use this API to retrieve gift statistics for a specific user.
API Call Description
Sample Request URL
https://xxxxxx/v4/live_engine_http_srv/get_gift_count?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The following table lists only the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, please refer to REST API introduction.
Parameter
Description
xxxxxx
SDKAppID's dedicated domain name where it is located:
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
United States: adminapiusa.im.qcloud.com
v4/live_engine_http_srv/get_gift_count
Create live streaming room API
sdkappid
The SDKAppID assigned by the Chat console when creating an application can be obtained from the application card in the Console of Chat.
identifier
Must be an application admin account. For more details, see the documentation Application Administrator.
usersig
The signature generated by the application admin account. For specific operations, see Generate UserSig.
random
Enter a random 32-bit unsigned integer, value ranges from 0 to 4294967295.
contenttype
Request format, the value is fixed as json.
Maximum Calling Frequency
200 times/second.
Sample Request Packet
Basic form
{
    "RoomId": "room_id",
    "From_Account": "user1",
}
Request Packet Fields
Field
Type
Attribute
Description
RoomId
String
Required
room ID
From_Account
String
Required
Gift sender
Response Package Example
Basic form
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720",
  "Response": {
    "Sequence": 1,
    "TotalCount": 1,
    "TotalCoins": 1,
    "GiftSenderCount": 1,
  }
}
Response Packet Fields
Field
Type
Description
ActionStatus
String
Request processing result.
OK: processing successful.
FAIL: processing failed.
ErrorCode
Integer
Error Code.
0: success.
Non-zero: Indicates Failure.
ErrorInfo
String
Error message.
RequestId
String
Unique request ID, returned for each request. To locate a problem, the RequestId of the request should be provided.
TotalCount
Integer
gift total quantity
TotalCoins
Integer
Total gift value
GiftSenderCount
Integer
Total number of gift senders
Error Code Description
Unless a network error (such as 502) occurs, the HTTP return code of this API is 200. The actual error code and error information are indicated by ErrorCode and ErrorInfo in the response payload.
Common error codes (60000 to 79999), please refer to the Error Code document.
Private error codes of this API are as follows:
Error Code
Description
100001
Server internal error, please try again.
100002
Invalid parameter. Check whether the request is correct according to the error description.
100003
The room ID already exists. Please select another room ID.
﻿

Parameter	Description
xxxxxx	SDKAppID's dedicated domain name where it is located: China: `console.tim.qq.com` Singapore: `adminapisgp.im.qcloud.com` United States: `adminapiusa.im.qcloud.com`
v4/live_engine_http_srv/get_gift_count	Create live streaming room API
sdkappid	The SDKAppID assigned by the Chat console when creating an application can be obtained from the application card in the Console of Chat.
identifier	Must be an application admin account. For more details, see the documentation Application Administrator.
usersig	The signature generated by the application admin account. For specific operations, see Generate UserSig.
random	Enter a random 32-bit unsigned integer, value ranges from 0 to 4294967295.
contenttype	Request format, the value is fixed as `json`.

Field	Type	Attribute	Description
RoomId	String	Required	room ID
From_Account	String	Required	Gift sender

Error Code	Description
100001	Server internal error, please try again.
100002	Invalid parameter. Check whether the request is correct according to the error description.
100003	The room ID already exists. Please select another room ID.