PaaS API文档草稿箱

API简介

• 微吼云API服务，是通过微吼云对外提供的安全，低成本，高可用的服务，用户可以通过本文档提供的接口，在任何时间、任何地点、任何互联网设备上进行调用。基于微吼云API，用户可以搭建出各种基于视频的应用。

接入步骤

步骤1 ： 注册开发者

1、申请开通微吼云账号

• 微吼云注册地址

2、联系运营人员，提供资料，开通开发者认证

• 联系运营人员

步骤2 ：接入前准备

1、登录微吼云控制台

• 控制台地址

2、创建应用

• 进入控制台后，创建应用位于右上角头像下面，填写应用名称和应用简介、选择用用类型后 保存即可创建应用

3、开通服务

• 创建应用后会默认开通直播服务，可根据自身业务形态，选择开通点播服务、文档服务以及聊天服务
• 开通服务按钮位于应用管理应用的下方，点击后选择对应开通的即可

4、获取app_id、secret_key

• 获取方式： 控制台->对应应用->设置->应用信息
• 应用创建完毕后，微吼云服务会对应用颁发app_id和secret_key，app_id用以标识应用信息，secret_key为 双方加密的通讯秘钥为微吼云和用户本身持有，请妥善保管

步骤3 ： 开始接入

1、签名函数集成

• API签名机制

2、根据服务接入API

• API列表

API 调用方式

对API 的调用是通过向 API 的服务端地址发送 HTTP GET 请求，并按照接口说明在请求中加入相应请求参数来完成的。根据请求的处理情况，系统会返回处理结果。

主要根据以下四点来说明：

• 调用结构

• 公共参数

• 返回结果

• 签名机制

请求结构

服务地址

通信协议

API通信支持HTTP和HTTPS通道，可根据服务需要自行选择

字符编码

请求及返回结果都使用 UTF-8 字符集进行编码。

公共参数

• 公共参数包括 公共请求参数、公共返回参数以及公共错误码部分。

公共请求参数

• 是指每个接口都需要使用到的请求参数。

公共返回参数

• 用户发送的每次接口调用请求，无论成功与否，系统都会返回一个code给用户。
• 如无特殊说明，接口中的出参均为data中的数据

• JSON

{
    "code": 200,  // 返回结果状态码
    "msg": "",      // 错误信息
    "data": {       // 返回结果数据
        "room_id": "lss_69178ce4"
    }
}

公共错误码

返回结果

• 调用 API 服务后返回数据采用统一格式，返回的 HTTP 状态码为 2xx，代表调用成功。返回 4xx 或 5xx 的 HTTP 状态码代表调用失败。

• 本文档中的返回示例为了便于用户查看，做了格式化处理，实际返回结果是没有进行换行、缩进等处理的。

成功结果

• 调用成功返回的数据为JSON格式
• JSON 示例

{
    "code": 200,  // 返回结果状态码
    "msg": "",      // 错误信息
    "data": {       // 返回结果数据
        "room_id": "lss_69178ce4"
    }
}

错误结果

• 调用接口出错后，将不会返回结果数据。调用方可根据接口中对应的错误码查找原因。

• 当调用出错时，HTTP 请求返回一个 4xx 或 5xx 的 HTTP 状态码。可以联系微吼云客服，提供具体的请求参数以便我们尽快帮您解决问题。

签名机制

• API服务会对每个访问的请求进行身份验证，所以无论使用 HTTP 还是 HTTPS 协议提交请求，都需要在请求中包含签名（sign）信息。通过使用app_id、secret_key以及参数信息进行MD5摘要运算来验证请求的发送者身份。

• app_id和secret_key 由微吼云官方颁发给访问者（ 控制台->对应应用->设置->应用信息），其中：

• app_key 用于标识应用的信息。

• secret_key 是用于加密签名字符串和服务器端验证签名字符串的密钥，必须严格保密，只有微吼云和用户知道。

用户在访问时，按照下面的方法对请求进行签名处理：

1 、按照参数名称的字典顺序对请求中所有的请求参数（包括文档中描述的“公共请求参数”和给定了的请求接口的自定义参数，但不能包括“公共请求参数”中提到 sign 参数本身）进行排序。

