tencent cloud

Add Gift Category
Download PDF
Last updated:2026-01-16 21:49:41
Add Gift Category
Last updated: 2026-01-16 21:49:41
Download PDF

Feature Description

App admin can use this API to add gift classification information.

API Call Description

Sample Request URL

https://xxxxxx/v4/live_engine_http_srv/add_gift_category?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 its description. 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/add_gift_category
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 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",
    "ExtensionInfo":"{\\"key\\": \\"value\\"}",
    "DefaultName":"name1",
    "DefaultDesc" : "desc1"
}

Request Packet Fields

Field
Type
Attribute
Description
CategoryId
String
Required
Gift category ID, longest 20 bytes, set up to 3 gift categories.
ExtensionInfo
String
Optional.
Custom extension information must be a string in JSON format, longest 100 bytes.
DefaultName
String
Required
Default gift name, longest 20 bytes.
DefaultDesc
String
Optional.
Default gift description, longest 60 bytes.

Sample Response Packet

Basic form
{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-9d167940547545dfa63d9151288d0e83-O-Seq-285390"
}

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.

Error Code Description

Unless a network error occurs (such as 502), this API's HTTP return code 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.
100006
Insufficient operation permissions. Administrator account operations needed.
100012
Frequent calls. Maximum call frequency is 1/s.
102007
Exceeding gift category quantity limit.
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