tencent cloud

Add Gift Category Language Infomation
Download PDF
Last updated:2025-09-03 14:30:11
Add Gift Category Language Infomation
Last updated: 2025-09-03 14:30:11
Download PDF

Feature Description

The App admin can use this API to add designated gift category language info.

API Call Description

Sample Request URL

https://xxxxxx/v4/live_engine_http_srv/set_gift_category_language?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
SDKAppID resides in the country/region corresponding to 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/set_gift_category_language
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
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",
    "Language":"en",
    "CategoryName": "name",
    "CategoryDesc": "desc"
}

Request Packet Fields

Field
Type
Attribute
Description
CategoryId
String
Required
Gift category ID.
Language
String
Required
Gift category language types, now supported are "en", "zh-Hans", "zh-Hant".
CategoryName
String
Required for first-time setup, optional for later settings.
Gift category name in the current language.
CategoryDesc
String
Optional.
Gift category description in the current language.
Note:
1. Multiple settings of gift category language info will only modify fields in request. Fields not in request will not be modified.
2. When using the SDK to get the gift and gift classification list in a specified language, if the info for this language is set up, return the corresponding information directly. Otherwise, return the default language info set during gift category addition.

Sample Response Packet Body

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. RequestId is required for locating a problem.

Error Code Description

Unless a network error (such as 502) occurs, this API's HTTP return code is 200. The actual error code and error information are indicated in the ErrorCode and ErrorInfo 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
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