科达视讯平台VRS API

录播服务器

1. 本地用户登录
2. 获取文件夹列表
3. 添加文件夹
4. 修改文件夹
5. 删除文件夹
6. 获取节目列表
7. 批量删除节目
8. 批量发布节目
9. 节目批量移动
10. 获取直播室列表
11. 获取预约直播室列表
12. 获取录像室列表
13. 添加录像室
14. 删除录像室
15. 修改录像室
16. 录像室开始录像
17. 录像室停止录像
18. 录像室暂停录像
19. 录像室恢复录像
20. 录像室开始直播
21. 录像室停止直播
22. 获取放像室列表
23. 添加放像室
24. 删除放像室
25. 修改放像室
26. 放像室开始放像
27. 放像室停止放像
28. 放像室暂停放像
29. 放像室恢复放像
30. 获取转码任务信息
31. 批量添加转码任务
32. 批量操作转码任务
33. 获取VRS的IP组
34. 获取VRS API版本信息

名称	本地用户登录
URI	/api/v2/vrs/login
方法	POST
说明	本地用户登录
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
"username": "admin",
"psd": "admin"
}

params说明

参数名称	数据类型	说明
username*	str	用户名
psd*	str	密码

成功回复示例

{
  "username": "admin",
  "usermoid": "65ddde67-7d4f-11e6-ac2d-001410095e12",
  "userdomainmoid": "64fed808-7d4f-11e6-ac2d-001410095e12",
  "rightmask": 3,
  "userrole": 1,
  "token": "0b8160ecc057b369b19926818666829d",
  "success": 1
}

成功回复说明

参数名称	数据类型	说明
username	str	用户名
usermoid	str	用户moid
userdomainmoid	str	用户域moid
rightmask	int	用户权限掩码 1-可下载； 2-可直播； 3-可下载可直播； 4-可点播； 5-可下载可点播； 6-可直播可点播； 7-可下载可直播可点播；
userrole	int	用户角色 0-超级管理员； 1-普通管理员； 2-普通用户；
token	str	返回的SSO cookie值
success	int	是否成功

失败回复示例

{
  "success": 0,
  "maxlocknum": 3,
  "currentnum": 1,
  "unlocktime": 0,
  "error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
maxlocknum	int	最大尝试次数
currentnum	int	当前尝试次数
unlocktime	int	锁定时间
error_code	int	错误码

名称	获取文件夹列表
URI	/api/v2/vrs/program_folder
方法	GET
说明	获取文件夹列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
userdomainmoid	str	获取信息的用户域moid,获取多个时以逗号隔开，默认获取本集团域下的所有用户域信息
prgtypemask	int	请求节目类型掩码 0-ALL(默认)； 1-ASF； 2-MP4；
remoteprgtypemask	int	远端节目类型掩码 0-ALL(默认)； 1-ASF； 2-MP4；
localvrs	int	是否限定本台vrs(一个用户域下有多台vrs的情况下有意义) 0-不限(默认)； 1-本vrs；
prgencmask	int	节目加密类型 0-全部(默认)； 1-不加密； 2-标准加密； 4-国密加密； 6-标准加密或国密加密；
prgauthmask	int	认证类型 0-全部(默认)； 1-普通； 2-强认证；

成功回复示例

{
  "folderinfo": [
    {
      "folderid": 1,
      "foldername": "ALL",
      "prgcount": 219,
      "userdomainmoid": ""
    },
    {
      "folderid": 2,
      "foldername": "UnGroup",
      "prgcount": 209,
      "userdomainmoid": ""
    }
  ],
  "success": 1
}

成功回复说明

参数名称	数据类型	说明
folderinfo	array	文件夹信息
foldername	str	文件夹名字
folderid	int	文件夹id
prgcount	int	文件夹中的文件数
userdomainmoid	str	节目所属用户域
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	添加文件夹
URI	/api/v2/vrs/program_folder
方法	POST
说明	添加文件夹
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
"foldername": "test_folder"
}

params说明

参数名称	数据类型	说明
foldername*	str	文件夹名

成功回复示例

{
"success": 1,
"folderid": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
folderid	int	文件夹id

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	修改文件夹
URI	/api/v2/vrs/program_folder/{id}
方法	PUT
说明	修改文件夹
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
"foldername": "test_folder"
}

params说明