• 注意：当使用GET方法提交请求时，这些参数就是请求URI中的参数部分（即 URI 中“?”之后由“&”连接的部分）。 对请求中所有参数（包括app_id）进行字典序排序。
• javaScript代码示例

	// 用户秘钥
	var secret_key = "f145b675f441cc00dd3e55746a0f4780";
	
	// 用户参数
	var param = {
		"room_id" : "lss_5b2cef",
		"app_id" : "3eb7261"
	}
	
	// 按名称字段排序后结果是
	param = {
		"app_id" : "3eb7261"
		"room_id" : "lss_5b2cef",
	}

2、 按 键值键值 方式拼接成字符串。

• javaScript代码示例

	// 用户参数来自上一个例子
	// 拼接出来的字符串就是
	var signParam = "app_idlss_5b2cefroom_idlss_5b2cef"

3 、在此字符串首尾各拼接一次secret_key。

• javaScript代码示例

	// 用户参数来自上一个例子
	 signParam="f145b675f441cc00dd3e55746a0f4780app_idlss_5b2cefroom_idlss_5b2ceff145b675f441cc00dd3e55746a0f4780"

4 、对拼接后的字符串进行md5，得到sign。

• javaScript代码示例

	// 用户参数来自上一个例子
	signParam=md5("f145b675f441cc00dd3e55746a0f4780app_idlss_5b2cefroom_idlss_5b2ceff145b675f441cc00dd3e55746a0f4780")
	
signParam = "e316af53a0dc14d42209fcad750a78c9";

5 、将得到的sign作为请参数之一传递。

• javaScript代码示例

	// 用户参数来自上一个例子
	param['sign'] =  "e316af53a0dc14d42209fcad750a78c9";
	// 添加sign后，为最终的请求参数

6 、VOP服务器收到所有参数后，根据app_id取得对应的secret_key，然后依照同样的算法计算sign。验证与传递的sign是否一致。

• 完整代码流程以PHP代码为例

// 由微吼云提供
$secret_key = "f145b675f441cc00dd3e55746a0f4780";

// 用户参数示例
$params = [
    "room_id"=> "123456789",
    "app_id"=> "3eb7261",
    "signed_at"=> "1484620708"
];

// 按参数名升序排列
ksort($params);

// 初始化签名字串
$sign = '';

// 将键值组合连接到签名字串上
foreach ($arr as $k => $v) {
$sign .= $k.$v;
}

// 将签名字串前后两端加上秘钥进行MD5运算
$sign = md5($secret_key.$str.$secret_key);

// 将sign签名放到请求数据中
$params["sign"] = $sign;

• 签名函数以PHP代码为例

    /**
     * 获取API签名
     * @param array $arr
     * @param $secret_key
     * @return string
     */
	function sign( array $arr, $secret_key ) {
		// 去除因重复调用可能产生的sign字段
		unset($arr['sign']);
		
		// 按键名称排序
		ksort($arr);
		
		// 初始化签名字串
		$str = '';
		
		// 将键值组合连接到签名字串上
		foreach ($arr as $k => $v) {
			$str .= $k.$v;
		}
		// 将签名字串前后两端加上秘钥
		$str = $secret_key.$str.$secret_key;
		
		// 返回MD5运算后的结果
		return md5($str);
    }

生成AccessToken

API 地址

api.yun.vhall.com/api/v1/base/create-access-token

描述

用于SDK权限校验，accessToken即权限，调用接口生成accessToken将传入SDK，SDK在请求时会附带accessToken, SDK将按您赋予的权限进行相关的权限验证，如果您同时集成多个服务，可在入参时传入相应服务的权限值

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

参数示例

{
	third_party_user_id : "vhall_user_nelsonking", // 第三方用户ID
	expire_time : 2017/01/01 00:00:00, // 过期时间
	publish_stream : "lss_af793b0e,lss_b328234c", // 推流： “房间ID”
	chat : "ch_af793b0e,ch_cb593b12",// 发聊天： “频道ID”
	operate_document : "ch_2ca93b03,ch_eb493b22",// 演示文档操作： “频道ID”
}
// 各权限对应的值为其权限类别的资源ID
// 权限列表可有多个，无先后顺序
// 多个资源ID，请使用英文逗号分割

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "access_token": ""
    }
}

销毁AccessToken

API 地址

api.yun.vhall.com/api/v1/base/destroy-access-token

描述

用来销毁AccessToken，当AccessToken泄露时或其他情况，可通过销毁来保证资源的安全性

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
		"destory_token" : "access:app_id_1:jfalsiecnm"
	]
}

创建房间

API 地址

api.yun.vhall.com/api/v1/room/create

描述

房间，视频流的载体，创建房间后，可使用房间发起直播

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "room_id": "lss_69178ce4"
    }
}

封停房间

API 地址

api.yun.vhall.com/api/v1/room/disable

描述

当视频被认为是违规或其他情况，封停接口，可使视频流不在分发，观看端无法继续挂看

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "disable_room_id": "lss_87dfa7ef"
    }
}

解封房间

API 地址

api.yun.vhall.com/api/v1/room/enable

描述

和封停房间对应，解除对房间的封停

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "enable_room_id": "lss_87dfa7ef"
    }
}

删除房间

API 地址

api.yun.vhall.com/api/v1/room/delete

描述

删除房间，和创建房间对应

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "delete_room_id": "lss_87dfa7ef"
    }
}

房间列表

API 地址

api.yun.vhall.com/api/v1/room/lists

描述

按当前公共参数传入app_id对应的应用，获取房间列表

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "room_id": "lss_314eaf4b",
            "app_id": "app_id_1",
            "is_disable": 0,
            "created_at": "2017-12-01 21:27:09"
        },
        {
            "room_id": "lss_b42cd4bd",
            "app_id": "app_id_1",
            "is_disable": 0,
            "created_at": "2017-12-04 11:01:16"
        },
        {
            "room_id": "lss_b88e1673",
            "app_id": "app_id_1",
            "is_disable": 0,
            "created_at": "2017-12-04 11:18:54"
        }
    ]
}

获取推流信息

API 地址

api.yun.vhall.com/api/v1/room/get-push-info

描述

微吼云房间支持使用第三方推流工具推流，通过接口可以获取推流地址

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "stream_number": "lss_75ba2dcf",
        "push_address": "rtmp://t-open-push.live.vhou.net:1935/vhall?vhost=indexVhost?token=3D93913Dt24FA1?webinar_id=lss_75ba2dcf?ismix=0?mixserver=?accesstoken=vhall"
    }
}

配置直播转码

API 地址

api.yun.vhall.com/api/v1/room/set-trans-code-info

描述

开通直播服务后，微吼云不会对视频流进行转码，可通过接口配置需要转码的清晰度

• 清晰度配置针对应用配置，如果多个应用都需要，需要分别配置

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

清晰度列表

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "rate": "360P,720P"
    }
}

配置开始直播录制

API 地址

api.yun.vhall.com/api/v1/room/set-record-info

描述

通过API配置后可以在直播在推流结束后调用点播API生成点播文件

• 配置开始录制针对应用配置，如果多个应用都需要，需要分别配置

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "open_record": "1"
    }
}

获取直播流量数据

API 地址

api.yun.vhall.com/api/v1/room/get-stream-flow

描述

按当前传入app_id对应的应用，获取直播流量数据

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "flow": {
            "2017-12-11": "0",
            "2017-12-12": "20400",
            "2017-12-13": "0",
        }
    }
}

获取直播宽带数据

API 地址

api.yun.vhall.com/api/v1/room/get-stream-board-band

描述

按当前公共参数传入app_id对应的应用，获取直播宽带数据

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "bandwidth": {
            "2017-12-11": "0",
            "2017-12-12": "0",
        }
    }
}

获取直播流信息

API 地址

api.yun.vhall.com/api/v1/room/get-stream-msg

描述

获取房间下直播流的流信息

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "rate": "0fps"
    }
}

获取正在推流的房间列表

API 地址

api.yun.vhall.com/api/v1/room/get-pushing-stream-list

描述

按当前公共参数传入app_id对应的应用，获取正在推流的房间列表

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "room_list": [
            "lss_497541895",
            "lss_af793b0e",
        ]
    }
}

获取直播属性信息

API 地址

api.yun.vhall.com/api/v1/room/get-room-use-info

描述

获取直播房间的流量、宽带、pv、uv以及观看时长

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "flow": 15015,
            "bandwidth": 330,
            "pv_num": 3,
            "uv_num": 1,
            "tt": 364
        },
        {
            "flow": 700,
            "bandwidth": 193,
            "pv_num": 1,
            "uv_num": 1,
            "tt": 29
        }
    ]
}

获取直播访问记录

API 地址

