按需查询直播间信息，包括直播状态等直播间基础信息、外观主题等直播间基础配置、直播间内各直播频道的推拉流信息及直播间在线人数。

注意事项

• 请求频率：单用户请求频率限制为 120 次/分钟。
• 前提条件：确保您拥有火山引擎主账号或具备直播间的观看页管理 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

• 请求方式：GET
• 请求地址：https://livesaas.volcengineapi.com/?Action=GetCustomActMsgAPI&Version=2020-06-01

请求参数

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

Query

返回参数

ActMsg

ActBasicMsg

ActStreamMsg

RealTimeOnlineNumber

SiteTags

TextSiteTags

LineDetails

MainPushInfo

BackPushInfo

ForwardInfo

BackupForwardInfo

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetCustomActMsgAPI&Version=2020-06-01&ActivityId=172183460671&NeedActMsg=1&NeedActBasicMsg=1&NeedActStreamMsg=1&NeedRealTimeOnlineNumber=1

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetCustomActMsgAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "ActMsg": {
            "Id": 172183460671,
            "Name": "直播间 A",
            "LiveTime": 1642070520,
            "CoverImage": "https://image1.xxx",
            "Status": 2,
            "ViewUrl": "https://live.xxx.com/xxx",
            "IsLockPreview": 0,
            "OwnerSubAccount": "admin@bytedance.com",
            "LiveReviewStatus": 2,
            "VerticalCoverImage": "https://image2.xxx"
        },
        "ActBasicMsg": {
            "ActivityId": 172183460671,
            "Name": "直播间 A",
            "LiveTime": 1642070520,
            "IsCoverImageEnable": 1,
            "CoverImageUrl": "//gjrfd7ferd-image.image",
            "IsPcBackImageEnable": 1,
            "PcBackImageUrl": "//p-imagex-live18n.test.org/tos-live18n-i-fhdptwgppv.png",
            "IsMobileBackImageEnable": 1,
            "MobileBackImageUrl": "//p-imagex-live18n.test.org/tos-live18n-i-fhdptwgppv.png",
            "IsPreviewVideoEnable": 1,
            "PreviewVideoVid": "491568852",
            "IsPeopleCountEnable": 0,
            "IsHeaderImageEnable": 0,
            "HeaderImageUrl": "//p.test.org/tos-live18n-i-fhdptwgppv.png",
            "IsWatermarkImageEnable": 0,
            "WatermarkImageUrl": "//p-imagex.org/tos-live18n-i-fhdptwgppv.png",
            "IsThumbUpEnable": 1,
            "ThumbUpUrl": "//p-imagex.png",
            "IsShareIconEnable": 1,
            "ShareIconUrl": "//p-imagex-live18n.test.org/tos-live18n-i-fhdptwgppv.pn",
            "IsCommentTranslateEnable": null,
            "Announcement": "直播间信息",
            "BackgroundColor": "77778888",
            "FontColor": "55557777",
            "InteractionColor": "45784444",
            "ColorThemeIndex": "light",
            "IsCountDownEnable": 1,
            "IsAutoStartEnable": 1,
            "IsPCHeaderImageEnable": 1,
            "PCHeaderImageUrl": "//p-imagex-fhdptwgppv.pn",
            "IsPageLimitEnable": 1,
            "PageLimitType": "pc",
            "IsLanguageEnable": 1,
            "PlayerTopType": [
                ""
            ],
            "IsReplayAutoOnlineEnable": 1,
            "SiteTags": [
                {
                    "Name": "分类标签",
                    "Value": "标签1",
                    "Index": 0
                }
            ],
            "TextSiteTags": [
                {
                    "Name": "文本标签",
                    "Value": "标签2",
                    "Index": 0
                }
            ]
        },
        "ActStreamMsg": {
            "LineDetails": [
                {
                    "LineId": 123,
                    "LineName": "线路1",
                    "MainPushInfo": [
                        {
                            "PushPath": "https://example-livesaas.com/example",
                            "PushUrl": "https://example-livesaas.com/example/livesaas?key=example",
                            "StreamingCode": "livesaas?key=example"
                        }
                    ],
                    "BackPushInfo": [
                        {
                            "PushPath": "https://example2-livesaas.com/example2",
                            "PushUrl": "https://example2-livesaas.com/example/livesaas?key=example2",
                            "StreamingCode": "livesaas?key=example2"
                        }
                    ],
                    "ForwardInfo": [
                        {
                            "PullStreamUrl": "https://example-livesaas.com/example/livesaas?key=example",
                            "PullStreamStatus": "1",
                            "PullStreamCheckStatus": "1"
                        }
                    ],
                    "BackupForwardInfo": [
                        {
                            "PullStreamUrl": "https://example2-livesaas.com/example/livesaas?key=example2",
                            "PullStreamStatus": "1",
                            "PullStreamCheckStatus": "1"
                        }
                    ],
                    "ExpireTime": 1643004493
                }
            ]
        },
        "RealTimeOnlineNumber": {
            "RealPopularity": 2000,
            "FakePopularity": 2000
        }
    }
}

错误码

访问公共错误码和错误码获取详细信息。