查询广告插入配置

最近更新时间:2026-04-08 02:23:36

我的收藏

1. 接口描述

接口请求域名: mps.tencentcloudapi.com 。

查询广告插入配置。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeStreamPackageSSAIChannel。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-shanghai 。
ID String 广告插入配置ID。
示例值:654CA8EF0000CE02BXXX

3. 输出参数

参数名称 类型 描述
Info SSAIChannelInfo 广告插入配置信息。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询广告插入配置

查询广告插入配置

输入示例

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

{
    "ID": "654CA8EF0000CE02BXXX"
}

输出示例

{
    "Response": {
        "Info": {
            "ID": "654CA8EF0000CE02BXXX",
            "Name": "TestConf",
            "ContentSource": "http://origin-server.com/abc/",
            "PlaybackPrefix": "http://xxx.ap-mumbai.streampackage.srclivepull.myqcloud.com/v1/ssai/master/0194d961674a1eb4611d3xxxxxx/",
            "SSAIInfo": {
                "AdsUrl": "https://my.ads.com/path?ad_type=[player_params.ad_type]&region=[player_params.region]",
                "ConfigAliases": [
                    {
                        "ParamName": "region",
                        "AliasValueList": [
                            {
                                "Alias": "india",
                                "Value": "ap-mumbai"
                            }
                        ]
                    }
                ],
                "AdMarkerPassthrough": true,
                "Threshold": 12,
                "SlateAd": "https://hostname/xxx/xxx.mp4",
                "SCTE35AdType": 1,
                "AdTriggers": [
                    1
                ],
                "DeliveryRestrictions": 1,
                "SourceCDNPrefix": "https://example_cdn.com/",
                "AdCDNPrefix": "https://example_ad_cdn.com/",
                "DashMPDLocation": false
            }
        },
        "RequestId": "0xxxxd32-1043-4e1b-bd20-1bfad0xxxx70"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter.AuthInfo InvalidParameter.AuthInfo
InvalidParameter.ExceededQuantityLimit InvalidParameter.ExceededQuantityLimit
InvalidParameter.Id InvalidParameter.Id
InvalidParameter.Name InvalidParameter.Name
InvalidParameter.NotFound InvalidParameter.NotFound
InvalidParameter.SSAIInfo InvalidParameter.SSAIInfo