tencent cloud

Add Gift Category Relationships
Download PDF
Last updated:2025-09-03 12:06:28
Add Gift Category Relationships
Last updated: 2025-09-03 12:06:28
Download PDF

Feature Description

The App admin can use this API to add the relationship between specified gift categories and gifts.

API Call Description

Sample Request URL

https://xxxxxx/v4/live_engine_http_srv/add_gift_category_relations?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
SDKAppID is located in the country/region with the 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_relations
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 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
{
    "CategoryId":"id1",
    "GiftIdList" :["id1","id2","id3"]
}

Request Packet Fields

Field
Type
Attribute
Description
CategoryId
String
Required
Gift category ID that needs to be added.
GiftIdList
Array
Required
Gift ID that needs to be added under the category.
Note:
This operation adds a new relationship on top of the existing one without overwriting the original gift category relationship.

Response Package Example

Basic form
{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-821589b588fb4df79e6a5fe8f0cb4519-O-Seq-289843"
}

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.
InvalidGiftIdList
Array
Unadded GiftId list. Delete these GiftIds from the request GiftIdList.

Error Code Description

Unless a network error (such as 502) occurs, the HTTP return code for 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
Illegal request parameters. Check whether the request is correct according to the error description.
100006
Insufficient operation permissions. Administrator account operations are needed.
100012
Call frequency is too high, with a maximum of 1 call/s.
102001
No payment information. Purchase a package in the console.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback