事件回调

控制台配置步骤

1. 登录视频直播控制台。

2. 在左侧导航栏单击功能管理> 事件回调,进入事件回调页面。

3. 选择您要配置的推流域名。推流回调只能在推流域名下进行配置。

4. 在回调设置页签下，开启推流回调开关，配置以下参数：

   • 回调类型：选择推/断流回调或推流异常事件回调。

   • 回调地址：输入您自身拥有的回调地址。推/断流回调使用HTTP GET请求，异常事件回调使用HTTP POST请求。

   • 回调鉴权：选择是否开启鉴权。如需鉴权，打开鉴权开关并输入鉴权Key，鉴权流程请参见回调鉴权。

5. 单击确定。

API 配置方式

推断流回调

推断流回调会将参数封装在MultiDict内。

推断流回调中开播（publish）状态回调逻辑

RTMP推流在阿里云直播服务收到On Publish消息后2秒内，如果推流端不主动断开，阿里云直播服务就会发推流成功回调。

假设您有推流域名A和播流域名B,如果您的域名B使用拉流直播（固定拉流和触发回源拉流）需要回调，请在域名A配置推流回调。配置后域名B的拉流回调逻辑与上一条一致，建联后默认2秒无主动断开即认为拉流成功。

当10秒内（包含10秒）没有流数据推送到直播中心时，直播服务就会自动断开推流。

推断流回调参数

推流状态回调参数示例：

http://1.1.X.X?action=publish&ip=192.168.0.1&id=world&app=example.aliyundoc.com&appname=liveApp****&time=1609220385&usrargs={用户参数}&node=cdnvideocenter01020711****.cm3&height=720&width=1280

断流状态回调参数示例：

http://1.1.X.X?action=publish_done&ip=192.168.0.0&id=world&app=example.aliyundoc.com&appname=liveApp****&time=1609220385&usrargs={用户参数}&node=cdnvideocenter01020711****.cm3&height=720&width=1280

推流异常事件回调

推流异常事件回调参数

异常类型

推流异常事件回调参数示例：

{
  "action": "publish_exception_notify",
  "domain": "demo.aliyundoc.com",
  "appname": "liveApp****",
  "stream": "liveStream****",
  "ip": "141.01.****",
  "time": "1739760710",
  "type": "5002",
  "event_time": "1739760710"
}

控制台配置步骤

1. 登录视频直播控制台。

2. 在左侧导航栏单击功能管理> 事件回调,进入事件回调页面。

3. 选择您要配置的播流域名。录制回调只能在播流域名下进行配置。

4. 在回调设置页签下，开启录制回调开关，配置以下参数：

   • 回调地址：输入您自身拥有的回调地址。录制回调使用HTTP POST请求。

   • 触发事件：选择文件生成回调或录制状态回调。

   • 按需回调地址：配置按需录制方式后，当开始推直播流时，直播录制服务会发送一条HTTP回调给事先设定的按需回调地址，通过该回调的返回内容决定是否录制这条直播流。按需回调地址默认*,表示关闭按需录制功能。

   • 回调鉴权：选择是否开启鉴权。如需鉴权，打开鉴权开关并输入鉴权Key，鉴权流程请参见回调鉴权。

5. 单击确定。

API 配置方式

录制状态回调

在文件开始录制与结束录制时发出，主要表示文件已经开始和结束录制。

录制状态回调参数

录制状态回调参数示例

{
  "domain": "demo.aliyundoc.com",
  "app": "liveApp****",
  "stream": "liveStream****",
  "event": "record_started"
}

文件生成回调

在文件生成时发出，主要包括文件名称，开始结束时间与时长信息。

文件生成回调参数

文件生成回调参数示例

推流URL为：rtmp://demo.aliyundoc.com/liveApp****/liveStream****?callback_args1=value1&callback_myid=1231389741

则回调内容为：