api.yun.vhall.com/api/v1/room/get-room-join-info

描述

获取直播房间的游客进出记录

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "uid": "1000204982",
            "start_time": "2018-03-06 11:55:00",
            "end_time": "2018-03-07 11:29:00",
            "tt": 1335,
            "pf": "7",
            "browser": "QQBrowser",
            "viewer_province": "上海"
        },
        {
            "uid": "1000204982",
            "start_time": "2018-03-06 11:57:00",
            "end_time": "2018-03-07 11:29:00",
            "tt": 1268,
            "pf": "7",
            "browser": "Chrome",
            "viewer_province": "加利福尼亚州"
        }
    ]
}

生成点播

API 地址

api.yun.vhall.com/api/v1/record/create

描述

直播房间推流结束后，可通过该接口生成对应的回放视频，生成的点播文件会占用微吼云使用空间

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "record_id": "6e5692bb"
    }
}

删除点播

API 地址

api.yun.vhall.com/api/v1/record/delete

描述

和生成点播对应，可删除点播

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "delete_record_id": "ead7e8e1"
    }
}

点播列表

API 地址

api.yun.vhall.com/api/v1/record/lists

描述

按当前公共参数传入app_id对应的应用，获取点播列表

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "record_id": "bfd60d4e",
            "app_id": "9320432d",
            "name": "lss_24316d41",
            "created_at": "2017-12-12 16:00:07"
        },
        {
            "record_id": "f7d363e7",
            "app_id": "9320432d",
            "name": "",
            "created_at": "2017-12-13 15:28:39"
        }
    ]
}

配置点播转码

API 地址

api.yun.vhall.com/api/v1/record/set-trans-code-info

描述

用户上传视频后，微吼云不会对上传的视频进行转码，可通过接口配置需要转码的清晰度

• 转码配置针对应用配置，如果多个应用都需要，需要分别配置

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

清晰度列表

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "rate": "360P,720P"
    }
}

按应用获取点播流量数据

API 地址

api.yun.vhall.com/api/v1/record/get-stream-flow

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "flow": {
            "2017-12-11": "0",
            "2017-12-12": "20400",
            "2017-12-13": "0",
        }
    }
}

指定回放文件转码

API 地址

api.yun.vhall.com/api/v1/record/trans-record

描述

配置点播转码后，并不会对历史上传的视频文件进行转码，如需对历史视频转码，可以调用该接口

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": []
}

获取点播详情

API 地址

api.yun.vhall.com/api/v1/record/get-record-info

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

list参数

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "duration": 159,
        "storage": 51561,
        "created_at": "2018-02-26 14:39:28",
        "list": [
            {
                "quality": "720p",
                "storage": 15852,
                "transcode_status": 1
            },
            {
                "quality": "480p",
                "storage": 11677,
                "transcode_status": 1
            },
            {
                "quality": "360p",
                "storage": 9291,
                "transcode_status": 1
            },
            {
                "quality": "a",
                "storage": 2563,
                "transcode_status": 1
            }
        ]
    }
}

获取点播属性信息

API 地址

api.yun.vhall.com/api/v1/record/get-room-use-info

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "flow": 15015,
            "pv_num": 3,
            "uv_num": 1,
            "tt": 364
        },
        {
            "flow": 700,
            "pv_num": 1,
            "uv_num": 1,
            "tt": 29
        }
    ]
}

获取点播访问记录

API 地址

api.yun.vhall.com/api/v1/record/get-room-join-info

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "uid": "1000204982",
            "start_time": "2018-03-06 11:55:00",
            "end_time": "2018-03-07 11:29:00",
            "tt": 1335,
            "pf": "7",
            "browser": "QQBrowser",
            "viewer_province": "上海"
        },
        {
            "uid": "1000204982",
            "start_time": "2018-03-06 11:57:00",
            "end_time": "2018-03-07 11:29:00",
            "tt": 1268,
            "pf": "7",
            "browser": "Chrome",
            "viewer_province": "加利福尼亚州"
        }
    ]
}

创建频道

API 地址

api.yun.vhall.com/api/v1/channel/create

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "channel_id": "ch_e5fa35b2"
    }
}

删除频道

API 地址

api.yun.vhall.com/api/v1/channel/delete

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "delete_channel_id": "ch_e5fa35b2"
    }
}

发送消息

API 地址

api.yun.vhall.com/api/v1/channel/sent

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

