1. 接口描述
接口请求域名: yinsuda.tencentcloudapi.com 。
充值直播会员,使该用户可以在直播场景使用
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RechargeLiveVip。 |
Version | 是 | String | 公共参数,本接口取值:2022-05-27。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
AppName | 是 | String | 应用名称。 示例值:app-test |
UserId | 是 | String | 用户标识。 示例值:d2w7m6t9z8 |
TradeSerialNo | 是 | String | 交易流水号,用于标记此次充值记录,多次充值记录传入相同的 TradeSerialNo 会判断为失败,可用于防止重提提交造成重复计费。 示例值:vvws7nzzxg |
RoomId | 是 | String | 房间标识。 示例值:vyg79z45nz |
VipDays | 是 | Integer | 充值会员天数。 取值有: 示例值:60 |
GiveType | 否 | String | 充值分类。取值有:room_card-包月房卡; 其他-保留。 示例值:room_card-包月房卡 |
PlayScene | 否 | String | 播放场景。默认为Live 示例值:Live |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
LiveVipUserInfo | LiveVipUserInfo | 直播会员信息。 示例值:{"RoomId": "awv5dis27j","LiveVipEndTime": " 2024-06-01T12:00:00Z","LiveVipStatus": "Valid"} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 充值直播会员
为用户充值直播会员
输入示例
POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RechargeLiveVip
<公共请求参数>
{
"AppName": "test",
"UserId": "test",
"TradeSerialNo": "TradeSerialNo1",
"RoomId": "123",
"VipDays": 31,
"GiveType": "room_card"
}
输出示例
{
"Response": {
"LiveVipUserInfo": {
"RoomId": "awv5dis27j",
"LiveVipEndTime": "2020-09-22T00:00:00+00:00",
"LiveVipStatus": "Valid"
},
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.DuplicateTradeSerialNo | 交易流水号重复 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |