事件列表更新时间：2021-09-29 14:00:07

事件类型

目前支持的事件类型如下：

event 事件类型
CreateRecordComplete 生成回放完成
SingleTranscodeComplete 视频单个清晰度转码完成
AllTranscodeComplete 视频全部清晰度普通转码完成
AllTranscodeEncryptComplete 视频全部清晰度加密转码完成
TranscodeProgress 视频转码进度
VideoEditComplete 媒体剪辑完成
MediaPackageComplete 媒体打包完成
VODToLiveStart 点播转直播开始
VODToLiveEnd 点播转直播播放结束
VODToLiveStop 点播转直播停止
UploadByURLComplete URL拉取媒体上传完成
SnapshotComplete 点播截图完成
AIMediaAuditComplete 智能审核完成
DynamicImageComplete 点播截图转动图完成
VoiceDictationComplete 点播语音听写完成
VODDocChangeComplete 点播文档信息变更
RemakeDocComplete 点播重制课件完成
PointFrameComplete 点播打点截图完成
DeletePointFrameComplete 点播删除打点截图完成
VODCoverComplete 生成媒体封面完成
TransSubtitleComplete 点播识别字幕完成
CreateSubtitleComplete 点播创建字幕完成
VodBatchCopyComplete 点播条目复制完成
VideoConcatComplete 媒体合并完成

具体事件列表

1.生成回放完成

生成回放完成后，会产生此事件。

       事件内容

名称 类型 说明
event string 事件类型，为CreateRecordComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
room_id string  直播间ID
status int 结果 1:成功，2:失败
errno int 错误码
task_id string 生成回放任务id
video_id string 视频ID
此字段已废弃，请不要使用
size long 视频大小（byte）
此字段已废弃，请不要使用
video_url string 文件url地址，
此字段已废弃，请不要使用
is_safe int 是否加密类型点播，
0：非加密， 1：加密

       回调示例

{
    "event": "CreateRecordComplete",
    "datetime": "2019-04-01 11:11:11",
    "app_id": "xxxxxx",
    "vod_id": "xxxxxxxx",
    "room_id": "xxxx",
    "status": 1, #1为生成功，2为失败
    "task_id": "xxxxx",
    "errno": 200,
    "is_safe":0,
}

2.视频单个清晰度转码完成

视频的某个清晰度、某种格式的流（如：标清的MP4格式）转码完成时会产生此事件。目前单个清晰度至少1种格式的转码完成即可播放。

       事件内容

名称 类型 说明
event string 事件类型，为SingleTranscodeComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
status int 转码状态，0新增排队中 1转码成功 2转码失败 3转码中 4转码部分成功
video_info json 视频单清晰度转码信息
task_id string 转码任务id

视频单清晰度转码信息

名称 类型 说明
quality string 视频清晰度
transcode_status int 转码状态，1转码成功 2转码失败
video_type string 视频类型
storage_kbyte int 视频存储大小
bitrate_kbps int 视频平均码率
duration_s int 视频时长
width int 宽度
height int 高度

       回调示例

{ 
	"event": "SingleTranscodeComplete", 
	"datetime": "2019-04-01 11:11:11",
	"vod_id": "xxxxxxxx", 
	"status": 1,  #转码状态:0新增排队中 1转码成功 2转码失败 3转码中 4转码部分成功
	"task_id": "xxxxx",
	"video_info":
	{
		"quality":"360p",
		"video_type":"mp4",
		"storage_kbyte":534534,
		"bitrate_kbps":1000,
		"duration_s": 600,
		"width":960,
		"height":540,
		"transcode_status": 1
	}
}

3.视频全部清晰度普通转码完成

视频的全部清晰度全部格式都普通转码完成时，会产生此事件。

       事件内容

名称 类型 说明
event string 事件类型，为AllTranscodeComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
status int 普通转码状态，0新增排队中 1转码成功 2转码失败 3转码中 4转码部分成功
video_media_infos json 视频全部清晰度普通转码完成详情列表
task_id string 转码任务id

       回调示例