参数名称	数据类型	说明
foldername*	str	文件夹名

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	删除文件夹
URI	/api/v2/vrs/program_folder/{id}
方法	DELETE
说明	修改文件夹
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
"isdelprogram": 1
}

params说明

参数名称	数据类型	说明
foldername*	str	文件夹名
isdelprogram*	int	是否删除文件夹下的节目 0-否； 1-是；

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取节目列表
URI	/api/v2/vrs/program
方法	GET
说明	获取节目列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
folderid*	int	文件夹id
userdomainmoid	str	获取信息的用户域moid,获取多个时以逗号隔开，默认获取本集团域下的所有用户域信息
prgs1page	int	每个页面显示节目数默认显示20个节目
pageid	int	请求的页码默认显示第1页
includename	str	搜索节目的显示名称
orderindex	int	排序引索默认为按发布状态升序，创建时间降序 1-名称； 2-创建时间； 3-时长； 4-大小； 5-发布状态； 6-格式； 7-热度（节目点播次数）；
desc	int	升降序默认为0，无orderindex则不生效 0-升； 1-降；
starttime	int	按时间搜索时的起始时间默认时间搜索不生效时间格式为UNIX时间戳
endtime	int	按时间搜索时的结束时间默认时间搜索不生效时间格式为UNIX时间戳
prgtypemask	int	请求节目类型，默认为0 0-all； 1-asf； 2-mp4；
remoteprgtypemask	int	远端节目类型掩码，默认为0 0-all； 1-asf； 2-mp4；
localvrs	int	是否限定本台vrs(一个用户域下有多台vrs的情况下有意义) 0-不限(默认)； 1-本vrs；
prgencmask	int	节目加密类型 0-全部(默认)； 1-不加密； 2-标准加密； 4-国密加密； 6-标准加密或国密加密；
prgauthmask	int	认证类型 0-全部(默认)； 1-普通； 2-强认证；

成功回复示例

{
  "prgcount": 219,
  "pageid": 1,
  "prginfo": [
    {
      "prggid": 749,
      "prgalias": "0512110000040-20161028172529544",
      "createtime": 1478071908,
      "issuetime": 0,
      "prgstate": 0,
      "prgencmode": 1,
      "prgauthmode": 1,
      "prgwatermark": 1,
      "prgskid": "",
      "prgdesc": "",
      "prgallduration": 585,
      "prgallsize": 5809,
      "streamjsonpath": "",
      "vrsmoid": "",
      "userdomainmoid": "",
      "prgdetail": [
        {
          "prgid": 292,
          "prggindex": 0,
          "prgname": "0512110000040-20161028172529544.asf",
          "prgtype": "asf",
          "ip": 2130706433,
          "relativepath": "/uploadmedia/",
          "prgsize": 5809,
          "prgduration": 585,
          "prgvideostreamcount": 0,
          "presenter": "",
          "vodnum": 0,
          "coverpath": "",
          "prgtab": [],
          "covername": "",
          "downloadnum": 0
        }
      ]
    }
  ],
  "success": 1
}

成功回复说明

参数名称	数据类型	说明
prgcount	int	节目总个数
pageid	int	返回的页码
prginfo	array	节目信息
prggid	int	节目gid
prgalias	str	节目显示名称
createtime	int	节目创建时间
issuetime	int	节目发布时间
prgstate	int	节目状态 0-未发布； 1-发布；
prgencmode	int	文件加密模式 1-不加密； 2-标准加密； 4-国密加密；
prgauthmode	int	认证模式 1-普通； 2-强认证；
prgwatermark	int	水印开关 0-关闭； 1-开启；
prgskid	str	文件skid
prgdesc	str	节目描述
prgallduration	int	节目总时长（秒）
prgallsize	int	节目总大小（byte）
streamjsonpath	str	Json文件位置
vrsmoid	str	节目所属vrs的moid
userdomainmoid	str	节目所属用户域moid
prgdetail	array	节目详细信息
prgid	int	节目id
prggindex	int	节目索引
prgname	str	节目名称
prgtype	str	节目文件后缀
ip	int	ip
relativepath	str	存放相对路径
prgsize	int	节目大小（byte）
prgduration	int	节目时长(秒)
prgvideostreamcount	int	文件视频流数
presenter	str	主持人
vodnum	int	点播次数
coverpath	str	封面文件路径
prgtab	array	标签(定义一个包含五个元素的数组)
covername	str	封面文件名
downloadnum	int	下载次数
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	批量删除节目
URI	/api/v2/vrs/program
方法	DELETE
说明	批量删除节目
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
  "prgdelpckinfo": [
    {
      "prggid": 1,
      "enforcedel": 1
    }
  ]
}

