直播API列表

序号 API 描述
1 DenyLiveStream 禁止某条流的推送,可以预设某个时刻将流恢复
2 ResumeLiveStream 恢复某条流的推送
3 DescribeLiveStreamDenyList 查询直播禁流的列表
4 DescribeLiveStreamPublicRecord 查询推流历史记录,可以查看一段时间内某个域名(或域名下某业务)的推流记录。
5 DescribeLiveStreamOnlineList 查询当前推流的实时信息。查看指定域名下(或者指定域名下某个应用)的所有正在推的流的信息。
6 SetLiveStreamNotifyUrl 设置回调url,指定域名下的流,在推流开始、和推流结束时会向设置的回调url发送请求,通知推流和断流事件。
7 DescribeLiveStreamNotifyUrl 获取某个域名下设置的回调url
8 SetLiveStreamRecordConfig "设置录播配置,设置存储转录文件播放的点播域名和回调url,来通知录播文件事件。限制条件:NotifyUrl 和 VodDomain 不能同时为空"。
9 DescribeLiveStreamRecordConfig 获取某个域名下录播配置
10 DescribeLiveVodFileList 查询直播转存的点播文件信息
11 DeleteLiveStreamVodFile 删除直播转存的点播文件
12 DescribeLiveStreamPublishSpeedList 批量查询流的推流速度等信息
13 DescribeLiveStreamPublishSpeed 查询单个流的推流速度等信息
14 DescribeLiveStreamPullStatInfoList 查询指定域名下所有流或某个流的,当前或某个时间点的下行统计信息:包括在线人数,带宽。
15 DescribeLiveStreamPullStatInfo 查询单个流一段时间内(最长一天)的下行统计信息:包括带宽和连接数。自然五分钟时间为一个点。

DenyLiveStream

描述

禁止某条流的推送,可以预设某个时刻将流恢复

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效
AppName String 业务名
StreamName String 流名
ResumeTime DateTime 解禁时间点,如不传则表示永不解禁,格式为YYYY-MM-DD HH:mm:ss,取值必须大于当前时间戳。

返回参数

示例

禁流的请求示例

http://api.xycdn.com/v2
?AppName=live_test
&DomainName=test.live.xycdn.com
&ResumeTime=2016-06-06%2018%3A00%3A00
&StreamName=test
&access_key=testKey
&action=DenyLiveStream
&signature=rQt4RkN4fYIlQPrQVjs%2Bb1oEHTE%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T12%3A43%3A05Z
&version=2.0

返回示例

{
	"action":"DenyLiveStreamResp"
	"code":0
}

ResumeLiveStream

描述

恢复某条流的推送

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效
AppName String 业务名
StreamName String 流名

返回参数

示例

禁流的请求示例

http://api.xycdn.com/v2
?AppName=live_test
&DomainName=test.live.xycdn.com
&StreamName=test
&access_key=testKey
&action=ResumeLiveStream
&signature=9tPvoAJGtkGuC7BmaGkXoVQxESs%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T12%3A46%3A44Z
&version=2.0

返回示例

{
	"action":"ResumeLiveStreamResp"
	"code":0
}

DescribeLiveStreamDenyList

描述

查询直播禁流的列表

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效

返回参数

参数 类型 说明
list DenyStreamList数组 禁流列表

数据类型

DenyStreamList

名称 类型 描述
appName String 业务名
streamName String 流名
denyTs TimeStamp 表示禁流截至的时间点,格式为时间戳
denyDatetime DateTime 表示禁流截至的时间点,格式为年-月-日 时-分-秒

示例

请求示例

http://api.xycdn.com/v2
?DomainName=test.live.xycdn.com
&access_key=testKey
&action=DescribeLiveStreamDenyList
&signature=JpJIVi1tuwnfH%2BPMyC0Fadxrqf0%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T13%3A14%3A01Z
&version=2.0

返回示例

{
	"result":{
		"denyList": [{
			"streamName": "stream1",
			"appName": "test",
			"denyTs": "-1",
			"denyDatetime": "-1"
		},
		...]
	},
	"code": 0,
	"action": "DescribeLiveStreamDenyListResp"
}

DescribeLiveStreamPublicRecord

描述