{
  "domain": "demo.aliyundoc.com",
  "app": "liveApp****",
  "stream": "liveStream****",
  "uri": "liveApp****/liveStream****/0_2017-03-08-23:09:46_2017-03-08-23:10:40.flv",
  "file_url": "http://****.oss-****.aliyuncs.com/liveApp****/liveStream****/0_2017-03-08-23:09:46_2017-03-08-23:10:40.flv",
  "duration": 69.403,
  "start_time": 1488985786,
  "stop_time": 1488985840,
  "push_args": {
    "callback_args1": "value1",
    "callback_myid": "1231389741"
  }
}

录制错误回调

录制过程中若因源流异常或OSS写入失败导致录制或转封装（MP4/FLV）出错，将触发错误回调。

录制错误回调参数

录制错误回调参数示例

录制错误

{
  "domain": "example.com",
  "app": "live",
  "stream": "stream123",
  "event": "record_error",
  "error_info": {
    "code": "TsSegmenterFail",
    "message": "ts segmenter error"
  }
}

错误代码列表：

转封装错误

{
  "domain": "example.com",
  "app": "live",
  "stream": "stream123",
  "event": "transformat_error",
  "error_info": {
    "code": "PermissionDenied.ResourceAccess",
    "message": "MTS not authorized to operate on the OutputBucket"
  },
  "file_info": {
    "uri": "record/live/stream123/2025-11-19-03-17-03_2025-11-19-03-28-39.flv",
    "start_time": 1763493420,
    "stop_time": 1763494119
  }
}

错误代码列表：

请求参数

返回参数

请求示例

GET /?app=seq_all&domain=demo.aliyundoc.com&stream=ondemand8&vbitrate=2000&codec=h264 HTTP/1.1
Host: pull.aliyundoc.com
User-Agent: Go-http-client/1.1
Accept-Encoding: gzip

返回示例

{
  "ApiVersion": "1.0",
  "NeedRecord": true,
  "Interval": {
    "Mp4": 300,
    "Flv": 120,
    "M3U8": 180
  },
  "Format": ["mp4","flv"]
}

返回参数处理

录制服务会对用户返回的参数配置和既有配置进行覆盖。例如，显示指定了Interval,那么录制服务会覆盖数据库中的录制配置里面的Interval,Format会和数据库中的配置取交集。如果用户指定的格式全不在既有配置之中，则不会录制这路直播流。

对于返回body长度有限制，超过2048会被截断，以防恶意攻击。

控制台配置步骤

1. 登录视频直播控制台。

2. 在左侧导航栏单击功能管理> 事件回调,进入事件回调页面。

3. 选择您要配置的播流域名。截图回调只能在播流域名下进行配置。

4. 在回调设置页签下，开启截图回调开关，配置以下参数：

   • 回调地址：输入您自身拥有的回调地址。截图回调使用HTTP POST请求。

   • 回调鉴权：选择是否开启鉴权。如需鉴权，打开鉴权开关并输入鉴权Key，鉴权流程请参见回调鉴权。

5. 单击确定。

API 配置方式

截图文件回调参数

截图文件回调参数示例

{
  "Event": "Snapshot",
  "DomainName": "demo.aliyundoc.com",
  "AppName": "liveApp****",
  "StreamName": "liveStream****",
  "OssBucket": "liveBucket****",
  "OssEndpoint": "oss-cn-shan****.aliyuncs.com",
  "OssObject": "1****.jpg",
  "CreateTime": "2015-12-01T17:36:00Z",
  "SnapshotUrl": "http://liveBucket****.oss-cn-shan****.aliyuncs.com/1****.jpg",
  "Size": "36291",
  "Width": "1280",
  "Height": "720"
}

直播截图支持截图回调鉴权配置。详细信息请参见配置截图回调鉴权配置、回调鉴权说明。

视频审核控制台配置步骤

1. 登录视频直播控制台。

2. 在左侧导航栏单击功能管理> 事件回调,进入事件回调页面。

3. 选择您要配置的播流域名。视频审核回调只能在播流域名下进行配置。

4. 在回调设置页签下，开启视频审核回调开关，配置回调地址。回调地址为您自身拥有的地址，当视频审核回调事件发生时，直播服务端会向该地址发起HTTP POST请求，具体内容将通过JSON Body送达。

