回调内容说明

当直播域名配置完成回调功能后，关联事件触发时将以主动发送请求到业务服务器的方式，将含直播事件回调信息的 JSON 数据包发送给业务服务器。

网络协议

• 请求：通过 HTTP 接口向业务服务器发送 POST 请求，包体内容格式为 JSON，每一种消息的包体内容详情请参见回调内容。
• 应答：通过 HTTP 接口的状态码 200 接收接口返回结果，火山引擎服务端会忽略应答包内的具体内容。

请求可靠性

事件通知请求具备重试能力，重试时间间隔为 4s，默认失败后自动触发重试，直至成功。满足以下任意条件可触发重试。

• 超时未收到应答包；
• 应答状态码不为 200。

回调内容

公共安全签名参数

推流开始回调消息

回调示例如下所示。

{
    "code":0,
    "message":"ok",
    "data":{
        "vhost":"push-rtmp.example.com",
        "domain":"push-rtmp.example.com",
        "app":"live",
        "stream":"stream-123456",
        "event_type":"push_start",
        "detail":{
            "time":1640849510,
            "time_ms":1640849510029,
            "transcoded":false,
            "fp_node_ip":"150.139.1.1",
            "fp_client_ip":"114.100.2.2",
            "session_id":"3693930911_150.139.1.1"
        }
    }
}

推流结束回调消息

回调示例如下所示。

{
    "code":0,
    "message":"ok",
    "data":{
        "vhost":"push-rtmp.example.com",
        "domain":"push-rtmp.example.com",
        "app":"live",
        "stream":"stream-123456",
        "event_type":"push_end",
        "detail":{
            "time":1640849502,
            "time_ms":1640849502762,
            "transcoded":false,
		        "errmsg":"func:OnStop:eof",
            "fp_node_ip":"106.225.1.1",
            "fp_client_ip":"113.77.2.2",
            "session_id":"2491536431_106.225.1.1"
        }
    }
}

录制回调消息

回调示例如下所示。

• 录制存储在 VoD

{
    "code":0,
    "message":"ok",
    "data":{
        "vhost":"pushrtmp.example.com",
        "domain":"pushrtmp.example.com",
        "app":"live",
        "stream":"stream_123456",
        "event_type":"record_event",
        "detail":{
            "tos_bucket":"",
            "tos_object":"record/pushrtmp.example.com/live/stream_123456_1640847072_1640849947_record.m3u8",
            "uri":"v0df17g10000ca6ut9pka0prk****pig",
            "duration":2868674,
            "start_time":1640847072,
            "stop_time":1640849947,
            "format":"m3u8",
            "url":"",
            "vod_filename":"record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}",
            "account_id":"10000**",
            "size":28361
        }
    }
}

• 录制存储在 ToS

{
    "code": 0,
    "message": "ok",
    "data": {
        "vhost": "push.example.com",
        "domain": "push.example.com",
        "app": "live",
        "stream": "stream_12345",
        "event_type": "record_event",
        "detail": {
            "tos_bucket": "livetest",
            "tos_object": "record/record/push.exanple.com/live/stream_123456/1653469134_1653469220.m3u8",
            "uri": "",
            "duration": 84430,
            "start_time": 1653469134,
            "stop_time": 1653469220,
            "format": "m3u8",
            "url": "http://livetest.tos-cn.volces.com/record/record/testpush.lurenxin.com/live/stream_12345/1653469134_1653469220.m3u8",
            "account_id": "2000001174",
            "size": 689
        }
    }
}

截图回调消息

回调示例如下所示。

• 截图存储在 veImageX

{
    "Vhost": "push.example.com",
    "Domain": "push.example.com",
    "App": "live",
    "Stream": "stream_1234",
    "Bucket": "bucket1",
    "ObjectKey": "push.example.com/live/stream_1234/2022052510115****.jpg",
    "Height": 1080,
    "Width": 1920,
    "Format": "jpg",
    "TimeStamp": 1653473517,
    "AccountId": "2000001174",
    "ImageXURI": "tos-cn-i-exampleid/2022052510115****.jpg",
    "ServiceID": "exampleid"
}

• 截图存储在 ToS

{
    "Vhost":"pushrtmp.example.com.",
    "Domain":"pushrtmp.example.com",
    "App":"live",
    "Stream":"stream_1234",
    "Bucket":"bucket1",
    "ObjectKey":"pushp.example.com/live/20211****.jpeg",
    "Height":864,
    "Width":480,
    "Format":"jpeg",
    "TimeStamp":1640849845,
    "AccountId":"10000"
}

拉流转推回调消息

{
    "action":"vod_start",
    "event_time":1650263223542095385,
    "task_id":"5f4c37605b7d711b51e28d73fa60****",
    "src":"http://test.com/test/test.m3u8",
    "dst":"rtmp://testpush/test/teststream",
    "type":1,
    "cycle_mode":-1
}

审核结果回调消息

EventData

Risk

{
    "Vhost": "example.com",
    "Domain": "example.com",
    "App": "live",
    "Stream": "stream1",
    "EventType": "scan_screenshoot_event",
    "EventData": {
        "MediaType": 1,
        "Image": "/liveexample/tob****01/stream**/1659079720209.jpg",
        "HitLabels": [
            "301"
        ],
        "RiskHit": [
            {
                "Label": "301",
                "SubLabel": "301001",
                "Decision": "BLOCK"
            },
            {
                "Label": "301",
                "SubLabel": "301002",
                "Decision": "BLOCK"
            }
        ],
        "RiskALL": [
            {
                "Label": "301",
                "SubLabel": "301001",
                "Decision": "BLOCK"
            },
            {
                "Label": "301",
                "SubLabel": "301002",
                "Decision": "BLOCK"
            }
        ],
        "Decision": "BLOCK",
        "AIResultOrigin": "{\"RequestId\":\"202207291528410102091561590F291DAA\",\"Code\":0,\"Message\":\"success\",\"Data\":{\"DataId\":\"7125691570795811116\",\"Decision\":\"BLOCK\",\"Results\":[{\"Label\":\"301\",\"SubLabel\":\"301001\",\"Decision\":\"BLOCK\",\"score\":0,\"Detail\":null,\"Frames\":null},{\"Label\":\"301\",\"SubLabel\":\"301002\",\"Decision\":\"BLOCK\",\"score\":0,\"Detail\":null,\"Frames\":null}],\"Scores\":null}}"
    },
    "EventTime": "2022-07-29T15:28:40+08:00",
    "EventId": "71256915707958766**",
    "CallbackURL": [
        "http://example.com/callback/scan_screenshoot"
    ]
}

附录

断流错误原因