查询推流历史记录,可以查看一段时间内某个域名(或域名下某业务)的推流记录。

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效
AppName String App名
StreamName String 流名
StartTime DateTime 查询从该时间以后开始推流的推流记录。格式:年-月-日 时:分:秒 比如 2016-02-26 00:30:00若不传入该参数,默认为昨天的当前时间
EndTime DateTime 查询该时间之前开始推流的推流记录。格式:年-月-日 时:分:秒 比如 2016-02-27 00:30:00若不传入该参数,默认为当前时间

返回参数

参数 类型 说明
publishInfo publishInfoList数组 推流记录

数据类型

publishInfoList

名称 类型 描述
domainName String 域名名
appName String 业务名
streamName String 流名
publishTime DateTime 开始推流的时间点,格式为年-月-日 时-分-秒
stopTime DateTime 停止推流的时间点,格式为年-月-日 时-分-秒
publishUrl String 完整的推流url

示例

请求示例

http://api.xycdn.com/v2
?DomainName=test.live.xycdn.com
&access_key=testKey
&action=DescribeLiveStreamPublicRecord
&signature=SVw2erQ%2Bvk4gS1mdbwfT0Qe2HSY%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T13%3A17%3A18Z
&version=2.0

返回示例

{
	"result":{
		"publishInfo": [{
			"domainName": "test.live.xycdn.com",
			"appName": "test",
			"streamName": "stream1",
			"publishTime": "2016-03-07 16:59:36",
			"stopTime": "2016-03-07 17:19:46",
			"publishUrl": "rtmp:\/\/test.live.xycdn.com\/test\/stream1"
		},
		{
			"domainName": "test.live.xycdn.com",
			"appName": "test",
			"streamName": "stream1",
			"publishTime": "2016-03-07 17:20:25",
			"stopTime": "2016-03-07 17:20:33",
			"publishUrl": "rtmp:\/\/test.live.xycdn.com\/test\/stream1"
		},
		...]
	},
	"code": 0,
	"action": "DescribeLiveStreamPublicRecordResp"
}

DescribeLiveStreamOnlineList

描述

查询当前推流的实时信息。查看指定域名下(或者指定域名下某个应用)的所有正在推的流的信息。

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效
AppName String App名

返回参数

参数 类型 说明
onlineInfo onlineInfoList数组 所有推流信息

数据类型

onlineInfoList

名称 类型 描述
domainName String 域名名
appName String 业务名
streamName String 流名
publishTime DateTime 开始推流的时间点,格式:年-月-日 时:分:秒
publishUrl String 完整的推流url
clientIp String 推流客户端Ip
serverIp String 推流服务端Ip

示例

请求示例

http://api.xycdn.com/v2
?DomainName=test.live.xycdn.com
&access_key=testKey
&action=DescribeLiveStreamOnlineList
&signature=QST9HDo7TVkmcmEZOp3AAWXkA1g%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T13%3A19%3A33Z
&version=2.0

返回示例

{
	"result":{
		"onlineInfo": [{
			"domainName": "test.push.live.xycdn.com",
			"appName": "test",
			"streamName": "stream1",
			"publishTime": "2016-03-08 10:08:03",
			"publishUrl": "rtmp:\/\/test.push.live.xycdn.com:1935\/test\/stream1?time=1457402876&sign=d0bc9054cf89f56a8d40f54d805c7f65",
			"clientIp": "120.132.71.68",
			"serverIp": "222.222.1.105"
		},
		...]
	},
	"code": 0,
	"action": "DescribeLiveStreamOnlineListResp"
}

SetLiveStreamNotifyUrl

描述

设置回调url,指定域名下的流,在推流开始、和推流结束时会向设置的回调url发送请求,通知推流和断流事件。

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效
NotifyUrl String 设置直播流信息推送到的URL地址,必须以http://开头
Enable int 是否开启推流断流通知,1开启 | 0不开启

返回参数

示例

请求示例

http://api.xycdn.com/v2
?DomainName=test.live.xycdn.com
&NotifyUrl=http%3A%2F%2Fnotify.test.xycdn.com%2Fnotify.php
&Enable=1
&access_key=testKey
&action=SetLiveStreamNotifyUrl
&signature=EVvCxBILTqz5SROrim03XBborUY%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T13%3A23%3A07Z
&version=2.0

返回示例

{
	"code": 0,
	"action": "SetLiveStreamNotifyUrlResp"
}

当推流开始和结束时会向配置的这个url发起GET HTTP请求

回调请求参数

参数名 类型 说明
action String 事件类型,包括开始推流事件 on_publish,推流结束事件 on_unpublish
domain String 推流域名
app String 推流的app name
stream String 推流的流名
client_ip String 推流客户端IP
client_port int 推流客户端端口
server_ip String 推流到的CDN 服务器IP
datetime String 事件发生的时间

回调请求示例

比如您配的回调地址为http://124.12.123.123/test.php, 那么当发生推流开始和结束时会触发GET请求,下面以推流开始的on_publish事件为例

http://124.12.123.123/test.php
?action=on_publish
&domain=push.live.test.com
&app=chushou_live
&stream=6d53be3094d2405dab673a7442ef80fe
&client_ip=14.196.11.229
&client_port=8840
&server_ip=211.161.124.72
&datetime=2016-05-17+16%3A02%3A26

DescribeLiveStreamNotifyUrl

描述

获取某个域名下设置的回调url

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效

示例

请求示例

http://api.xycdn.com/v2
?DomainName=test.live.xycdn.com
&access_key=testKey
&action=DescribeLiveStreamNotifyUrl
&signature=fhz%2FNbBXyqIrcKufDVLToct2Yf4%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T14%3A07%3A29Z
&version=2.0

返回参数

参数 类型 说明
notifyUrl String 设置的回调url

返回示例

{
	"code": 0,
	"action": "DescribeLiveStreamNotifyUrlResp",
	"result": {"notifyUrl" : "http://notify.test.xycdn.com/notify.php"}
}

SetLiveStreamRecordConfig

描述

设置录播配置,设置存储转录文件播放的点播域名和回调url,来通知录播文件事件。

限制条件:

  • NotifyUrl 和 VodDomain 不能同时为空

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效
NotifyUrl String 设置转存完成后的回调 URL 地址,必须以http://开头
VodDomain String 录播文件播放的点播域名

返回参数

示例

请求示例

http://api.xycdn.com/v2
?DomainName=test.live.xycdn.com
&NotifyUrl=http%3A%2F%2Fnotify.test.xycdn.com%2Fnotify.php
&VodDomain=vod.live.xycdn.com
&access_key=testKey
&action=SetLiveStreamRecordConfig
&signature=EVvCxBILTqz5SROrim03XBborUY%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T13%3A23%3A07Z
&version=2.0

返回示例

{
	"code": 0,
	"action": "SetLiveStreamRecordConfigResp"
}

当多媒体流录播完成后会向配置的这个url发起由以下字段组成的JSON字符串HTTP POST请求

回调请求参数

参数名 类型 说明
task_id String 任务ID
domain String 推流域名
app String 推流的app name
stream String 推流的流名
tag String 文件标签
vod_url String 录播文件播放地址 Url
vod_md5 String 录播文件的MD5值
vod_size Int 录播文件的大小
vod_duration Int 录播文件的时长
vod_start_datetime String 录播文件的创建时间

回调请求示例

比如您配的回调地址为http://124.12.123.123/test.php, 那么当发生多媒体流录播完成后会触发类似以下调用的POST请求

curl -d '{"task_id": "202cb962ac59075b964b07152d234b70", "domain": "push.live.test.com", "app": "chushou_live", "stream": "6d53be3094d2405dab673a7442ef80fe", "tag": "test.mp4", "vod_url": "http://vod.live.xycdn.com/xxxxx.mp4", "vod_md5": "16A96B9AF2034EC58E43CB92E68F4CD8", "vod_size": 1024, "vod_duration": 120, "vod_start_datetime":"2016-07-14 12:00:00"}' http://124.12.123.123/test.php

DescribeLiveStreamRecordConfig

描述

获取某个域名下录播配置

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效

示例

请求示例

http://api.xycdn.com/v2
?DomainName=test.live.xycdn.com
&access_key=testKey
&action=DescribeLiveStreamRecordConfig
&signature=fhz%2FNbBXyqIrcKufDVLToct2Yf4%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T14%3A07%3A29Z
&version=2.0

返回参数

参数 类型 说明
notifyUrl String 设置的回调url
vodDomain String 转存后使用的点播域名

返回示例

{
	"code": 0,
	"action": "DescribeLiveStreamRecordConfig",
	"result": {
		"notifyUrl" : "http://notify.test.xycdn.com/notify.php",
		"vodDomain" : "vod.live.xycdn.com"
	}
}

DescribeLiveVodFileList

描述