params说明

参数名称	数据类型	说明
prgdelpckinfo*	array	删除节目信息列表
prggid*	str	节目gid
enforcedel*	int	是否强制删除 0-否； 1-是；

成功回复示例

{
  "success": 1,
  "prgdelpckinfo": [
    {
      "prggid": 1,
      "delerrno": 0
    }
  ]
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
prgdelpckinfo	array	节目信息
prggid	int	节目gid
delerrno	int	删除错误码

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	批量发布节目
URI	/api/v2/vrs/program_release_batch
方法	PUT
说明	批量发布节目
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
  "info": [
    {
      "prggid": 1,
      "prgstate": 1
    }
  ]
}

params说明

参数名称	数据类型	说明
info*	array	上传信息
prggid*	int	节目gid
prgstate*	int	是否发布 0-否； 1-是；

成功回复示例

{
  "success": 1,
  "info": [
    {
      "prggid": 1,
      "prgstate": 1,
      "relerrno": 0
    }
  ]
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
info	array	上传信息
prggid	int	节目gid
prgstate	int	是否发布 0-否； 1-是；
relerrno	int	发布错误码 0代表成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	节目批量移动
URI	/api/v2/vrs/program_to_folder
方法	PUT
说明	节目批量移动
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
  "prginfo": [
    {
      "prggid": 1
    },
    {
      "prggid": 2
    }
  ],
  "dstfolderid": 1
}

params说明

参数名称	数据类型	说明
prginfo*	array	所要移动的节目gid列表
prggid*	int	节目gid
dstfolderid*	int	目标文件夹id

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取直播室列表
URI	/api/v2/vrs/liveroom
方法	GET
说明	获取直播室列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
userdomainmoid	str	获取信息的用户域moid,获取多个时以逗号隔开，默认获取本集团域下的所有用户域信息
livetype	int	请求节目的类型 0-HTML5直播(默认)； 1-ASF直播； 2-HTML5与ASF直播；
prgs1page	int	每个页面显示节目数默认显示20个节目
pageid	int	请求的页码默认显示第1页
includename	str	搜索字符
orderindex	int	排序引索默认为按创建时间升序 1-名称； 2-创建时间； 7-热度（节目点播次数）；
desc	int	升降序默认为0，无orderindex则不生效 0-升； 1-降；

成功回复示例

{
  "roomcount": 1,
  "pageid": 1,
  "roomstate": [
    {
      "roomid": 33554433,
      "roomidstr": "33554433",
      "roomname": "mcu488544-1-20141024173658",
      "userdomainmoid": "64fed808-7d4f-11e6-ac2d-001410095e12",
      "prgid": 2128,
      "elapse": 15,
      "lcastpoint": "mcu488544-1-20141024173658",
      "livestreampath": "/hlsfile/2016/10/14/20161014172709_86/Readme.json",
      "livesnapshotpath": "hlsfile/2017/08/25/20170825135029_884001/snapshot.jpeg",
      "mte164": "0008841",
      "livestatnum": 0,
      "createtime": 0,
      "encmode": 1,
      "authmode": 1,
      "prgwatermark": 0,
      "shorturl": ""
    }
  ],
  "success": 1
}

成功回复说明

参数名称	数据类型	说明
pageid	int	返回的页码
roomcount	int	直播室的数量
roomstate	array	直播室信息
roomid	int	直播室id
roomidstr	str	直播室id的字符串
roomname	str	直播室名称
userdomainmoid	str	直播室所属用户域moid
prgid	int	节目id
elapse	int	节目已播放时间
lcastpoint	str	直播点
livestreampath	str	直播源描述文件，直播所需IP取‘获取VRS的IP组’API返回的IP，需要将COOKIE中的SSO_COOKIE_KEY以参数带入，参数名sso_token(URL后'?'分割，如?sso_token=***)
livesnapshotpath	str	直播截帧图片的路径
mte164	str	会议E164号/终端E164号(终端呼叫)
livestatnum	int	直播统计人数
createtime	int	直播室创建时间
encmode	int	文件加密模式，非商密VRS一律为不加密 1-不加密； 2-标准加密； 4-国密加密；
authmode	int	认证模式，非商密VRS一律为普通 1-普通； 2-强认证；
prgwatermark	int	水印开关 0-关闭； 1-开启；
shorturl	str	短链接
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取预约直播室列表
URI	/api/v2/vrs/resroom
方法	GET
说明	获取预约直播室列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
userdomainmoid	str	获取信息的用户域moid,获取多个时以逗号隔开，默认获取本集团域下的所有用户域信息
prgs1page	int	每个页面显示节目数默认显示20个节目
pageid	int	请求的页码默认显示第1页
includename	str	搜索字符

