云直播查询直播云端特效列表

1. 接口描述

接口请求域名： live.tencentcloudapi.com 。

使用该接口查询云端特效列表，特效列表中包含一部分官方精品特效，同时包含用户自定义生成的特效。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeLiveCloudEffectList。
Version	是	String	公共参数，本接口取值：2018-08-01。
Region	否	String	公共参数，本接口不需要传递此参数。
Id	否	String	云端特效ID。示例值：1552
Prompt	否	String	云端特效描述词。由用户原始输入的描述词。示例值：小熊
Flag	否	String	云端特效标签。对云端特效进行分类标签，可用于分类搜索。示例值：动物
Type	否	String	云端特效类型, 默认不填，返回全部。PGC: 特效库中的特效；AICG : AI生成的特效；UGC：用户自定义上传的特效；示例值：UGC

3. 输出参数

参数名称	类型	描述
InfoList	Array of CloudEffectInfo	云端特效信息列表。
EnableCreateNum	Integer	允许创建的云端特效个数。示例值：100
TotalNum	Integer	当前已有的特效总个数。示例值：30
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host:live.tencentcloudapi.com
Content-Type:application/json
X-TC-Action: DescribeLiveCloudEffectList
<公共请求参数>

{
    "Prompt": "小狗"
}

输出示例

{
    "Response": {
        "RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e",
        "EnableCreateNum": 100,
        "TotalNum": 30,
        "InfoList": [
            {
                "Id": "1001",
                "Prompt": "小狗",
                "Flag": "动物",
                "Status": "FINISH",
                "PreviewImageUrl": "http://preview.image.com/pic.jpg",
                "Type": "PGC",
                "CreateTime": "2025-05-19T00:00:00Z",
                "UpdateTime": "2025-05-20T00:00:00Z"
            }
        ]
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.CallOtherSvrFailed	调用内部服务失败。
InternalError	内部错误。
InternalError.CallOtherSvrError	调用内部服务错误。
InternalError.ConfigNotExist	配置不存在。
InternalError.GetBizidError	获取用户账号错误。
InternalError.GetStreamInfoError	获取流信息失败。
InternalError.GetUpstreamInfoError	获取直播源信息错误。
InternalError.NotPermmitOperat	无权限操作。
InternalError.StreamStatusError	流状态异常。
InternalError.UpdateDataError	更新数据失败。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
ResourceNotFound.ForbidService	用户被禁用。
ResourceNotFound.FreezeService	用户服务被冻结。
ResourceNotFound.StopService	账号停服，请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService	用户主动停服。
ResourceNotFound.UserNotExist	用户未注册直播。

查询直播云端特效列表

本页目录：