type 类型列表

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": []
}

查看消息&过滤数量（按应用查询）

API 地址

api.yun.vhall.com/api/v1/channel/get-message-num

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "2017-12-12": {
            "msg_count": 2,
            "msg_filter_count": 4
        },
        "2017-12-13": {
            "msg_count": 4,
            "msg_filter_count": 8
        },
        "2017-12-14": {
            "msg_count": 0,
            "msg_filter_count": 0
        }
    }
}

设置第三方用户信息

• 注意，该接口只作为消息服务，消息内容头像和昵称安全不被串改的一种保障，不作其他使用

API 地址

api.yun.vhall.com/api/v1/channel/save-user-info

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": []
}

获取消息列表

API 地址

api.yun.vhall.com/api/v1/channel/get-message-list

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

• 返回列表数据按时间格式倒序

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "data": "天天",
            "date_time": "2017-12-22 01:32:25",
            "third_party_user_id": "test1"
        },
        {
            "data": "英语",
            "date_time": "2017-12-22 01:32:09",
            "third_party_user_id": "third_party_user_id"
        }
    ]
}

创建文档

API 地址

api.yun.vhall.com/api/v1/document/create

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "document_id": "6e5692bb"
    }
}

删除文档

API 地址

api.yun.vhall.com/api/v1/document/delete

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "delete_document_id": "ead7e8e1"
    }
}

文档列表

API 地址

api.yun.vhall.com/api/v1/document/lists

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "document_id": "59e67a7e",
            "app_id": "app_id_1",
            "file_name": "员工信息更新表.xlsx",
            "size": 9997,
            "status" : 200,
            "created_at": "2017-12-09 20:07:22"
        }
    ]
}

获取文档信息

API 地址

api.yun.vhall.com/api/v1/document/get-document-info

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "hash": "238ffaea3c6fa0fc08e995f4ae274542",
        "page": 1
    }
}

获取转码成功的文档列表

API 地址

api.yun.vhall.com/api/v1/document/get-trans-over-lists

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "document_id": "59e67a7e",
            "app_id": "app_id_1",
            "file_name": "员工信息更新表.xlsx",
            "size": 9997,
            "created_at": "2017-12-09 20:07:22"
        }
    ]
}

获取文档使用数据

API 地址

api.yun.vhall.com/api/v1/document/get-document-use-info

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "use_time": 6
    }
}

回调说明

• 如需回调服务需要在控制台添加回调接口
• 添加回调域后，该服务下回调服务会自动往回调接口上推送数据

回调失败判定

• 当在控制台填写固定回调接口地址后，需要在接口中返回 success 字符串

以PHP为例

exit("success");

• 当回调接口未返回success字符串时，回调服务会被认定为失败，并重试
• 当重试次数达到3次时，该回调信息会被记录到数据库中，请使用接口查询

回调格式

• 通知信息是以 JSON 格式进行组织的，注意这里的 POST 格式的 ContentType 是 application/json。

公共头信息

以下的字段每种类型的回调都一定会携带：

		User-Agent: vhall
		Content-Type: application/json
		Content-Length: content length

回调签名

使用请求参数构造规范化的请求字符串（Canonicalized Query String）

a)　按照参数名称的字典顺序对请求中所有的请求参数（包括文档中描述的“公共请求参数”和给定了的请求接口的自定义参数，但不能包括“公共请求参数”中提到signature参数本身）进行排序。

注：当使用GET方法提交请求时，这些参数就是请求URI中的参数部分（即URI中“?”之后由“&”连接的部分）。

b)　对每个请求参数的名称和值进行编码。名称和值要使用UTF-8字符集进行URL编码，URL编码的编码规则是：

• 对于字符 A-Z、a-z、0-9以及字符“-”、“_”、“.”、“~”不编码；

c)　对编码后的参数名称、私钥和值使用英文等号（|）进行连接。

d)　再把英文竖线连接得到的字符串按参数名称的字典顺序依次连接，即得到规范化字符串。

使用上一步构造的规范化字符MD5计算，即得到签名的字符串：

签名方法示例

//PHP版本代码
$privateKey = 'abcdefg';    // app secret_key
data = $_POST;
$sign = $data['signature'];
unset($data['signature']);
$sign_new = makeSignature($data , $privateKey);//调用签名生成函数

if($sign == $sign_new){
    echo 'success';
}else{
    echo 'fail';
}

