获取回放地址统一接口

功能介绍

获取回放地址统一接口：v2相比于v1归一了所有获取回放地址相关的接口，v2接口支持查询前端和云端录像，支持各种协议，支持好望和国标设备。

备注：播放P2P回放需要将响应Body参数中的所有内容输入到播放地址栏且不支持国标协议；播放转发回放需要将CloudTransChannelsResp中的live_url输入到播放地址栏

URI

GET /v2/{user_id}/devices/{device_id}/channels/{channel_id}/media/playback-connections

表1 路径参数
参数	是否必选	参数类型	描述
user_id	是	String	用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节
device_id	是	String	设备ID：好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR），用来区分设备类型
channel_id	是	String	通道ID：好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取

表2 Query参数
参数	是否必选	参数类型	描述
playback_protocol	是	String	媒体播放协议：枚举类型，选择获取地址的媒体播放协议类型枚举值： HOLO 好望协议的录像 HTTP_HLS 基于HTTP的HLS流媒体传输协议的录像（该协议存在安全风险，建议优先使用其他协议） HTTPS_HLS 基于HTTPS的HLS流媒体传输协议的录像 RTSP RTSP流媒体传输协议的录像（该协议存在安全风险，建议优先使用其他协议） HTTP_FLV 基于HTTP的FLV媒体协议（该协议存在安全风险，建议优先使用其他协议） HTTPS_FLV 基于HTTPS的FLV媒体协议
start_time	是	String	开始时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间
end_time	是	String	结束时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间
record_position	是	String	录像位置，枚举类型枚举值： CLOUD 云端录像 DEVICE 前端录像
record_type	否	String	录像类型：枚举类型，仅针对查询云端录像，不填则默认值为 ALL_RECORD 枚举值： ALL_RECORD 所有录像 NORMAL_RECORD 全量录像 MOTION_RECORD 动检录像
expire_time	否	String	自定义Url过期时间：时间范围[30, 86400]，不填写时默认值为 30（单位/秒）说明：仅对CloudTransChannelsResp中的playback_url有效
use_times	否	String	自定义Url使用次数：枚举类型，当expire_time和use_times都不填写时，use_times默认为1，仅use_times不填写时，use_times默认为0，RTSP协议固定为 0 枚举值： 0 使用一次 1 有效时间内任意使用，此参数对RTSP协议无效说明：仅对CloudTransChannelsResp中的playback_url有效
stream_type	否	String	码流类型：枚举类型，不填写时默认值为 PRIMARY_STREAM 枚举值： PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 子码流1 SECONDARY_STREAM_2 子码流2

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
Access-Token	是	String	用户认证AccessToken：从获取用户北向接口认证AccessToken中获取

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
playback_connections	PlaybackConnectionsResp object	回放信息

表5 PlaybackConnectionsResp
参数	参数类型	描述
device_id	String	设备ID：设备唯一标识，长度范围[1,32]
channel_id	String	通道ID：长度范围[1,20]
cloud_trans_connections	CloudTransChannelsResp object	转发实况连接结构体
p2p_connections	P2PChannelsResp object	P2P实况连接结构体：仅支持HOLO媒体播放协议，前端回放类型且请求设备为好望设备
session_id	String	录像唯一标识，仅FLV媒体协议返回，回放控制使用
domain	String	域名标识，仅FLV媒体协议返回，回放控制使用

表6 CloudTransChannelsResp
参数	参数类型	描述
playback_url	String	转发回放地址：将此url输入播放地址栏开始播放

表7 P2PChannelsResp
参数	参数类型	描述
token	String	P2P请求Token
device_state	String	在线状态：枚举类型枚举值： OFFLINE 离线 ONLINE 在线
p2p_nodes	Array of P2PMTSListResp objects	P2P连接可用节点
result	Result object	错误信息

表8 P2PMTSListResp
参数	参数类型	描述
node_type	String	节点类型：枚举类型枚举值： COMMON 普通：普通的三线（移动，联通，电线）服务器，与地域有关，服务器由运营商托管，网络通信质量低 BETTER 优质：全网通服务器（华为云服务器等），网络通信质量高
address_type	String	地址类型：枚举类型 DOMAIN 域地址 IPV4 IPv4地址 IPV6 IPv6地址
address	Array of strings	媒体转发服务地址：协议头在SDK封装，根据address_type决定地址类型 DOMAIN: www.huawei.com IPV4: 123.123.123.123 IPV6: fe80::f816:3eff:feed:5821
tcp_port	Integer	TCP端口：默认值为 0 备注：未使用0端口，tcp_port只作为兼容字段保留
udp_port	Integer	UDP端口：默认值为 7050

表9 Result
参数	参数类型	描述
code	String	错误编码：请参见错误码
msg	String	错误信息

请求示例

查询前端的录像回放地址

GET /v2/123456789*****/devices/219123456CYP***/channels/0/media/playback-connections?start_time=2023-03-20 10:05:00&end_time=2023-03-20 12:50:00&playback_protocol=HOLO&record_position=DEVICE

GET /v2/123456789*****/devices/219123456CYP***/channels/0/media/playback-connections?start_time=2023-03-20 10:05:00&end_time=2023-03-20 12:50:00&playback_protocol=HTTP_HLS&record_position=DEVICE

GET /v2/123456789*****/devices/219123456CYP***/channels/0/media/playback-connections?record_position=CLOUD&start_time=2023-03-20 10:05:00&end_time=2023-03-20 12:50:00&playback_protocol=HTTPS_HLS

响应示例

状态码： 200

{
	"playback_connections": {
		"device_id": "219123456CYP***",
		"channel_id": "0",
		"cloud_trans_connections": {
			"playback_url": "jvmp://123.123.123.123:7070/vod/219123456CYP***?token=content***"
		},
		"p2p_connections": {
			"token": "content***",
			"device_state": "ONLINE",
			"p2p_nodes": [
				{
					"node_type": "COMMON",
					"address_type": "IPV4",
					"address": [
						"123.123.123.123"
					],
					"tcp_port": 0,
					"udp_port": 7050
				}
			],
			"result": {
				"code": "IVM.0",
				"msg": "Success"
			},
			"start_time": "2023-03-20 10:05:00",
			"end_time": "2023-03-20 12:50:00"
		}
	}
}

{
	"playback_connections": {
		"device_id": "219123456CYP***",
		"channel_id": "0",
		"cloud_trans_connections": {
			"playback_url": "http://123.123.123.123:7083/dev_vod/vod.m3u8?token=content***&device_id=219123456CYP***&channel_id=0&stream_type=0"
		},
		"p2p_connections": {}
	}
}

{
	"playback_connections": {
		"device_id": "219123456CYP***",
		"channel_id": "0",
		"cloud_trans_connections": {
			"playback_url": "https://123.123.123.123:7081/vod/vod.m3u8?token=content***&device_id=219123456CYP***&channel_id=0"
		},
		"p2p_connections": {}
	}
}