{ 
	"event": "AllTranscodeComplete", 
	"datetime": "2019-04-01 11:11:11",
	"vod_id": "xxxxxxxx", 
	"status":  1 , #普通转码状态:0新增排队中 1转码成功 2转码失败 3转码中 4转码部分成功
	"task_id": "xxxxx",
	"errno": 200
	"video_media_infos":
	[
		{
		"quality":"360p",
		"video_type":"mp4",
		"storage_kbyte":534534,
		"bitrate_kbps":1000,
		"duration_s": 600,
		"width":960,
		"height":540,
		"transcode_status": 1
		},
		{
		"quality":"480p",
		"transcode_status": 2
		}
	]
}

4.媒体剪辑完成

媒体剪辑完成时，会产生此事件。

       事件内容

名称 类型 说明
event string 事件类型，为VideoEditComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
status int 结果 1:成功，2:失败
errno int 错误码
task_id string 剪辑任务id

       回调示例

{
    "event": "VideoEditComplete",
    "datetime": "2019-04-01 11:11:11",
    "app_id": "xxxxxx",
    "vod_id": "xxxxxxxx", #生成目标vod_id
    "status": 1, #1为裁剪生成成功，2为失败
    "errno": 200,
    "task_id":"xxxx"
}

5.媒体打包完成

媒体打包完成时，会产生此事件。

       事件内容

名称 类型 说明
event string 事件类型，为MediaPackageComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
package_id int 媒体打包ID
size int 打包文件大小
download_url string 打包文件下载地址
quality string 清晰度
status int 结果 1:成功，2:失败
errno int 错误码
task_id string 打包任务id

       回调示例

{

   "event": "MediaPackageComplete",
    "status": 1,
    "app_id": "xxxxxxx",
    "datetime": "2019-12-02 12:04:16",
    "package_id": 1234,
    "quality": "",
    "size": 650686,
    "vod_id": "8xx3ac0b",
    "errno": 200,
    "download_url": "xxxxx",
    "task_id": "xxx"
}

6.点播转直播开始

处理点播转直播播放任务时，会产生此事件

    事件内容

名称 类型 说明
event string 事件类型，为VODToLiveStart
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
room_id string  直播间ID
task_id string 转播任务id
status int 结果 1:成功，2:失败
errno int 错误码

       回调示例

{
    "event": "VODToLiveStart",
    "datetime": "2019-04-01 11:11:11",
    "vod_id": "xxxxxxxx",
    "app_id": "xxx",
    "room_id": "xxxx",
    "task_id": "xxx",
    "status": 1,
    "errno": 200
}

 

7.点播转直播播放结束

点播转直播播放结束后，会产生此事件

事件内容

名称 类型 说明
event string 事件类型，为VODToLiveEnd
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
room_id string  直播间ID
task_id string 转播任务id

       回调示例

{
    "event": "VODToLiveStop",
    "datetime": "2019-04-01 11:11:11",
    "vod_id": "xxxxxxxx",
    "app_id": "xxx",
    "room_id": "xxxx",
    "task_id": "xxx",
    "errno": 200
}

 

8.点播转直播停止

处理点播转直播停止任务时，会产生此事件

事件内容

名称 类型 说明
event string 事件类型，为VODToLiveStop
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
room_id string  直播间ID
task_id string 转播任务id
status int 结果 1:成功，2:失败
errno int 错误码

回调示例

{
    "event": "VODToLiveStop",
    "datetime": "2019-04-01 11:11:11",
    "vod_id": "xxxxxxxx",
    "app_id": "xxx",
    "room_id": "xxxx",
    "task_id": "xxx",
    "status": 1,
    "errno": 200
}

 

9.URL拉取媒体上传完成

提交URL批量拉取上传任务后， 在URL拉取媒体并上传过程中，会产生此事件

事件内容

名称 类型 说明
event string 事件类型，为UploadByURLComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
task_id string 转播任务id
source_url string 源文件URL地址
status int 结果 1:成功，2:失败
errno int 错误码
err_msg string 错误信息，当status为失败时候会有该字段


回调实例

{
    "event": "UploadByURLComplete",
    "datetime": "2019-04-01 11:11:11",
    "vod_id": "xxxxxxxx",
    "app_id": "xxx",
    "task_id": "xxx",
    "source_url": "http://xxxx",
    "status": 1,
    "errno": 200,
    "err_msg": ""
}

10.点播截图完成

点播视频截图完成后会产生此事件。

事件内容

名称 类型 说明
event string 事件类型，为SnapshotComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
task_id string 截图任务id
snapshots json 截图列表，截图失败不会有该字段
count int 截图总数
status int 结果 1:成功，2:失败
errno int 错误码
err_msg string 错误信息，当status为失败时候会有该字段