5. 单击确定。

视频审核 API 配置方式

视频审核回调

只会对于有问题的视频内容进行回调通知，通知内容包含问题视频截图的审核信息和存储信息。

视频审核回调参数

Result

视频审核回调参数示例

{
  "DomainName": "demo.aliyundoc.com",
  "AppName": "liveApp****",
  "StreamName": "liveStream****",
  "OssEndpoint": "oss-cn-hang****.aliyuncs.com",
  "OssBucket": "liveBucket****",
  "OssObject": "example.jpg",
  "Result": [
    {
      "BizType": "demo.aliyundoc.com",
      "Result": [
        {"Label": "Porn", "Rate": 11, "Suggestion": "review", "Scene": "porn", "Extent": {}},
        {"Label": "Ad", "Rate": 11, "Suggestion": "review", "Scene": "ad", "Extent": {}}
      ]
    }
  ]
}

语音审核控制台配置步骤

1. 登录视频直播控制台。

2. 在左侧导航栏单击功能管理 > 事件回调,进入事件回调页面。

3. 选择您要配置的播流域名。语音审核回调只能在播流域名下进行配置。

4. 在回调设置页签下，开启语音审核回调开关，配置回调地址。回调地址为您自身拥有的地址，当语音审核回调事件发生时，直播服务端会向该地址发起HTTP POST请求，具体内容将通过JSON Body送达。

5. 单击确定。

语音审核 API 配置方式

语音审核回调

只会对于有问题的音频内容进行回调通知，通知内容包含问题语音的文本信息以及最近一分钟内的上下文信息。

语音审核回调参数

Result

Detail

语音审核回调参数示例

{
  "domain": "example.aliyundoc.com",
  "app": "liveApp****",
  "stream": "5d9747eba39b44769852d276f9ff****",
  "timestamp": 1572248095,
  "result": [
    {
      "scene": "antispam",
      "label": "ad",
      "suggestion": "block",
      "rate": 99.91,
      "details": [
        {
          "startTime": 1572248023,
          "endTime": 1572248040,
          "text": "丽江陇川等酒店免费居住权120天居住权可与亲友共享来云栖社国际烧酒店接待中心地址芒市团结大街96号邓朝ktv旁咨询热线2285699",
          "label": "ad"
        },
        {
          "startTime": 1572248040,
          "endTime": 1572248070,
          "text": "典藏经典别墅尊享隆多温泉、梁河金塔、温泉旅游小镇二期滨江苑地区11月2号盛大开盘天然龙窝、温泉水入户户型多样,设计经典价位超值,值得您拥有开盘当天还有超值优惠,欢迎您前来品鉴,凭借地址,然和县遮岛镇先锋路229号分享热线0692695577769***",
          "label": "normal"
        },
        {
          "startTime": 1572248072,
          "endTime": 1572248077,
          "text": "快乐的时光,有你相伴惬意的日子,格外轻松。",
          "label": "normal"
        },
        {
          "startTime": 1572248078,
          "endTime": 1572248086,
          "text": "fme043忙里偷闲音乐时光有歌曲温暖,有你想念影院。",
          "label": "normal"
        }
      ]
    }
  ]
}

控制台配置步骤

1. 登录视频直播控制台。

2. 在左侧导航栏单击功能管理> 事件回调,进入事件回调页面。

3. 选择您要配置的推流域名。双流灾备回调只能在推流域名下进行配置。

4. 在回调设置页签下，开启双流灾备回调开关，配置回调地址。

5. 单击确定。

切流回调

回调示例：

{
  "action": "multistream_set_master_result",
  "domain": "demo.aliyundoc.com",
  "appname": "liveApp****",
  "streamname": "liveStream****",
  "upstreamsequence": "main",
  "upstreamip": "203.**.***.10",
  "upstreamtime": 17*****710,
  "changereason": "merge_cut_manually",
  "changetime": 17*****705,
  "time": 17*****706
}