GetEffectList - 获取特效列表--视频点播-火山引擎

文档中心

立即注册

导航

GetEffectList - 获取特效列表

最近更新时间：2025.10.24 19:49:14首次发布时间：2025.10.24 19:49:14

调用 GetEffectList 接口获取特效列表。包含文字、转场、图标、音乐、滤镜等特效。

请求说明

请求方式：POST
请求地址：https://vod.volcengineapi.com?Action=GetEffectList&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetEffectList`	接口名称。当前 API 的名称为 `GetEffectList`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数	类型	是否必选	示例值	描述
Panel	String	是	`transition`	指定面板类型。支持的取值如下所示。 `transition` ：转场； `flower` ：花字； `specialeffects` ：特效； `effect` ：滤镜。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Version	String	`1698723716140,0,1010,1`	特效列表的版本。
Effects	Object[]	`-`	特效列表信息。
Name	String	`基础花字（渐变）`	特效名称。
Hint	String	`-`	特效的提示信息。
SdkVersion	String	`4.0.0`	特效所需的最低 SDK 版本。
AppVersion	String	`1.0.0`	特效所需的最低应用版本号。
FileUrl	Object	`-`	特效文件的 URL 信息。
Uri	String	`c1e7c6302e773e5196d6c3f72216xxxx`	特效文件的唯一标识。
UrlList	String[]	`-`	可访问的 URL 列表。
IconUrl	Object	`-`	特效图标的 URL 信息。
Uri	String	`4d5c707800f37b64f35c28a15125xxxx`	图标的唯一标识。
UrlList	String[]	`-`	可访问 URL 列表。
Id	String	`c1e7c6302e773e5196d6c3f72216xxxx`	剪辑工程 ID。
EffectId	String	`27730518`	特效 ID。
DevicePlatform	String	`all`	特效支持的设备平台。 `all` 表示支持所有平台。
Types	String[]	`[]`	特效的类型列表。
Tags	String[]	`[]`	特效的标签列表。
TagsUpdatedAt	String	`1619170920000`	特效标签的最后更新时间，格式为时间戳。
EffectType	Integer	`0`	特效的类型标识。
Parent	String	`-`	当前特效的父级特效 ID。
Children	String[]	`[]`	当前特效的子特效 ID 列表。
HintIcon	Object	`-`	特效提示图标的 URL 信息。
Uri	String	`4d3c707800f37b64f35c28a15125xxxx`	图标的唯一标识。
UrlList	String[]	`-`	可访问 URL 列表。
Music	String[]	`[]`	特效关联的音乐资源 ID 列表。
Source	Integer	`0`	特效来源标识。
DesignerId	String	`27730211`	特效的设计者 ID。
Schema	String	`{"type":"object","properties":{"text":{"type":"string","description":"特效文本内容"},"color":{"type":"string","description":"文本颜色"}},"required":["text"]}`	特效的 Schema 定义。
Description	String	`-`	特效的详细描述信息。
OriginalEffectId	String	`27730518`	特效的原始 ID。
IsFavorite	Boolean	`false`	当前特效是否被用户收藏。 `true` ：用户已收藏； `false` ：用户未收藏。
Subtype	Integer	`0`	特效的子类型。
Requirements	String[]	`["requires_android_10","requires_gpu_support"]`	特效的使用要求或依赖条件列表。
Extra	String	`-`	额外信息。
IsBusiness	Boolean	`false`	当前特效是否为商业特效。 `true`：商业特效； `false`：非商业特效。
Countrys	String[]	`["CN","US","JP"]`	特效支持的国家或地区列表，使用 ISO 3166-1 标准国家/地区代码表示。
PoiId	String	`0`	特效关联的兴趣点 ID。
IsPoi	Boolean	`false`	当前特效是否为兴趣点（POI）特效。 `true`：是兴趣点特效； `false`：非兴趣点特效。
DesignerEncryptedId	String	`encrypted_designer_123456789`	特效设计者的加密 ID。
SdkExtra	String	`{"isEHEffect":false,"triggerJson":null}`	SDK 相关的额外信息。
SyncId	Integer	`27730518`	特效同步 ID。
ResourceId	Integer	`7295962639253902xxx`	特效关联的资源 ID。
AdRawData	String	`{"adId":"12345","campaign":"summer_sale","creative":"banner_728x90"}`	特效的广告原始数据。
Channel	Integer	`0`	特效所属的渠道。
BindIds	String[]	`["resource_123","resource_456"]`	特效关联的资源 ID 列表。
PublishStatus	Integer	`1`	特效的发布状态。 `1` ：已发布； `0` ：未发布。
Ptime	Integer	`0`	特效的发布时间。
GradeKey	String	`premium`	特效的等级。
ComposerParams	String	`{"text":"Hello World","color":"#FF0000","fontSize":24,"animation":"fadeIn"}`	特效的合成参数。
Panel	String	`flower`	特效所属的面板。
ChallengeId	Integer	`0`	关联的挑战 ID。
ModelNames	String	`-`	关联的模型名称。
HintFileFormat	Integer	`1`	提示文件的格式。
HintFile	Object	`-`	提示文件信息。
Uri	String		提示文件的唯一标识符。
UrlList	String[]		可访问 URL 列表。
IsEst	Boolean	`false`	当前特效是否为 EST 特效。 `true`：是 EST 特效； `false`：非 EST 特效。
AppID	Integer	`1154`	关联的应用 ID。
OriginalExtra	String	`-`	原始额外信息。
HasProfileInfo	Boolean	`false`	当前特效是否包含用户画像信息。 `true`：包含用户画像信息； `false`：不包含用户画像信息。
Category	Object[]	`-`	特效的分类。
Id	String	`32653`	特效 ID。
Name	String	`基础文字`	特效名称。
Icon	Object	`-`	特效分类图标。
Uri	String		图标的唯一标识符。
UrlList	String[]		可访问 URL 列表。
IconSelected	Object	`-`	特效分类被选中时显示的图标。
Uri	String		图标的唯一标识符。
UrlList	String[]		可访问 URL 列表。
Effects	String[]	`["27730518","27730519","27730520"]`	分类下的特效 ID 列表。
Tags	String[]	`["热门","推荐","新品"]`	特效分类的标签列表。
TagsUpdatedAt	String	`1626600135000`	特效分类标签的最后更新时间，格式为时间戳。
Key	String	`basetext`	特效分类的唯一标识键。
IsDefault	Boolean	`false`	当前特效分类是否为默认分类。 `true`：是默认分类； `false`：非默认分类。
Extra	String	`{}`	特效分类的额外信息。
FrontEffectId	String	`27730518`	前置特效 ID。
RearEffectId	String	`27730519`	后置特效 ID。
Panel	Object	`-`	特效所属的面板信息。
Text	String	`基础花字特效面板`	面板的文本描述。
Icon	Object	`-`	面板的图标。
Uri	String	`4d5c707800f37b64f35c28a15125xxxx`	图标的唯一标识符。
UrlList	String[]	`[]`	可访问的 URL 列表。
Tags	String[]	`[]`	面板的标签列表。
TagsUpdatedAt	String	`1619170910000`	面板标签的最后更新时间，格式为时间戳。
Extra	String	`-`	面板的额外信息。
Collection	String[]	`[]`	用户收藏的特效 ID 列表。
UrlPrefix	String[]	`[]`	用于访问特效资源的 URL 前缀列表。