成功回复示例

{
  "success": 1,
  "livecount": 1,
  "pageid": 1,
  "liveinfo": [
    {
      "confname": "liveconf",
      "starttime": "2016-10-18 15:00:00",
      "encmode": 1
    }
  ]
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
livecount	int	预约直播总数
pageid	int	返回的页码
liveinfo	array	预约直播信息
confname	str	会议名
starttime	str	会议时间
encmode	int	文件加密模式，非商密VRS一律为不加密 1-不加密； 2-标准加密； 4-国密加密；

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取录像室列表
URI	/api/v2/vrs/recroom
方法	GET
说明	获取录像室列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
userdomainmoid	str	获取信息的用户域moid,获取多个时以逗号隔开，默认获取本集团域下的所有用户域信息
roomid	int	录像室号码默认0，返回全部，指定roomid后，则下面参数全不生效
prgs1page	int	每个页面显示节目数默认显示20个节目
pageid	int	请求的页码默认显示第1页
includename	str	搜索字符

成功回复示例

{
  "roomcount": 1,
  "pageid": 1,
  "roomstate": [
    {
      "roomcfg": {
        "roomid": 6,
        "userdomainmoid": "64fed808-7d4f-11e6-ac2d-001410095e12",
        "roomname": "0512110000077-rec",
        "roomno": "0512110000077",
        "roompwd": "",
        "roomtype": 2,
        "opertype": 0,
        "vflag": 0,
        "vformat": 0,
        "vwidth": 0,
        "vheight": 0,
        "vtype": 0,
        "vframe": 0,
        "atype": 1,
        "aformat": 98,
        "aflag": 1,
        "confrate": 0,
        "preprgname": "0512110000077",
        "prgtype": 1,
        "bpublish": 0,
        "livetype": 0,
        "createtime": 0
      },
      "roomstate": 0,
      "recstate": 0,
      "lcaststate": 0,
      "gkstate": 1,
      "sipstate": 0,
      "shorturl": "",
      "topic": "",
      "content": "",
      "chairman": "",
      "recelapse": 0,
      "lcastelapse": 0,
      "recobj": "",
      "prgname": "",
      "lcastname": "",
      "livestreampath": "",
      "livesnapshotpath": "",
      "mte164": "",
      "livestarttime": 0,
      "encmode": 1,
      "authmode": 1,
      "detail": [
        {
          "vformat": 0,
          "vwidth": 0,
          "vheight": 0,
          "vframe": 0
        }
      ]
    }
  ],
  "success": 1
}

成功回复说明

参数名称	数据类型	说明
roomcount	int	录像室总数
pageid	int	返回页码
roomstate	array	录像室详细信息
roomcfg	object	录像室基本信息
roomid	int	录像室id
userdomainmoid	str	录像室所属用户域moid
roomname	str	录像室名字
roomno	str	录像室E164
roompwd	str	录像室E164注册密码
roomtype	int	录像室类型 0-仅录像； 1-仅直播； 2-边录边播；
opertype	int	操作类型 0-自动； 1-手动；
vtype	int	视频格式是否自定义 0-自动； 1-自定义；
vformat	int	视频格式 31-H.261； 34-H.263； 97-MPEG4； 106-H.264； 108-H.265；
vwidth	int	视频宽
vheight	int	视频高
vflag	int	视频标识 0-BP； 1-HP；
vframe	int	视频帧率
atype	int	音频格式是否自定义 0-自动； 1-自定义格式；
aformat	int	音频格式 102-MPEG-4 AAC LC； 103-MPEG-4 AAC LD； 99-G.719； 98-G.722.1 C； 96-MP3； 18-G.729； 15-G.728； 9-G.722； 8-G.711 A； 0-G.711 U； 127-OPUS；
aflag	int	音频标识 1-非立体声； 2-立体声；
confrate	int	会议码率，0表示自适应
preprgname	str	文件显示名称
prgtype	int	文件名后缀类型 1-asf； 2-wmv；
bpublish	int	是否发布 0-否； 1-是；
livetype	int	保留字段，目前不使用
createtime	int	录像室创建时间
roomstate	int	录像室状态 0-空闲； 1-占用；
recstate	int	录像室状态 0-未录制； 1-录制中； 2-录像暂停；
lcaststate	int	直播状态 0-未直播； 1-直播中；
gkstate	int	GK注册状态 0-未配置； 1-注册成功； 2-注册失败；
sipstate	int	sip状态 0-未配置； 1-注册成功； 2-注册失败；
shorturl	str	该录像室直播时对应的短链接
topic	str	该录像室直播时的主题
content	str	该录像室直播时的内容
chairman	str	该录像室直播时的主持人
recelapse	int	录像时间（秒），录像室开始录像（仅直播的录像室开始直播）到当前的时间
lcastelapse	int	直播时间（秒），直播开始到当前的时间
recobj	str	正在录像设备
prgname	str	节目完整名称
lcastname	str	直播名称
livestreampath	str	直播描述文件
livesnapshotpath	str	直播截帧图片的路径
mte164	str	会议E164号/终端E164号(终端呼叫)
livestarttime	int	直播开始时间
encmode	int	文件加密模式，非商密VRS一律为不加密 0-录像室未被占用； 1-不加密； 2-标准加密； 4-国密加密；
authmode	int	认证模式，非商密VRS一律为普通 0-录像室未被占用； 1-普通； 2-强认证；
detail	array	录像室开启后具体状态
vformat	int	视频格式 31-H.261； 34-H.263； 97-MPEG4； 106-H.264；
vwidth	int	视频宽
vheight	int	视频高
vframe	int	视频帧率
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	添加录像室
URI	/api/v2/vrs/recroom
方法	POST
说明	添加录像室
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
  "room": {
    "roomname": "0512110000077-rec",
    "roomno": "0512110000077",
    "roompwd": "",
    "roomtype": 2,
    "opertype": 0,
    "vtype": 0,
    "vformat": 0,
    "vwidth": 0,
    "vheight": 0,
    "vflag": 0,
    "vframe": 0,
    "atype": 1,
    "aformat": 98,
    "aflag": 1,
    "confrate": 0,
    "preprgname": "0512110000077",
    "prgtype": 1,
    "bpublish": 0
  }
}

