You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

获取直播间直播转推详情

最近更新时间：2024.04.02 13:37:23

首次发布时间：2024.04.02 13:37:23

我的收藏

通过本接口，您可以获取指定直播间的直播转推详细信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：GET
  • 请求地址：https://livesaas.volcengineapi.com/?Action=GetActivityLiveLivePromotionDetail&Version=2023-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetActivityLiveLivePromotionDetail接口名称。当前 API 的名称为 GetActivityLiveLivePromotionDetail。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
ActivityIdLong是17927291817616直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
StartTimeLong否1710936000查询起始时间。Unix 时间戳，单位为秒。默认取值为当前时间 - 30 天（2,592,000 秒）。默认查询近 30 天的转推数据。
EndTimeLong否1710938000查询结束时间。Unix 时间戳，单位为秒。默认取值为当前时间。默认查询近 30 天的转推数据。

AppPlatformType

String

否

kuaishou

转推平台类型。默认获取所有转推平台的数据。支持以下取值：

  • aweme：抖音
  • kuaishou：快手
  • shipinhao：视频号
  • weibo：微博
  • bilibili：B站
  • youtube：YouTube
  • facebook：Facebook
  • twitter：Twitter
  • others：其他平台

AppPlatformName

String

否

快手

根据转推平台名称进行筛选。最多支持输入 100 个字符。支持模糊查询，且英文字母区分大小写。
例如，AppPlatformName 取值为 abc 时，则返回转推平台名称为 平台abc、abcd、aabcd 等包含 abc 关键词的转推平台列表。

PageSizeInteger否10分页查询数量。取值范围为 [1,100]，默认取值为 10。
PageNumberInteger否1分页查询页码，默认取值为 1。

返回参数

参数类型示例值描述
PageSizeInteger10分页查询数量。
PageNumberInteger1分页查询页码。
DetailListArray of DetailList-直播间转推信息列表。
TotalCountLong1查询结果总数。

DetailList

参数类型示例值描述
PlatformNameString快手转推平台名称。
PlatformTypeStringkuaishou转推平台类型。

PushStatus

Integer

1

转推状态。支持以下取值：

  • 1：转推成功
  • 2：转推失败
  • 3：转推中
PushStartTimeLong1710936762实际转推开始时间，无论是否转推成功。Unix 时间戳，单位为秒。
PushEndTimeLong1710936908实际转推结束时间，无论是否转推成功。Unix 时间戳，单位为秒。取值为 0 表示转推中或转推失败。

UseAppTemplate

Boolean

true

直播间是否使用 VolcLive 应用或 Android/iOS 开播 SDK 的挂件或图层（包括直播模板中的挂件和图层）功能进行装修。有关如何使用挂件和图层功能，详见手机开播和 SDK 概览。支持以下取值：

  • true：是
  • false：否

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityLiveLivePromotionDetail&Version=2023-08-01&ActivityId=17927291817616

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024040209205532B72B98C9B9F00E715E",
        "Action": "GetActivityLivePromotionDetail",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1712020855
    },
    "Result": {
        "PageSize": 10,
        "PageNumber": 1,
        "TotalCount": 1,
        "DetailList": [
            {
                "PlatformName": "快手",
                "PlatformType": "kuaishou",
                "PushStatus": 1,
                "PushStartTime": 1710936762,
                "PushEndTime": 1710936908,
                "UseAppTemplate": true
            }
        ]
    }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码错误码错误信息说明
400InvalidParameter.InvalidAppPlatformNameThe specified parameter AppPlatformName is invalid.PlatformName 参数超过最大 100 个字符限制。请修改后重试。
400InvalidParameter.InvalidTimeRangeThe specified time range is invalid.查询时间范围错误。请修改后重试。