请求示例

POST https://vod.volcengineapi.com?Action=GetEffectList&Version=2018-01-01
{
  "Panel": "transition"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetEffectList",
        "Version": "2018-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Version": "1698723716140,0,1010,1",
        "Effects": [
            {
                "Name": "基础花字（渐变）",
                "Hint": "",
                "SdkVersion": "4.0.0",
                "AppVersion": "",
                "FileUrl": {
                    "Uri": "c1e7c6302e773e5196d6c3f72216xxxx",
                    "UrlList": [
                        ""
                    ]
                },
                "IconUrl": {
                    "Uri": "4d5c707800f37b64f35c28a15125b4d6",
                    "UrlList": [
                        ""
                    ]
                },
                "Id": "c1e7c6302e773e5196d6c3f72216xxxx",
                "EffectId": "27730518",
                "DevicePlatform": "all",
                "Types": [
                    ""
                ],
                "Tags": [
                    ""
                ],
                "TagsUpdatedAt": "",
                "EffectType": 0,
                "Parent": "",
                "Children": [
                    ""
                ],
                "HintIcon": {
                    "Uri": "",
                    "UrlList": [
                        ""
                    ]
                },
                "Music": [
                    ""
                ],
                "Source": 0,
                "DesignerId": "",
                "Schema": "",
                "Description": "",
                "OriginalEffectId": "",
                "IsFavorite": true,
                "Subtype": 0,
                "Requirements": [
                    ""
                ],
                "Extra": "",
                "IsBusiness": true,
                "Countrys": [
                    ""
                ],
                "PoiId": "0",
                "IsPoi": false,
                "DesignerEncryptedId": "",
                "SdkExtra": "{\"isEHEffect\":false,\"triggerJson\":null}",
                "SyncId": 27730518,
                "ResourceId": 7295962639253902xxx,
                "AdRawData": "",
                "Channel": 0,
                "BindIds": [
                    ""
                ],
                "PublishStatus": 1,
                "Ptime": 0,
                "GradeKey": "",
                "ComposerParams": "",
                "Panel": "flower",
                "ChallengeId": 0,
                "ModelNames": "",
                "HintFileFormat": 0,
                "HintFile": {
                    "Uri": "",
                    "UrlList": [
                        ""
                    ]
                },
                "IsEst": false,
                "AppID": 1154,
                "OriginalExtra": "",
                "HasProfileInfo": true
            }
        ],
        "Category": [
            {
                "Id": "32653",
                "Name": "基础文字",
                "Icon": {
                    "Uri": "",
                    "UrlList": [
                        ""
                    ]
                },
                "IconSelected": {
                    "Uri": "",
                    "UrlList": [
                        ""
                    ]
                },
                "Effects": [
                    ""
                ],
                "Tags": [
                    ""
                ],
                "TagsUpdatedAt": "1626600135000",
                "Key": "basetext",
                "IsDefault": false,
                "Extra": "{}"
            }
        ],
        "FrontEffectId": "",
        "RearEffectId": "",
        "Panel": {
            "Text": "",
            "Icon": {
                "Uri": "",
                "UrlList": [
                    ""
                ]
            },
            "Tags": [
                ""
            ],
            "TagsUpdatedAt": "1619170910000",
            "Extra": ""
        },
        "Collection": [
            ""
        ],
        "UrlPrefix": [
            ""
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。