params说明

参数名称	数据类型	说明
room*	object	录像室信息
roomname*	str	录像室名字
roomno*	str	录像室E164
roompwd*	str	录像室E164注册密码
roomtype*	int	录像室类型 0-仅录像； 1-仅直播； 2-边录边播；
opertype	int	预留字段，目前不使用
vtype*	int	视频格式是否自定义默认自动 0-自动； 1-自定义；
vformat*	int	视频格式 106-H.264； 108-H.265；
vwidth*	int	视频宽
vheight*	int	视频高
vflag	int	视频标识默认BP 0-BP； 1-HP；
vframe*	int	视频帧率
atype*	int	音频格式是否自定义默认自动 0-自动； 1-自定义；
aformat*	int	音频格式 102-MPEG-4 AAC LC； 103-MPEG-4 AAC LD； 99-G.719； 98-G.722.1 C； 96-MP3； 18-G.729； 15-G.728； 9-G.722； 8-G.711 A； 0-G.711 U； 127-OPUS；
aflag*	int	音频标识 1-非立体声； 2-立体声；
confrate*	int	会议码率
preprgname*	str	文件显示名称
prgtype*	int	文件名后缀类型 1-asf； 2-wmv；
bpublish*	int	是否发布 0-否； 1-是；

成功回复示例

