tencent cloud

Mobile Live Video Broadcasting

Release Notes and Announcements
TUILiveKit Release Notes
Live SDK Release Notes
User Guide
Product Introduction
Overview
Strengths
Performance Statistics
Concepts
Purchase Guide
TRTC Live Billing Overview
Billing of Video Live Component
Activating the Service (TUILiveKit)
Free Demo
Demo
Run Demo（TUILiveKit）
Integration Guide
Video Live Streaming
Preparation
Host Live Streaming
Audience Viewing
Live Stream List Live Stream List
Voice Chat Room
Preparation
Host Live Streaming
Audience Viewing
Live Stream List
Live Streaming Kit
Live Streaming Kit（Electron Desktop Application）
Live Streaming Kit（Web Desktop Browser）
Live Broadcast Monitoring
Monitoring Webpage （Web Desktop Browser React）
Monitoring Webpage （Web Desktop Browser Vue）
UI Customization
Live Stream Video Component
Video Source Editing Canvas
Audience List Component
Barrage Component
Media Source Configuration Panel
Link Management Panel
Live Gift Component
No UI Integration
Video Live Streaming
Voice Chat Room
Feature Guide
Follow Anchors (TUILiveKit)
Ultimate Image Quality (TUILiveKit)
Push Media Stream Into Room (TUILiveKit)
Gift System (TUILiveKit)
Client APIs
Android
iOS
Web
Server APIs (TUILiveKit)
Account System
REST API
Third-Party Webhooks
Error Codes (TUILiveKit)
FAQs
Platform Compilation
User Authentication
Live SDK
Product Introduction
Purchase Guide
Free Demo
Free Trial License
SDK Download
Licenses
Advanced Features
Client API
FAQs
Integration (No UI)
API Documentation
OSS information
OSS Attribution Notice
DokumentasiMobile Live Video BroadcastingServer APIs (TUILiveKit)REST APIGift ManagementAdd Gift

Add Gift

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-03-11 13:10:05

Feature Description

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

API Call Description

Sample Request URL

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

Request Parameters

The table below only lists the parameters modified when this interface is called. For more details on other parameters, please refer to RESTful API Overview.
Parameter
Description
xxxxxx
The reserved domain for the country/region where the SDKAppID is located:
Others in China: console.tim.qq.com
Singapore : adminapisgp.im.qcloud.com
United States: adminapiusa.im.qcloud.com
v4/live_engine_http_srv/add_gift
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
Must be an App admin account. For more details, see App Admin
usersig
The signature generated by the App admin account. For specific operations, see Generating UserSig
random
A random 32-bit unsigned integer ranging from 0 to 4294967295
contenttype
Request format fixed value: json

Maximum Calling Frequency

1 time/second.

Sample Request Packet

Basic form
{
    "GiftId" :  "GId1",                   
    "IconUrl" :"https://www.xxx.com/xxx1.png",
    "ResourceUrl" : "https://www.xxx.com/xxx2.png",                    
    "Coins" : 10,
    "Level" : 1,
    "ExtensionInfo" : "{\\"key\\": \\"value\\"}",
    "DefaultName" :"",
    "DefaultDesc" : ""
}

Request Packet Fields

Field
Type
Attribute
Description
GiftId
String
Required
Gift ID, longest 20 bytes.
IconUrl
String
Optional.
Gift thumbnail, longest 200 bytes.
ResourceUrl
String
Optional.
Gift resource URL, for example full-screen special effect mp4, svg resource URL, longest 200 bytes.
Coins
Integer
Required
The virtual currency price of the gift.
Level
Integer
Optional.
Gift level, defaults to 0 if left blank.
ExtensionInfo
String
Optional.
Custom extension information for gifts must be in JSON string format, with a maximum of 100 bytes.
DefaultName
String
Required
Default gift name, maximum 20 bytes.
DefaultDesc
String
Optional.
Default gift description, maximum 20 bytes.

Response Package Example

Basic form
{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-fecb13a5827b425d9be4b9c79ac10f67-O-Seq-284018"
}

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), the HTTP return code of this API is 200. The actual error code and error information are in the ErrorCode and ErrorInfo fields of the response payload.
Common error codes (60000 to 79999), please refer to the Error Code document.
The 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
Call frequency is too high. The maximum gift addition call frequency is 1/s.
102006
The gift quantity limit is exceeded.
102001
No payment information. Purchase package in the console.

Topik sebelumnya: Default Gift ConfigTopik selanjutnya: Get Gift

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan