이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.

Add Gift Language Infomation

Feature Description
The App admin can use this API to add gift language info.
API Call Description
Sample Request URL
https://xxxxxx/v4/live_engine_http_srv/set_gift_language?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 the REST API introduction.
Parameter
Description
xxxxxx
SDKAppID resides in the country/region where the dedicated domain name is located.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
United States: adminapiusa.im.qcloud.com
v4/live_engine_http_srv/set_gift_language
API request.
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, 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",
    "Language":"en",
    "Name": "name1",
    "Desc": "desc1"
}
Request Packet Fields
Field
Type
Attribute
Description
GiftId
String
Required
Gift ID, longest 20 bytes, up to 3 gift categories.
Language
String
Required
Gift language type, now supported: "en", "zh-Hans", "zh-Hant".
Name
String
Required for first-time setup, optional for later settings
Default gift name, longest 20 bytes.
Desc
String
Optional.
Default gift description, longest 20 bytes.
Note:
1. Multiple settings of gift language info will only modify the field in-progress request. Fields not in request will not be modified.
2. When using SDK to obtain the gift and classification list under a specified language, if the language info is set up, return the corresponding information directly. Otherwise, return the default language info set when adding the gift.
Response Package Example
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 occurs (such as 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
Illegal request parameters. Check whether the request is correct according to the error description.
100006
Insufficient operational permissions. Admin account is required to perform the operation.
100012
Frequent calls, maximum call frequency 1/s.
102001
No payment information, purchase package in the console.

Parameter	Description
xxxxxx	SDKAppID resides in the country/region where the dedicated domain name is located. China: `console.tim.qq.com` Singapore: `adminapisgp.im.qcloud.com` United States: `adminapiusa.im.qcloud.com`
v4/live_engine_http_srv/set_gift_language	API request.
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, value ranges from 0 to 4294967295.
contenttype	The request format is fixed as `json`.

Field	Type	Attribute	Description
GiftId	String	Required	Gift ID, longest 20 bytes, up to 3 gift categories.
Language	String	Required	Gift language type, now supported: "en", "zh-Hans", "zh-Hant".
Name	String	Required for first-time setup, optional for later settings	Default gift name, longest 20 bytes.
Desc	String	Optional.	Default gift description, longest 20 bytes.

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 operational permissions. Admin account is required to perform the operation.
100012	Frequent calls, maximum call frequency 1/s.
102001	No payment information, purchase package in the console.