{
"success": 1,
"roomid": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
roomid	int	录像室id

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	删除录像室
URI	/api/v2/vrs/recroom/{id}
方法	DELETE
说明	删除录像室
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode
_method		若浏览器不支持DELETE，则使用POST请求，并在请求参数中带上_method参数，并设置其值为DELETE

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	修改录像室
URI	/api/v2/vrs/recroom/{id}
方法	PUT
说明	修改录像室
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
room*	object	录像室信息
roomname*	str	录像室名字
roomno*	str	录像室E164
roompwd*	str	录像室E164注册密码
roomtype*	int	录像室类型 0-仅录像； 1-仅直播； 2-边录边播；
opertype	int	预留字段，目前不使用
vtype*	int	视频格式是否自定义默认自动 0-自动； 1-自定义；
vformat*	int	视频格式 106-H.264； 108-H.265；
vwidth*	int	视频宽
vheight*	int	视频高
vflag	int	视频标识默认BP 0-BP； 1-HP；
vframe*	int	视频帧率
atype*	int	音频格式是否自定义默认自动 0-自动； 1-自定义；
aformat*	int	音频格式 102-MPEG-4 AAC LC； 103-MPEG-4 AAC LD； 99-G.719； 98-G.722.1 C； 96-MP3； 18-G.729； 15-G.728； 9-G.722； 8-G.711 A； 0-G.711 U； 127-OPUS；
aflag*	int	音频标识 1-非立体声； 2-立体声；
confrate*	int	会议码率
preprgname*	str	文件显示名称
prgtype*	int	文件名后缀类型 1-asf； 2-wmv；
bpublish*	int	是否发布 0-否； 1-是；

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	录像室开始录像
URI	/api/v2/vrs/recroom/{id}/startrec
方法	PUT
说明	录像室开始录像
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	录像室停止录像
URI	/api/v2/vrs/recroom/{id}/stoprec
方法	PUT
说明	录像室停止录像
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	录像室暂停录像
URI	/api/v2/vrs/recroom/{id}/pauserec
方法	PUT
说明	录像室暂停录像
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	录像室恢复录像
URI	/api/v2/vrs/recroom/{id}/resumerec
方法	PUT
说明	录像室恢复录像
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	录像室开始直播
URI	/api/v2/vrs/recroom/{id}/startlive
方法	PUT
说明	录像室开始直播
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	录像室停止直播
URI	/api/v2/vrs/recroom/{id}/stoplive
方法	PUT
说明	录像室停止直播
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取放像室列表
URI	/api/v2/vrs/playroom
方法	GET
说明	获取放像室列表
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
userdomainmoid	str	获取信息的用户域moid,获取多个时以逗号隔开，默认获取本集团域下的所有用户域信息
roomid	int	录像室号码默认0，返回全部，指定roomid后，则下面参数全不生效
prgs1page	int	每个页面显示节目数默认显示20个节目
pageid	int	请求的页码默认显示第1页
includename	str	搜索字符

成功回复示例

{
  "success": 1,
  "roomcount": 1,
  "pageid": 1,
  "roomstate": [
    {
      "roomcfg": {
        "roomid": 1,
        "userdomainmoid": "64fed808-7d4f-11e6-ac2d-001410095e12",
        "streamjsonpath": "/api/v2/vrs/upstream/ee040aae-b4d3-11e8-98b0-a4bf0103b6b8/uploadmedia/1234560000082-320180702162103300-7-3/Readme.json",
        "roomname": "0512110000070-player",
        "roomno": "0512110000070",
        "roompwd": "",
        "autoplay": 0,
        "encrypt": 0,
        "encryptkey": "",
        "cryptkeylen": 0,
        "prgalias": "ggg11",
        "prgid": 652,
        "ip": 2130706433,
        "path": "/uploadmedia/",
        "prgname": "ggg-20160531013150623_1_4.asf",
        "createtime": 0
      },
      "roomstate": 0,
      "playstate": 0,
      "gkstate": 1,
      "sipstate": 0,
      "encmode": 1,
      "authmode": 1,
      "elapse": 0,
      "duraion": 0,
      "playobj": ""
    }
  ]
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
roomcount	int	放像室总数
pageid	int	返回的页码
roomstate	array	放像室详细信息
roomcfg	object	放像室基本信息
roomid	int	放像室的id
userdomainmoid	str	放像室所属用户域moid
streamjsonpath	str	放像文件的MP4格式，Json文件位置
roomname	str	放像室名字
roomno	str	放像室的E164
roompwd	str	放像室的E164注册密码
autoplay	int	预留字段，目前不使用
encrypt	int	加密 0-自适应； 1-不加密； 2-Aes加密；
encryptkey	str	密钥
cryptkeylen	int	加密长度
prgalias	str	显示名称
prgid	int	节目id
ip	int	ip
path	str	相对路径
prgname	str	节目名字
createtime	int	放像室创建时间
roomstate	int	放像室状态 0-未占用； 1-占用；
playstate	int	放像状态 0-已停止； 1-正在播放； 2-暂停；
gkstate	int	Gk状态 0-未配置； 1-注册成功； 2-注册失败；
sipstate	int	Sip状态 0-未配置； 1-注册成功； 2-注册失败；
encmode	int	加密模式，非商密VRS一律为不加密 0-放像室未被占用； 1-不加密； 2-标准加密； 4-国密加密；
authmode	int	认证模式，非商密VRS一律为普通 0-放像室未被占用； 1-普通； 2-强认证；
elapse	int	节目已经放了多久（秒）
duraion	int	节目总时长（秒）
playobj	str	放像给哪个会议

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	添加放像室
URI	/api/v2/vrs/playroom
方法	POST
说明	添加放像室
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
  "room": {
    "roomname": "0512110000071-player",
    "roomno": "0512110000071",
    "roompwd": "888888",
    "autoplay": 0,
    "encrypt": 0,
    "encryptkey": "",
    "cryptkeylen": 0,
    "prgalias": "79rec-20160718225654524",
    "prgid": 453,
    "ip": 2886775670,
    "path": "/asffile/",
    "prgname": "79rec-20160718225654524.asf"
  }
}

params说明

参数名称	数据类型	说明
room*	object	放像室信息
roomname*	str	放像室名字
roomno*	str	放像室的E164
roompwd*	str	放像室的E164注册密码
autoplay*	int	是否自动播放 0-自动； 1-手动；
encrypt*	int	加密 0-自适应； 1-不加密； 2-Aes加密；
encryptkey*	str	密钥
cryptkeylen*	int	加密长度（最大长度，密匙长度不够，则取密匙长度）
prgalias*	str	指定放像的节目的显示名称
prgid*	int	节目id
ip*	int	ip
path*	str	相对路径
prgname*	str	节目名字

成功回复示例

{
"success": 1,
"roomid": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
roomid	int	放像室id

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	删除放像室
URI	/api/v2/vrs/playroom/{id}
方法	DELETE
说明	删除放像室
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode
_method		若浏览器不支持DELETE，则使用POST请求，并在请求参数中带上_method参数，并设置其值为DELETE

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	修改放像室
URI	/api/v2/vrs/playroom/{id}
方法	PUT
说明	修改放像室
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

params说明

参数名称	数据类型	说明
room*	object	放像室信息
roomname*	str	放像室名字
roomno*	str	放像室的E164
roompwd*	str	放像室的E164注册密码
autoplay*	int	是否自动播放 0-自动； 1-手动；
encrypt*	int	加密 0-自适应； 1-不加密； 2-Aes加密；
encryptkey*	str	密钥
cryptkeylen*	int	加密长度（最大长度，密匙长度不够，则取密匙长度）
prgalias*	str	指定放像的节目的显示名称
prgid*	int	节目id
ip*	int	ip
path*	str	相对路径
prgname*	str	节目名字

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	放像室开始放像
URI	/api/v2/vrs/playroom/{id}/startplay
方法	PUT
说明	放像室开始放像
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	放像室停止放像
URI	/api/v2/vrs/playroom/{id}/stopplay
方法	PUT
说明	放像室停止放像
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	放像室暂停放像
URI	/api/v2/vrs/playroom/{id}/pauseplay
方法	PUT
说明	放像室暂停放像
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	放像室恢复放像
URI	/api/v2/vrs/playroom/{id}/resumeplay
方法	PUT
说明	放像室恢复放像
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

成功回复示例

{
"success": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取转码任务信息
URI	/api/v2/vrs/transtask
方法	GET
说明	获取转码任务信息
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
userdomainmoid	str	获取信息的用户域moid,获取多个时以逗号隔开，默认获取本集团域下的所有用户域信息
prggid	int	转码节目prggid
state	int	任务状态默认返回全部 0-全部； 3-已完成； 4-未完成；
prgs1page	int	每个页面显示节目数默认显示20个节目
pageid	int	请求的页码默认显示第1页
includename	str	检索字符
orderindex	int	排序索引默认不排序 1-节目名； 2-进度； 3-目标格式； 4-状态；
desc	int	升降序降默认升序 0-升； 1-降；

成功回复示例

{
  "success": 1,
  "prgcount": 1,
  "pageid": 1,
  "taskinfo": [
    {
      "dsttype": 2,
      "percent": 100,
      "picmergerstyle": 0,
      "prgalias": "wyy-1-20170712155951410",
      "prggid": 49,
      "restype": 1,
      "state": 5,
      "taskerrno": 0
    }
  ]
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
prgcount	int	转码任务总数
pageid	int	返回页码
taskinfo	array	录像室详细信息
dsttype	int	目标文件格式 2-MP4；
percent	int	转码进度
picmergerstyle	int	画面合成风格 0-未开启画面合成； 200-两画面合成，主视频在辅视频内的右下角； 201-两画面合成，辅视频在主视频内的右下角； 202-两画面合成，两画面相等； 300-三画面合成，大小相等，一上两下； 301-三画面合成，大小相等，一左两右； 400-四画面合成,等大；
prgalias	str	转码节目别名
prggid	int	转码节目prggid
restype	int	输出分辨率类型 1-一转一； 2-一转多；
state	int	转码任务状态 1-就绪； 2-转码； 3-暂停； 4-中断； 5-完成； 6-异常；
taskerrno	int	转码任务异常码 0-无错误； 1-直播中断； 2-远端磁盘断链； 3-磁盘空间不足； 4-用户暂停； 5-CPU或GPU资源不足； 10-文件异常；

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	批量添加转码任务
URI	/api/v2/vrs/transtask
方法	POST
说明	批量添加转码任务
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
  "addparams": [
    {
      "prggid": 1,
      "restype": 1,
      "picmergerstyle": 0,
      "dsttype": 2,
      "enforcetrans": 0
    }
  ]
}

params说明

参数名称	数据类型	说明
addparams*	array	添加转码节目参数
prggid*	int	转码节目prggid
restype*	int	目标分辨率 1-原始； 2-1转多；
picmergerstyle*	int	画面合成风格 0-不开启画面合成； 200-两画面合成，主视频在辅视频内的右下角； 201-两画面合成，辅视频在主视频内的右下角； 202-两画面合成，两画面相等； 300-三画面合成，大小相等，一上两下； 301-三画面合成，大小相等，一左两右； 400-四画面合成,等大；
dsttype*	int	目标文件格式 2-MP4；
enforcetrans	int	是否强制转码

成功回复示例

{
  "success": 1,
  "addreturns": [
    {
      "prggid": 1,
      "prgalias": "abc",
      "adderrno": 0
    }
  ]
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
addreturns	array	添加节目返回参数
prggid	int	转码节目prggid
prgalias	str	转码节目别名
adderrno	int	添加节目错误码，0表示成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	批量操作转码任务
URI	/api/v2/vrs/transtask
方法	PUT
说明	批量操作转码任务
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token
params		请求内容，以JSON形式发送，需进行UrlEncode

params示例

{
  "operateparams": [
    {
      "prggid": 1,
      "opcode": 2
    }
  ]
}

params说明

参数名称	数据类型	说明
operateparams*	array	操作转码节目参数
prggid*	int	转码节目prggid
opcode*	int	操作码 1-开始； 2-暂停； 3-取消；

成功回复示例

{
  "success": 1,
  "operatereturns": [
    {
      "prggid": 1,
      "prgalias": "abc",
      "operrno": 0
    }
  ]
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
operatereturns	array	操作节目返回参数
prggid	int	转码节目prggid
prgalias	str	转码节目别名
operrno	int	操作节目错误码，0表示成功

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取VRS的IP组
URI	/api/v2/vrs/vrsip
方法	GET
说明	获取VRS的IP组
最低支持版本	1

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token

成功回复示例

{
  "success": 1,
  "ipinfo": [
    {
      "emisp": 0,
      "ip": 0,
      "port": 80
    }
  ]
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
ipinfo	array	ip信息
emisp	int	网络运营商ID, 0-未知； 1-中国电信； 2-中国联通； 3-中国移动； 4-有线通； 5-铁通； 6-海外； 7-本地； 8-其他；
ip	int	ip
port	int	port

失败回复示例

{
"success": 0,
"error_code": 0
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	错误码

名称	获取VRS API版本信息
URI	/api/vrs/version
方法	GET
说明	获取VRS API版本信息
最低支持版本	1

成功回复示例

{
  "success": 1,
  "version": "6.0.0.0.0.20190603",
  "api_level": 1
}

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
version	str	版本信息
api_level	int	VRS API版本标识，请与VRS API说明文档中的各个接口的最低支持版本号作对比，若小于最低支持版本号，则该接口不支持当前版本的API调用

失败回复示例

{
"success": 0,
"error_code": 112230
}

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号

科达视讯平台VRS API

V6.1.0.4.0.20201230

API_Level:2

录播服务器