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

Get Gift

Feature Description
The App admin can use this API to query gift information.
API Calls
Sample Request URL
https://xxxxxx/v4/live_engine_http_srv/get_gift?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 is located in the country/region corresponding to the dedicated domain name:
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
USA: adminapiusa.im.qcloud.com
v4/live_engine_http_srv/get_gift
Request API.
sdkappid
The SDKAppID assigned by the Chat console when creating an application.
identifier
It must be an App administrator account. For more details, see app administrator.
usersig
The signature generated by the App administrator account. For details, see Generate UserSig.
random
Enter a random 32-bit unsigned integer, value ranges from 0 to 4294967295.
contenttype
The request format is fixed as json.
Maximum Calling Frequency
1 times/second.
Sample Request Packet
Basic form
{
    "GiftId" :  "GId1"
}
Request Packet Fields
Field
Type
Attribute
Description
GiftId
String
Required
Gift ID you want to query.
Response Package Example
Basic form
{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-a984952a5dde4b488caba4f75e5437b8-O-Seq-287281",
    "GiftInfo": {
        "GiftId": "GId1",
        "IconUrl": "https://www.xxx.com/xxx1.png",
        "ResourceUrl": "https://www.xxx.com/xxx2.png",
        "Coins": 10,
        "Level": 1,
        "ExtensionInfo": "{\"key\": \"value\"}",
        "DefaultName": "name1",
        "DefaultDesc": "desc1"
    }
}
Response Packet Fields
Field
Type
Description
ActionStatus
String
Request processing result. OK: processing successful; FAIL: processing failed.
ErrorCode
Integer
Error code: 0 indicates success, non-zero indicates failure.
ErrorInfo
String
Error message.
RequestId
String
Unique request ID, returned for each request. To troubleshoot a request, its RequestId should be provided.
GiftId
String
Gift ID.
IconURL
String
Gift thumbnail.
ResourceUrl
String
Gift resource link, such as full-screen special effect mp4 and svg resource links.
Coins
Integer
Gift price in virtual currency.
Level
Integer
Gift level.
ExtensionInfo
String
Gift custom extension information.
DefaultName
String
Default gift name.
DefaultDesc
String
Default gift description.
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 in the ErrorCode and ErrorInfo fields of 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
Illegal request parameters. Check whether the request is correct according to the error description.
100006
Insufficient operation permissions. Admin account is required.
100012
Frequent calls, maximum call frequency 1/s.
102001
No payment information, purchase package in the console.

Parameter	Description
xxxxxx	SDKAppID is located in the country/region corresponding to the dedicated domain name: China: `console.tim.qq.com` Singapore: `adminapisgp.im.qcloud.com` USA: `adminapiusa.im.qcloud.com`
v4/live_engine_http_srv/get_gift	Request API.
sdkappid	The SDKAppID assigned by the Chat console when creating an application.
identifier	It must be an App administrator account. For more details, see app administrator.
usersig	The signature generated by the App administrator account. For details, see Generate UserSig.
random	Enter a random 32-bit unsigned integer, value ranges from 0 to 4294967295.
contenttype	The request format is fixed as `json`.

Field	Type	Attribute	Description
GiftId	String	Required	Gift ID you want to query.

Error Code	Description
100001	Server internal error, please try again.
100002	Illegal request parameters. Check whether the request is correct according to the error description.
100006	Insufficient operation permissions. Admin account is required.
100012	Frequent calls, maximum call frequency 1/s.
102001	No payment information, purchase package in the console.