API接口功能说明:
创建立即会议或预约会议
API接口URL:
http://www.cloudroom.com/crapi/CreateConfAPI
参数:
接口参数 ↓
名称 |
类型 |
是否必传 |
说明 |
Subject |
String |
是 |
会议主题 |
IsRegular |
Integer |
否 |
是否固定会议,默认否:0 否 1 是 |
NeedPswd |
Integer |
否 |
是否启用会议密码,默认否:0 否 1 是 |
StartTime |
long |
否 |
会议开始时间(表示自 1970 年 1 月 1 日 00 : 00 : 00 GMT以来的毫秒数)。值为空时,则表示立即开始会议。 |
AutoAudio |
Integer |
否 |
是否自动接受语音申请,默认是:0 否 1 是 |
AutoMute |
Integer |
否 |
是否进入会议后自动允许发言,默认是:0 否 1 是 |
Agenda |
String |
否 |
会议议程,长度小于 1000 |
RecordConf |
Integer |
否 |
是否打开会议录制,默认否:0 否 1 是 |
LoginIvr |
Integer |
否 |
是否播放进入退出提示音,默认播放:0 否 1 是 |
CreateWB |
Integer |
否 |
是否允许创建白板和演示文档,默认是:0 否 1 是 |
SaveWB |
Integer |
否 |
是否允许保存他人白板和演示文档,默认是:0 否 1 是 |
PublicIM |
Integer |
否 |
是否允许公聊,默认是:0 否 1 是 |
PrivateIM |
Integer |
否 |
是否允许私聊,默认是:0 否 1 |
ShareOrUpload |
Integer |
否 |
是否允许上传文件,默认是:0 否 1 是 |
AutoMuteHost |
Integer |
否 |
是否主持人进入会议自动静音,默认否:0 否 1 是 |
AppMode |
Integer |
否 |
是否教育模式,默认否:0 否 1 是 |
IsLive |
Integer |
否 |
是否为互动直播(需要企业开通互动直播功能),默认否:0 否 1 是 |
SrvRecord |
Integer |
否 |
是否自动云端录制(需要企业开通云端录制功能),默认否:0 否 1 是 |
HostId |
Integer |
否 |
主持人ID |
InviteeUserId |
String |
否 |
邀请用户的ID集合,批量的格式为 '1000000001,1000000002,1000000003' |
返回数据:
名称 |
类型 |
说明 |
RspCode |
string |
响应码 |
RspDesc |
string |
响应描述 |
Data |
map |
数据集合 |
Data数据
名称 |
类型 |
说明 |
HostUrl |
string |
主持人参会链接。以主持人的身份加入会议 |
PubUrl |
string |
公共参会链接。所有普通参会者可以使用该链接通过浏览器加入会议 |
ConfPswd |
string |
会议密码 |
HostPswd |
string |
主持人密码 |
CRMTStr |
string |
会议启动串(调起客户端方式,如:window.loaction= CRMTStr ) |
ConfId |
Integer |
会议Id |
返回状态码RspCode说明
数值 |
说明 |
0 |
请求成功 |
1 |
鉴权失败 |
2 |
参数格式错误,请校对参数格式 |
4 |
传参错误,SQL注入校验不通过 |
5 |
未知错误 |
6 |
缺少必传参数 |
7 |
主持人ID错误 |
8 |
邀请用户数不能大于1000 |
9 |
邀请用户ID错误 |
10 |
会议不能同时开启互动直播和自动录制功能 |
11 |
没有设置互动直播权限 |
12 |
没有设置自动录制权限 |
13 |
只有充值用户才可以创建固定会议室 |
14 |
已创建的固定会议个数已达最大值 |
15 |
创建会议失败 |
样例一
js跨域调用接口(get)
注:中文需要进行转码处理
Subject:encodeURI('我的会议', 'UTF-8')
function test(){
var params = {
RequestId : '123456789',
CompID :'1',
SecretKey: 'e10adc3949ba59abbe56e057f20f883e',
DoAction: 'get',
CallBack: 'jsoncallback'
}
$.ajax({
url : 'http://www.cloudroom.com/crapi/CreateConfAPI',
data : params,
dataType : 'jsonp',
success : function(result){}
})
}
function jsoncallback(result){
//接口回调处理
}
样例二