查询直播转存的点播文件信息。

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效
AppName String 业务名
StreamName String 流名
VodFileTag String 推流时,在推流地址的末尾拼上该参数,比如:
rtmp://test.live.xycdn.com/test/stream2?vodFileTag=tag2

返回参数

参数 类型 说明
vodFileList vodFileList数组 该流的所有点播文件访问地址。当一个流断流超过1分钟后,再进行录制,就会额外录制一个文件,所以同一个流会有多个点播文件地址。

数据类型

vodFileList

名称 类型 描述
vodFileTag String 流对应的点播文件标签
vodFileUrl String 录制的点播文件访问地址
startTime DateTime 开始推流的时间点,格式:年-月-日 时-分-秒
status String 流当前的状态
duration int 媒体文件时长

示例

请求示例

http://api.xycdn.com/v2
?AppName=live_test
&DomainName=test.live.xycdn.com
&StreamName=test
&VodFileTag=tag
&access_key=testKey
&action=DescribeLiveVodFileList
&signature=qkdlDimOyinMJ1h3rQH9xWRA%2F0Q%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T14%3A09%3A50Z
&version=2.0

返回示例

{
	"result":{
			"vodFileList": [{
			"vodFileTag": "tag",
			"vodFileUrl": "http://vod.test.com/0C/F8/0CF8B24ACA1A9674CF4747B63CE52802.mp4",
			"startTime": "2016-03-09 18:08:31",
			"duration": 512,
			"status": "done"
		},
		...]
	},
	"code": 0,
	"action": "DescribeLiveVodFileListResp"
}

DeleteLiveStreamVodFile

描述

删除直播转存的点播文件

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效
FileUrl String 以http://开头的点播文件访问地址,比如: http://vod.test.com/0C/F8/0CF8B24ACA1A9674CF4747B63CE52802.mp4

返回参数

示例

请求示例

http://api.xycdn.com/v2
?AppName=live_test
&DomainName=test.live.xycdn.com
&FileUrl=http%3A//vod.test.com/0C/F8/0CF8B24ACA1A9674CF4747B63CE52802.mp4
&access_key=testKey
&action=DeleteLiveStreamVodFile
&signature=qkdlDimOyinMJ1h3rQH9xWRA%2F0Q%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T14%3A09%3A50Z
&version=2.0

返回示例

{
	"code": 0,
	"action": "DeleteLiveStreamVodFileResp"
}

DescribeLiveStreamPublishSpeed

描述

查询单个流的推流速度等信息。

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效
AppName String 业务名
StreamName String 流名

返回参数

参数 类型 说明
clientIp String 推流客户端ip
speed Int 推流速度,单位:kbps
datetime DateTime 该推流速度对应的时间

示例

请求示例

http://api.xycdn.com/v2
?AppName=live_test
&DomainName=test.live.xycdn.com
&StreamName=test
&access_key=testKey
&action=DescribeLiveStreamPublishSpeed
&signature=m4tqccJhDGs98n%2BNoUC78EJ%2FzVQ%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T14%3A12%3A17Z
&version=2.0

返回示例

{
	"result":{
		"speed": 1732696,
		"datetime": "2016-03-08 16:43:44",
		"clientIp": "1.2.3.4"
	},
	"code": 0,
	"action": "DescribeLiveStreamPublishSpeedResp"
}

DescribeLiveStreamPublishSpeedList

描述

批量查询流的推流速度等信息。

请求参数

参数名 是否必须 类型 说明
DomainName String 推流域名,必须为推流域名,拉流域名无效
AppName String 业务名
StreamName String 流名

返回参数

参数 类型 说明
publishSpeedInfo list publishStreamSpeed数组

数据类型

publishStreamSpeed

名称 类型 描述
domainName String 推流域名
appName String 业务名
streamName String 流名
clientIp String 推流客户端ip
speed double 推流速度,单位:kbps
time DateTime 该推流速度对应的时间

示例

请求示例

http://api.xycdn.com/v2
?DomainName=test.live.xycdn.com
&access_key=testKey
&action=DescribeLiveStreamPublishSpeedList
&signature=XCE8o0Ktd%2F8RotNO%2FVchxMDUHVk%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T14%3A15%3A51Z
&version=2.0

返回示例