回调实例

{
    "event": "SnapshotComplete",
    "datetime": "2019-11-01 12:13:24",
    "vod_id": "xxxxxxxx", 
    "app_id": "xxx",
    "task_id": "xxx",
    "status": 1,
    "errno": 200,
    "err_msg": "",
    "count": 3,
    "snapshots":
    [
        "http://xxx.vhall.com/vhallpictures/xxxxx/xxxxx-001.jpg",
        "http://xxx.vhall.com/vhallpictures/xxxxx/xxxxx-002.jpg",
        "http://xxx.vhall.com/vhallpictures/xxxxx/xxxxx-003.jpg",
    ]
}

11.智能审核完成

点播智能审核完成后会产生此事件。

事件内容

名称 类型 说明
event string 事件类型，为AIMediaAuditComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
task_id string 智能审核任务id
audit_infos json 审核详情信息
status int 结果 1:成功，2:失败
errno int 错误码
err_msg string 错误信息，当status为失败时候会有该字段


回调实例

{
    "status": 1,
    "vod_id": "c7c37ddb",
    "audit_infos": [
        {
            "uri": "http://xxx.vhallyun.com/vhallyun/vhallimage/c7c37ddb/20191128110318/img-00001.jpg",
            "results": [
                {
                    "scene": "porn",
                    "suggestion": "pass"
                },
                {
                    "scene": "terrorism",
                    "suggestion": "pass"
                }
            ]
        },
        {
            "uri": "http://xxxx.vhallyun.com/vhallyun/vhallimage/c7c37ddb/20191128110318/img-00002.jpg",
            "results": [
                {
                    "scene": "porn",
                    "suggestion": "pass"
                },
                {
                    "scene": "terrorism",
                    "suggestion": "pass"
                }
            ]
        }
    ],
    "err_msg": "",
    "task_id": "45f593da-414c-4b61-a7c0-87ab5f325565",
    "errno": 200,
    "app_id": "f4efa787",
    "event": "AIMediaAuditComplete",
    "datetime": "2019-11-28 13:35:50"
}

12.点播截图转动图完成

点播截图文件转动图完成后会产生此事件.

事件内容

名称 类型 说明
event string 事件类型，为DynamicImageComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
task_id string 转动图任务id
image_uri string 动图文件URI地址
height int 动图高, 单位px
width int 动图宽, 单位px
status int 结果 1:成功，2:失败
errno int 错误码
err_msg string 错误信息，当status为失败时候会有该字段


回调实例


{
    "event": "DynamicImageComplete",
    "datetime": "2019-11-01 12:13:24",
    "vod_id": "xxxxxxxx", 
    "app_id": "xxx",
    "task_id": "xxx",
    "image_uri": "http://xxx.vhallyun.com/xxxx/xxxx.gif",
    "height": 480,
    "width": 360,
    "status": 1,
    "errno": 200,
    "err_msg": ""
}

13.点播语音听写完成

点播语音听写任务完成后会产生此事件

事件内容

名称 类型 说明
event string 事件类型，为VoiceDictationComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
task_id string 听写任务id
dictation_uri string 点播听写文件路径
status int 结果 1:成功，2:失败
errno int 错误码
err_msg string 错误信息，当status为失败时候会有该字段


回调实例

{
    "event": "VoiceDictationComplete",
    "datetime": "2019-11-01 12:13:24",
    "vod_id": "xxxxxxxx", 
    "app_id": "xxx",
    "task_id": "xxx",
    "dictation_uri": "http://e.vhall.com/xxxx/dictation.txt",
    "type": 1,
    "status": 1,
    "errno": 200,
    "err_msg": ""
}

14.点播文档信息变更

提交创建，删除，更新点播文档请求后会产生此事件

事件内容

名称 类型 说明
event string 事件类型，VODDocChangeComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string   app_id
task_id string 听写任务id
change_mode string 文档操作方式， create-创建文档关联， delete-删除文档关联，update-更新文档
status int 结果 1:成功，2:失败
errno int 错误码


回调实例

{
    "event": "VoiceDictationComplete",
    "datetime": "2019-11-01 12:13:24",
    "vod_id": "xxxxxxxx", 
    "app_id": "xxx",
    "task_id": "xxx",
    "change_mode": "update",
    "status": 1,
    "errno": 200,
}

