API接口URL:
http://www.cloudroom.com/api/addLivePhoneMenuAPI
参数:
接口参数 ↓
名称 |
类型 |
是否必传 |
说明 |
LiveID |
Integer |
是 |
直播号 |
MenuName |
String |
是 |
菜单名称(最大长度为 5 ) |
MenuType |
Integer |
是 |
菜单类型 0 互动聊天 1 图文 2 视频点播 3 分享榜单 |
MenuContent |
String |
否 |
菜单内容(html网页源码,最大长度为 150000 ) |
MenuOrder |
Integer |
否 |
菜单排序号(如 1,2,3,4 ...) |
FileIDs |
String |
否 |
视频ID,以英文符号 , 拼接视频ID(如 1,2,3 ) |
*注:互动聊天和分享榜单都是只能有 1 个,菜单一共最多只能有 4 个,当新增菜单为图文时,菜单内容不允许为空;当新增菜单为点播视频时,视频ID不允许为空。菜单的排序号是影响菜单在直播页面左右的排位顺序的。
返回数据:
名称 |
类型 |
说明 |
RspCode |
String |
响应码 |
RspDesc |
String |
响应描述 |
Data |
Map |
数据 |
Data:
名称 |
类型 |
说明 |
MenuID |
Integer |
菜单ID |
MenuName |
String |
菜单名称 |
MenuType |
Integer |
菜单类型 |
MenuContent |
String |
菜单内容 |
MenuOrder |
Integer |
菜单排序 |
CreateTime |
String |
创建时间 |
返回状态码RspCode说明
数值 |
说明 |
0 |
请求成功 |
1 |
鉴权失败 |
2 |
参数格式错误,请校对参数格式 |
4 |
传参错误,SQL注入校验不通过 |
5 |
未知错误 |
6 |
缺少必传参数 |
7 |
找不到该场直播 |
8 |
菜单名称长度不能大于5 |
9 |
菜单已经达到最大数量 |
10 |
只能有一个互动聊天 |
11 |
图文菜单内容不能为空 |
12 |
图文菜单内容长度不能大于150000 |
13 |
点播视频ID不能为空 |
14 |
点播视频ID错误,找不到相应视频 |
15 |
只能有一个分享榜单 |
16 |
菜单类型错误 |
样例一
js跨域调用接口(get)
注:中文需要进行转码处理
encodeURI('中文', 'UTF-8')
function test(){
var params = {
RequestId : '123456789',
CompID : 1,
SecretKey : 'e10adc3949ba59abbe56e057f20f883e',
DoAction : 'get',
CallBack: 'jsoncallback'
}
$.ajax({
url : 'http://www.cloudroom.com/api/addLivePhoneMenuAPI',
data : params,
dataType : 'jsonp',
success : function(result){}
});
}
function jsoncallback(result){
//接口回调处理
}
样例二