{
	"result": {
		"publishSpeedInfo": [{
			"domainName": "push.live.test.com",
			"appName": "live_panda",
			"streamName": "732f0b9529a0eb1c873dbbe23f5495b9",
			"clientIp": "113.251.45.234",
			"speed": "1836.9976",
			"time": "2016-04-06 16:54:50"
		},
		{
			"domainName": "push.live.test.com",
			"appName": "live_panda",
			"streamName": "8569a29ba9a59de6470465174647712b",
			"clientIp": "124.203.129.149",
			"speed": "1935.2244476289",
			"time": "2016-04-06 16:54:57"
		},
		...]
	},
	"code": 0,
	"action": "DescribeLiveStreamPublishSpeedListResp"
}

DescribeLiveStreamPullStatInfo

描述

查询单个流一段时间内(最长一天)的下行统计信息:包括带宽和连接数。自然五分钟时间为一个点。

请求参数

参数名 是否必须 类型 说明
DomainName String 拉流域名,必须为拉流域名,推流域名暂不计带宽
AppName String 业务名
StreamName String 流名
StartTime DateTime 查询从该时间以后该流的连接数和带宽信息。格式:年-月-日 时:分:秒 比如 2016-02-26 00:30:00
若不传入该参数,默认为昨天的当前时间
EndTime DateTime 查询该时间之前该流的连接数和带宽信息。格式:年-月-日 时:分:秒 比如 2016-02-27 00:30:00
若不传入该参数,默认为当前时间

返回参数

参数 类型 说明
bandwidthList oneStreambwStat数组 该流一段时间的统计信息

数据类型

oneStreambwStat

名称 类型 描述
bandwidth Int 带宽,单位bps
connections Int 连接数
datetime DateTime 该统计数据对应的时间点,格式:年-月-日 时:分:秒

示例

请求示例

http://api.live.xycdn.com/index.php
?AppName=live_test
&DomainName=test.live.xycdn.com
&StreamName=test
&access_key=testKey
&action=DescribeLiveStreamPullStatInfo
&signature=HbEwzZuFH7zSF6J6SrceXEn4Dt8%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T14%3A19%3A20Z
&version=2.0

返回示例

{
	"result":{
		"bandwidthList": [{
			"datetime": "2016-03-09 11:30:00",
			"bandwidth": 290518200,
			"connections": 314
		},
		{
			"datetime": "2016-03-09 11:35:00",
			"bandwidth": 301063400,
			"connections": 332
		},
		...]
	},
	"code": 0,
	"action": "DescribeLiveStreamPullStatInfoResp"
}

DescribeLiveStreamPullStatInfoList

描述

查询指定域名下所有流或某个流的,当前或某个时间点的下行统计信息:包括在线人数,带宽。

请求参数

参数名 是否必须 类型 说明
DomainName String 拉流域名,必须为拉流域名,推流域名暂不计带宽
AppName String 业务名
StreamName String 流名
DateTime DateTime 时间点,请求该时间点对应的带宽和连接数信息

返回参数

参数 类型 说明
bandwidthStat allStreambwStat数组 所有推流信息

数据类型

allStreambwStat

名称 类型 描述
domainName String 拉流域名
appName String 业务名
streamName String 流名
bandwidth Int 带宽,单位bps
connections Int 连接数
datetime DateTime 该统计数据对应的时间点,格式:年-月-日 时:分:秒

示例

请求示例

http://api.xycdn.com/v2
?DomainName=test.live.xycdn.com
&access_key=testKey
&action=DescribeLiveStreamPullStatInfoList
&signature=2AWi%2FyK4OxMZfv%2FLQ27dfz063Wo%3D
&signature_method=hmac-sha1
&signature_version=1.0
&timestamp=2016-06-06T14%3A21%3A28Z
&version=2.0

返回示例

{
	"result":{
		"bandwidthStat": [{
			"datetime": "2016-03-09 16:15:00",
			"domainName": "test.pull.live.xycdn.com",
			"appName": "test",
			"streamName": "stream1",
			"bandwidth": 1496322800,
			"connections": 1012
		},
		{
			"datetime": "2016-03-09 16:15:00",
			"domainName": "test.pull.live.xycdn.com",
			"appName": "test",
			"streamName": "stream1",
			"bandwidth": 2471000,
			"connections": 2
		},
		...]
	},
	"code": 0,
	"action": "DescribeLiveStreamPullStatInfoList"
}

友情链接:迅雷|迅雷赚钱宝

Copyright © 2015-2017 xycdn.All Rights Reserved 深圳市网心科技有限公司版权所有 粤ICP备14008884号-6 深圳市市场监督管理局企业主体身份公示