15.点播重制课件完成

点播重制课件任务完成后会产生此事件

事件内容

名称 类型 说明
event string 事件类型，RemakeDocComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 新生成重制课件的点播ID
app_id string   app_id
task_id string 重制任务id
status int 结果 1:成功，2:失败
errno int 错误码：200/401/402/403/404/405
err_msg string 错误信息：重制课件成功/解析重制课件任务失败/演示文档内容解析失败/录制文档视频过程异常/录制文档视频失败/重制课件，宫格拼接失败


回调实例

{
    "event": "RemakeDocComplete",
    "datetime": "2019-11-01 12:13:24",
    "vod_id": "xxxxxxxx", 
    "app_id": "xxx",
    "task_id": "xxx",
    "status": 1,
    "errno": 200,
    "err_msg": "重制课件成功",
}

16.点播打点截图完成

点播打点截图任务完成后会产生此事件

事件内容

名称 类型 说明
event string 事件类型，PointFrameComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string  app_id
task_id string 打点截图任务id
status int 结果 1:成功，2:失败
errno int 错误码
err_msg string 错误信息
count int 截图数量(本次任务)


回调实例

{
    "event": "PointFrameComplete",
    "datetime": "2020-10-27 14:52:00",
    "vod_id": "xxxxxxxx",
    "app_id": "xxx",
    "task_id": "xxx",
    "status": 1,
    "errno": 200,
    "err_msg": "xxxx"，
    "count":"6"
}

17.点播删除打点截图完成

点播删除打点截图任务完成后会产生此事件

事件内容

名称 类型 说明
event string 事件类型，DeletePointFrameComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string  app_id
task_id string 删除打点截图任务id
status int 结果 1:成功，2:失败
errno int 错误码
err_msg string 错误信息


回调实例

{
    "event": "DeletePointFrameComplete",
    "datetime": "2020-10-27 14:52:00",
    "vod_id": "xxxxxxxx",
    "app_id": "xxx",
    "task_id": "xxx",
    "status": 1,
    "errno": 200,
    "err_msg": "xxxx"
}

18.生成媒体封面完成

生成媒体封面任务完成完成后会产生此事件

事件内容

名称 类型 说明
event string 事件类型，VODCoverComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string  app_id
task_id string 删除打点截图任务id
status int 结果 1:成功，2:失败
errno int 错误码
err_msg string 错误信息
vod_cover_url string 封面路径


回调实例

{
    "event": "VODCoverComplete ",
    "datetime": "2020-10-27 14:52:00",
    "vod_id": "xxxxxxxx",
    "app_id": "xxx",
    "task_id": "xxx",
    "status": 1,
    "errno": 200,
    "err_msg": "xxxx",
    "vod_cover_url":"https://xxxxxxx/vhallyun/vhallimage/vodcover/1ee301b9/cover.jpg",
}

19.点播识别字幕完成

提交点播识别字幕文件任务完成后会产生此事件。

事件内容

名称 类型 说明
event string 事件类型，TransSubtitleComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string  app_id
task_id string 任务id
status int 结果 1:成功，2:失败
errno int 错误码
err_msg string 错误信息


回调实例

{
    "event": "TransSubtitleComplete ",
    "datetime": "2020-10-27 14:52:00",
    "vod_id": "xxxxxxxx",
    "app_id": "xxx",
    "task_id": "xxx",
    "status": 1,
    "errno": 200,
    "err_msg": "xxxx"
}

20.点播创建字幕完成

当使用点播上传的sdk上传字幕文件，并关联相关点播ID后会产生此事件。

事件内容

名称 类型 说明
event string 事件类型，CreateSubtitleComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string  app_id
task_id string 任务id
status int 结果 1:成功，2:失败
errno int 错误码
err_msg string 错误信息


回调实例

{
    "event": "CreateSubtitleComplete  ",
    "datetime": "2020-10-27 14:52:00",
    "vod_id": "xxxxxxxx",
    "app_id": "xxx",
    "task_id": "xxx",
    "status": 1,
    "errno": 200,
    "err_msg": "xxxx"
}

21.视频转码进度

视频转码时，会产生此事件。根据固定策略上报个清晰度转码进度及总转码进度信息。

事件内容

名称 类型 说明
event string 事件类型，TranscodeProgress
start_time string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
app_id string  应用ID
task_id string 任务ID
total_progress int 总转码进度（百分比），例如：88
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
single_quality list 各单清晰度，转码进度


回调实例

{
	"event": "TranscodeProgress",
	"start_time": "2021-01-11 14:36:19",
	"vod_id": "628185cd",
	"app_id": "4fe0db63",
	"task_id": "dd2c6f6e-d629-4051-bc8e-44690c424a89",
	"total_progress": 88,
	"datetime": "2021-01-11 14:38:26",
	"single_quality": [{
		"percent": 100,
		"quality": "480p"
	}, {
		"percent": 100,
		"quality": "360p"
	}, {
		"percent": 64,
		"quality": "same"
	}]
}

22.订阅点播观看数据完成

异步订阅点播观看统计数据查询任务完成后，进行回调。

事件内容

名称 类型 说明
event string 事件类型，vod/record-use-info-sync
app_id string  应用ID
task_id string 任务ID
start_time string 时间，格式为“yyyy-MM-dd HH:mm:ss”
record_id string 回放ID
type string 查询维度类型
stat_data list 统计数据
signature string 回调签名
refer string vhall
time string 回调时间戳


回调实例

{
    "event":"vod/record-use-info-sync",
    "record_id":"lss_b17fad75",
    "app_id":"ecd0fca2",
    "type": 1,
    "start_time":"2020-11-01 00:00:00",
    "end_time":"2021-01-15 23:59:59",
    "stat_data":"[ ]", //与获取点播观看记录data相同
    "refer":"vhall",
    "time":1611196522,
    "signature":"a2c6fd4a3a1ae7eb6fa52346e572297"
}

23.点播条目复制完成

提交点播条目复制任务，开始异步处理，结果需等待事件回调。

事件内容

名称 类型 说明
event string 事件类型，VodBatchCopyComplete
app_id string  应用ID
task_id string 任务ID
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
errno int 错误码，示例：200
copied_info list 被复制信息映射关系


回调实例

{
    "event": "VodBatchCopyComplete",
    "datetime": "2019-04-01 11:11:11",
    "app_id": "xxxxxx",
    "errno": 200,
    "task_id": "xxx",
    "copied_info": [{
        "original_vod_id": "a0d110ce",   // 源点播ID
        "copied_vod_id": "ab50e7fa",     // 复制新点播ID
        "status": 1    // 1 成功
    }, {
        "original_vod_id": "e292142d",
        "copied_vod_id": "3abbc18a",
        "status": 2    // 2 失败
    }]
}

24.媒体合并完成

提交媒体合并任务，开始异步处理，结果需等待事件回调。

事件内容

名称 类型 说明
event string 事件类型，VideoConcatComplete
app_id string  应用ID
vod_id string  新点播ID
task_id string 任务ID
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
status int 1为合并成功，2为合并失败
errno int 错误码，示例：200


回调实例

{
	"event": "VideoConcatComplete",
	"datetime": "2021-06-01 11:11:11",
	"app_id": "xxxxxx",
	"vod_id": "xxxxxxxx",
	"status": 1,
	"errno": 200,
	"task_id": "xxx"
}

25.视频全部清晰度加密转码完成

视频的全部清晰度全部格式都加密转码完成时，会产生此事件。

事件内容

名称 类型 说明
event string 事件类型，为AllTranscodeEncryptComplete
datetime string 时间，格式为“yyyy-MM-dd HH:mm:ss”
vod_id string 点播ID
status int 加密转码状态，0新增排队中 1转码成功 2转码失败 3转码中 4转码部分成功
video_media_infos json 视频全部清晰度加密转码完成详情列表
task_id string 转码任务id

回调示例

{ 
	"event": "AllTranscodeEncryptComplete", 
	"datetime": "2019-04-01 11:11:11",
	"vod_id": "xxxxxxxx", 
	"status":  1 , #加密转码状态:0新增排队中 1转码成功 2转码失败 3转码中 4转码部分成功
	"task_id": "xxxxx",
	"errno": 200
	"video_media_infos":
	[
		{
		"quality":"360p",
		"video_type":"mp4",
		"storage_kbyte":534534,
		"bitrate_kbps":1000,
		"duration_s": 600,
		"width":960,
		"height":540,
		"transcode_status": 1
		},
		{
		"quality":"480p",
		"transcode_status": 2
		}
	]
}