//$privateKey为回调接口私钥
//$data为回传的POST数据数组，剔除掉signature键值
//签名生成函数
function makeSignature(array $data, $privateKey){
    ksort($data);
    $str = '';
    $privateKey = md5($privateKey);
    foreach ($data as $k => $v){
        $str .= $k.'|'.$privateKey.'|'.$v;
    }
    return md5($str);
}

点播文件生成回调

事件 event

record/created-success

回调信息

相应示例

{
    event : "record/created-success", // 事件
    refer: "vhall", // 来源
    time: "1505095994", // 当前时间戳
    record_id: "56b345",  // 回放ID
    signature: "7ffa066561d280d0d51f8fdaad29f4a4", // 签名
}

转码成功回调

事件 event

record/trans-over

回调信息

响应示例

{
    event : "record/trans-over", // 事件
    refer: "vhall", // 来源
    time: "1505095994", // 当前时间戳
    record_id: "56b345",  // 回放ID
    signature: "7ffa066561d280d0d51f8fdaad29f4a4", // 签名
}

文档转码回调

事件 event

document/trans-over

回调信息

相应示例

{
    event : "record/trans-over", // 事件
    refer: "vhall", // 来源
    time: "1505095994", // 当前时间戳
    document_id: "56b345",  // 文档ID
    signature: "7ffa066561d280d0d51f8fdaad29f4a4", // 签名
}

查询失败回调记录

API 地址

api.yun.vhall.com/api/v1/callback/fail-list

入参

• 关于公共请求参数详细内容，请参考 公共请求参数。

出参

错误码

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "id": 0,
            "record_id": "70545e9f",
            "status": 1
        }
    ]
}

获取点播上传授权信息

api名称

record/upload-auth-key

参数

出参

strArr 参数

响应格式

	{
	    "code": "200",
	    "msg": "成功",
	    "data": { // 内部为阿里授权信息
	        "stsArr": { 
	            "AccessKeySecret": "56vu2wec5fV6yRwVyFRvhMV4ruD2V5BfkvRjCHfhTrQr",
	            "AccessKeyId": "STS.Db2KL3sgyr6mLv1dQxPNqiAPd",
	            "Expiration": "2017-10-17T03:31:31Z",
	            "SecurityToken": "CAISkgN1q6Ft5B2yfSjIpaGHAPaHnrhYxfSGTlCAgFEtXMFdhoT7hjz2IHlMdHFpBeEWsvo3mWFQ7/4YlqovFcYd/OgnxlEzvPpt6gqET9frPKXXhOV2CfTHdEGXDxnkptCwB8zyUNLafNq0dlnAjVUd6LDmdDKkLWvHUZqSksxIY8hVPGi/diEUINZNOkkA0MgBLin9OPKgLhPNiGjdB1YK3w1nkjFb6L+j+sSG9gG8/Frh0b08rYPrPr25a9VtJJ5lT+qt2Ot/esik1zVLuSBX6IB8jqFP5U3I3LenDkJW/g+NPsfN79RrN3UZXKUhHLNep/WOtp8Ps+fIxYPs0EQPb6MHTSTWQIS+x8ffH/6zPdt8abvgJxaN29uUZJ7uqFFmMzBJKgNDf94/LXNrDgE2QTyfNqK85BfGbwKqTaTCkoNOiMAolQm1ooLVeATXHe/GjRx1YMFsMxkaUDcNxnHkf6M8dAhBTkhqHb79T/8oNUgO8fq07F2OCHU9nykO56fkBfTNoeUCcYH4V55WexaylVrNRwEagAFS8RBmipxBjbsHluhFJqcV9AV/9xlL0cGsYsl5QcrKlxVHlppZQihDSLckZMTlFaOvh9ANACvIS8cxnRpTe8jdf/t5S/xbSDIYtwInDPGHOoEleufHzXj0JAKDP9bTgIRZfDlT+MOEBCBDCnXGwQcyhfzSh3AMulmRHIKxd1yB1g=="
	        },
	        "oss_bucket": "vhallvodsource-test"
	    }
	}

错误码

获取点播上传授权信息

api名称

record/create-demand

参数

出参

响应格式

	{
	    "code": "200",
	    "msg": "成功",
	    "data": {
	        "record_id": 3a3b3671 // 回放ID
	    }
	}

错误码