tencent cloud

Get Gift Category
Download PDF
Last updated:2025-09-03 12:01:26
Get Gift Category
Last updated: 2025-09-03 12:01:26
Download PDF

Feature Description

The App admin can use this API to retrieve specified gift classification information.

API Call Description

Sample Request URL

https://xxxxxx/v4/live_engine_http_srv/get_gift_category?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table lists only the parameters involved in modification and their descriptions when calling this API. For more details about the parameters, please refer to REST API Introduction.
Parameter
Description
xxxxxx
Country/region where the SDKAppID resides: dedicated domain name
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
United States: adminapiusa.im.qcloud.com
v4/live_engine_http_srv/get_gift_category
Request API.
sdkappid
The SDKAppID assigned by the Chat console when creating an application.
identifier
Must be an App administrator account. For more details, see App administrator.
usersig
The signature generated by the App administrator account. For specific operations, see Generate UserSig.
random
Enter a random 32-bit unsigned integer in the range of [0, 4294967295].
contenttype
The request format is fixed as json.

Maximum Calling Frequency

1 times/second.

Sample Request Packet

Basic form

{
    "CategoryId":"CId2"
}

Request Packet Fields

Field
Type
Attribute
Description
CategoryId
String
Required
The gift category ID you want to query.

Response Payload Example

Basic form
{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-205381db557a47bc93d6faa14d17dfeb-O-Seq-316720",
    "GiftCategoryInfo": {
        "CategoryId": "CId2",
        "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-0 indicates failure.
ErrorInfo
String
Error message.
RequestId
String
Unique request ID, returned for each request. RequestId is required for locating a problem.
CategoryId
String
Gift category ID.
ExtensionInfo
String
Custom extension information.
DefaultName
String
Default gift name.
DefaultDesc
String
Default gift description.

Error Code Description

Unless a network error occurs (for example, 502 error), 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
The request parameters are illegal. 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 is 1/s.
102001
No payment information. Purchase package in the console.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback