视频播放结束事件上报--内容定制-火山引擎

文档中心

导航

视频播放结束事件上报

最近更新时间：2023.12.22 11:01:19首次发布时间：2021.04.09 18:31:35

该接口用于视频播放结束事件上报。

请求结构	说明
请求域名	stream-api.feedcoopapi.com【建议】 mercury.snssdk.com【废弃】
请求地址	手动播放结束：/user/action/log/video_over/v1/ 自动播放结束：/user/action/log/video_auto_over/v1/ 滑动播放结束（沉浸式小视频场景特有）：/user/action/log/video_over_draw/v1/
请求协议	HTTP/HTTPS
请求方式	GET/POST
参数类型	application/x-www-form-urlencoded

说明

一般结束播放方式与开始播放方式对应。

点击开始播放，上报video_play，结束播放（包含手动操作结束或自动播放结束方式）都上报video_over；
自动或划动开始播放，上报video_play_auto（中视频）或video_play_draw（小视频），结束播放（包含手动操作结束或自动播放结束方式）都上报video_over_auto（中视频）或video_over_draw（小视频）

请求参数

参数	描述	类型	是否必填	说明
group_id	内容id	long	是	对应“获取个性化内容”接口返回的group_id
event_time	事件发生时间	long	是	十位时间戳，单位：秒；表示点击退出详情页事件发生时的时间
root_gid	进入视频内流场景的首个视频id	long	否
percent	最大播放进度	long	是	视频最大的播放进度，拖动进度条也算。取值范围1～100。
duration	播放时长	long	是	单位：毫秒，表示本次播放的时长，注意不要累加上次播放的时长。
req_id	请求唯一标识	String	是	唯一标识该内容源于哪次请求，比如推荐接口返回的req_id

响应参数

参数	描述	类型	说明
ret	响应结果	long	参见“错误码”说明
msg	本次请求是否成功	String	success：成功
req_id	本次请求标识	String	惟一标识本次请求，火山引擎侧使用该字段进行具体问题追踪和排查

请求示例

curl --location --request GET 'https://stream-api.feedcoopapi.com/user/action/log/video_over/v1/?signature=54bf21452b8599034e6e5219864a5fd8f415a81a&timestamp=1656489292&nonce=894038&partner=server_sdk_demo_default_content&access_token=AEvgyaZ5cWcPS6m9jQhpXpjZ5xRued98RxaKYFX5NdjTDKXUEt8C3dGFXxmgoK9Sj5QvfXDPskhgrL87VVrmv7o6dPEsT7L&group_id=7115232373091860514&event_time=1656776132&req_id=xxx&percent=2&duration=2000'

响应示例

{
    "data": [],
    "msg": "success",
    "req_id": "202207030031520102112190260ABF82F6",
    "ret": 0
}