快速启动指南
1. 用户在使用REST API时，需要先获取主账户API的密钥和密码。
2. 如果你的账号有权限创建用户，可以使用REST API创建用户。
3. 使用REST API为该用户生成会议。创建成功后，会生成一个启动会议的链接，如：https://zhumu.me/123456789?zpk=xxxxx和一个加入会议的链接，如https://zhumu.me /123456789，其中不包含访问令牌。
4. 现在就可以使用浏览器打开链接https://zhumu.me /123456789?zpk=xxxx来启动会议，瞩目客户端下载、安装和运行将自动进行。
5. 任何获得会议链接的用户都可在浏览器打开这个链接并加入会议。
客户端的安装
在默认情况下，用户需要从www.zhumu.me下载并安装客户端。你也可以通过其他渠道来发行该客户端。
如果用户在启动或加入会议前没有安装瞩目客户端，浏览器会弹出一个窗口来检测本地机器的当前安装状况并决定安装或更新瞩目客户端。
注：
如果所有的用户都安装了瞩目客户端，可使用“zhumu：”协议取代“https.”来启动客户端。Zhumu协议的的好处是启动或加入会议时无须跳转到另一个页面。
典型的zhumu协议示例：
Start Betty’s meetingZhumu协议参数：
1. confno: 会议ID。
2. token: 用户令牌，如用户更改密码则令牌过期（可从用户处获取令牌或者通过调用REST API获取）。
3. uid:主持人ID。
4. uname:主持人姓名。
5. pwd:会议密码。
REST API 基础
所有REST API调用都是基于服务器端的HTTP POST请求，因为需要进行身份验证，所以不能使用web客户端AJAX的方式发起请求。
典型的POST URL:
https://api.zhumu.me/v3/user/create
https://api.zhumu.me/v3/user/create
注：
1. 必须使用HTTPS，否则会返回302重定向状态码。
2. 链接中的“v1”表示使用的瞩目API的版本。
下表为REST API请求中通常需要包含的参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | API密钥，从Zhumu.me获得 | |
| api_secret | Y | API密钥，从Zhumu.me获得 | |
错误处理：
从服务器得到响应时，首先要查看响应消息体中的“error”部分。“error”部分表明这是个失败请求，可以从该部分中获取错误码和错误信息。
JSON格式的错误返回消息示例：
{ server
"error":
{
"code": 102,
"message": "You app key and secret doesn't match. "
}
}
用户代码示例
C#代码示例
public string ApiDemo()
{
StringBuilder data = new StringBuilder();
data.Append("logintype=" + HttpUtility.UrlEncode(logintype));
data.Append("&loginname=" + HttpUtility.UrlEncode(loginname));
data.Append("&api_key=" + HttpUtility.UrlEncode(api_key));
data.Append("&api_secret=" + HttpUtility.UrlEncode(api_secret));
Uri address = new Uri("https://api.zhumu.me/v3/user/get");
HttpWebRequest request = WebRequest.Create(address) as HttpWebRequest;
request.Method = "POST";
request.ContentType = "application/x-www-form-urlencoded";
byte[] byteData = UTF8Encoding.UTF8.GetBytes(data.ToString());
request.ContentLength = byteData.Length;
using (Stream postStream = request.GetRequestStream())
{
postStream.Write(byteData, 0, byteData.Length);
}
using (HttpWebResponse response = request.GetResponse() as HttpWebResponse)
{
StreamReader reader = new StreamReader(response.GetResponseStream());
return reader.ReadToEnd().ToString();
}
}
Java代码示例
x.Ext.init(this.getApplication());
RequestParams params = new RequestParams(Constants.url);
params.addBodyParameter("api_key", Constants.API_KEY);
params.addBodyParameter("api_secret", Constants.API_SECRET);
params.addBodyParameter("logintype", "3");
params.addBodyParameter("loginname", "SDKTest@zhumu.me");
x.http().post(params, new Callback.CommonCallback
@Override
public void onSuccess(String s) {
Log.e("MainActivity", "服务器返回结果：" + s);
mMeeting = getMeeting(s);
if (mMeeting != null) {
user_id = mMeeting.getId();
token = mMeeting.getToken();
user_name = mMeeting.getUsername();
meet_num = mMeeting.getPmi();
mHandler.post(new Runnable() {
@Override
public void run() {
mEdtMeetingNo.setText(meet_num);
}
});
} else {
}
}
@Override
public void onError(Throwable throwable, boolean b) {
Log.e("MainActivity", "onError：");
}
@Override
public void onCancelled(CancelledException e) {
Log.e("MainActivity", "onCancelled（）：");
}
@Override
public void onFinished() {
Log.e("MainActivity", "onFinished（）:meet_num:" + meet_num);
}
}
创建用户
创建瞩目用户，返回用户ID。
注：
账号必须有创建用户的权限。瞩目只会将该权限授予可信任的合作方。
端点: https://api.zhumu.me/v3/user/create
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| username | N | 用户姓名 | |
| Y | 用户邮箱 | ||
| usertype | N | 0 | 用户类型：0-免费用户，1-普通用户，2-高级用户 |
| cloudrecording | N | false | 是否开启云录制 |
| autolocalrecording | N | false | 是否开启本地自动录制 |
| autocloudrecording | N | false | 是否开启云端自动录制 |
| dept | N | 部门 | |
| planid | N | 设置用户所绑定的计划，默认随机选择已有计划 |
JSON示例
成功：Code-100
{
“code”: 100,
“zcode”: 88888888,
“email”: "jjjdfesef@qq.com",
“username”: " jjjdfesef ",
“usertype”: 2,
“dept”: "aa",
“large”: 202
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
删除用户
删除瞩目用户，返回被删除用户的ID。
端点: https://api.zhumu.me/v3/user/delete
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| zcode | Y | 用户唯一标示 |
JSON示例
成功：Code-100
{
“code”: 100,
“msg”: "操作成功，该用户已被移除"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
列示用户
列示所有用户。
端点: https://api.zhumu.me/v3/user/list
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| pageindex | N | 1 | 返回记录的当前页码，默认值为1 |
JSON示例
成功：用户信息列表
{
"page_count": 5,
"total_records": 235,
"page_number": 1,
"page_size": 50,
"users": [
{
"id":"4252621430",
"email":"suiruitest001@zhumu.me",
"username":"test001",
"usertype":"0",
"role":"0",
"isowner":0,
"det":"suirui",
"accounttype":"10",
"meetingcapacity":null,
"createtime":"2017/1/4 15:10:05",
"webinarcapacity":null
}，
{
"id":"4252621430",
"email":"suiruitest001@zhumu.me",
"username":"test001",
"usertype":"0",
"role":"0",
"isowner":0,
"det":"suirui",
"accounttype":"10",
"meetingcapacity":null,
"createtime":"2017/1/4 15:10:05",
"webinarcapacity":null
}
]
}
查询用户信息
通过用户id查询用户信息，返回用户信息。
端点: https://api.zhumu.me/v3/user/get
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| logintype | Y | 3 | 登陆账户类型：1-ZCode，2-Mobile，3-Email |
| loginname | Y | 根据所选logintype，相应的Zcode、Mobile或Email |
JSON示例
成功：用户信息
{
“code”: 100,
"zcode":4252621430,
"id":"XJW25bXgQ1W22V37L6l_Rg",
"username":"test001",
"mobile":null,
"usertype":0,
"det":"suirui",
"createtime":"2017/1/4 15:10:05",
"createby":"API",
"pmi":"17716469824",
"role":0,
"email":"suiruitest001@zhumu.me",
"isowner":0,
"accounttype":10,
"token":"HGxmP--lc7TlhTGql3dFA_eL_abOuGUpwC9U-hlIwr0.BgIgRWQ0Rlk4QTNTeGdkV0J2Q1kxeVk0cWJodEx4NW1peWNAMDIzMDQyODcyYzI3ZTc1NjE4ZmVlNDk0NjNjZGE1NjBmN2FmNzVlZTkwODFmNmMxNTg2YzkwNTIwNDFkMWM3NAA"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
查询用户zpk
通过用户id查询用户信息，返回用户信息。
端点: https://api.zhumu.me/v3/user/getzpk
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| Y | 瞩目账号 |
JSON示例
成功：用户信息
{
"email":"suiruitest001@zhumu.me",
"zpk":"HGxmP--lc7TlhTGql3dFA_eL_abOuGUpwC9U-hlIwr0.BgIgRWQ0Rlk4QTNTeGdkV0J2Q1kxeVk0cWJodEx4NW1peWNAMDIzMDQyODcyYzI3ZTc1NjE4ZmVlNDk0NjNjZGE1NjBmN2FmNzVlZTkwODFmNmMxNTg2YzkwNTIwNDFkMWM3NAA"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
注：令牌变量可用于生成启动会议的链接。
更改用户信息
通过用户id更改瞩目用户信息。
注：该调用中不能更改邮箱地址。
端点: https://api.zhumu.me/v3/user/update
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| zcode | Y | 用户唯一标示 | |
| username | N | 用户的名 | |
| cloudrecording | N | false | 是否开启云录制 |
| autolocalrecording | N | false | 是否开启本地自动录制 |
| autocloudrecording | N | false | 是否开启云端自动录制 |
| pmi | N | 会议ID类型为long | |
| dept | N | 个人的部门信息，用于报表 |
JSON示例
成功：Code-100
{
“code”: 100,
“msg”: "用户信息修改成功!"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
更改用户密码
通过用户id更新瞩目用户密码。
注：在该接口调用中，只有用工作邮箱注册的用户可更改密码。
端点: https://api.zhumu.me/v3/user/updatepassword
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| zcode | Y | 用户唯一标示 | |
| password | Y | User’s password.用户密码 |
JSON示例
成功：Code-100
{
“code”: 100,
“msg”: "密码修改成功!"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
忘记密码
通过用户email找回并修改用户密码。
注：在该接口调用中，只有用工作邮箱注册的用户可更改密码。
端点: https://api.zhumu.me/v3/user/forgetpasswd
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| Y | 用户绑定的邮件地址 |
JSON示例
成功：Code-100
{
“code”: 100,
“msg”: "邮件发送成功!"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "邮件发送失败"
}
查询付费用户到期时间
通过用户email查询付费用户到期时间。
端点: https://api.zhumu.me/v3/user/search
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| Y | 用户邮箱 |
JSON示例
成功：付费用户类型及到期时间
{
"email":"sunkai.test01@suirui.com",
"user_type":1,
"expiration_time":"2015/10/22 0:00:00",
"account_type":"20"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
列示计划
列示当前账户下所有的计划。
端点: https://api.zhumu.me/v3/plan/list
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| pageindex | N | 1 | 返回记录的当前页码，默认值为1 |
JSON示例
成功：
{
"page_count":1,
"total_records":1,
"page_number":1,
"page_size":10,
"plans"
:[{
"PlanID":7426816437004828,
"Count":1,
"PlanType":10,
"PlanName":"aaa",
"ExtendType":null,
"ExtendCount":0,
"StartTime":"2017-01-04T15:17:43",
"EndTime":"2017-01-05T15:17:43"
}]
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
更改用户计划
变更账号现有的计划。
端点: https://api.zhumu.me/v3/user/change
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| zcode | Y | 用户唯一标示 | |
| planid | Y | 设置用户所绑定的计划 |
JSON示例
成功：
{
“code”: 100,
“msg”: "用户计划修改成功!"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
创建会议
端点: https://api.zhumu.me/v3/meeting/create
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| zcode | Y | 用户唯一标示 | |
| password | N | 会议密码.密码可以包含下列字符: [a-z A-Z 0-9 @ - _ *]. 最大10个字符. | |
| topic | Y | 会议主题，标题 | |
| type | Y | 创建会议类型，1-即时会议，2-计划会议，3-长期会议 | |
| start_time | N | 会议开始时间：2015-01-01 12:01:01 | |
| duration | N | 持续时间 | |
| option_jbh | N | false | 可以在主持人开始会议之前加入会议. |
| option_start_type | N | video | 会议开始类型，可以是"video"或者 "screen_share". (不赞成) |
| option_no_video_host | N | false | 当主持人加入会议时不打开视频. |
| option_no_video_participants | N | false | 当参与人加入会议室不打开视频. |
| option_audio | N | "both" | 会议语音选项。可以是"both", "telephony", “voip”. |
JSON示例
成功：会议信息
{
"uuid":"VkTVkSlVQD+JQjHXcRMEqg==",
"id":"1474362728",
"host_id":"XJW25bXgQ1W22V37L6l_Rg",
"topic":"xxxxxxx",
"password":"",
"h323_password":"",
"status":0,
"option_jbh":false,
"option_start_type":"video",
"option_host_video":true,
"option_participants_video":true,
"option_audio":"both",
"type_des":null,
"start_time":"2017-01-05T08:00:00+08:00",
"duration":1,
"timezone":"Asia/Shanghai",
"start_url":"https://www.zhumu.me/s/1474362728?zpk=oTh-N1xV6cPUwCeXX9WED120gQlxqzzRsiNCdO5sl60.BwYAAAFZaGIkHwAAHCAkMzEzZDliMDctMTNmMy00OGY5LThjYWYtYjBmYzA3NjcwODBkFlhKVzI1YlhnUTFXMjJWMzdMNmxfUmcWWEpXMjViWGdRMVcyMlYzN0w2bF9SZwd0ZXN0MDAxZACzSEd4bVAtLWxjN1RsaFRHcWwzZEZBX2VMX2FiT3VHVXB3QzlVLWhsSXdyMC5CZ0lnUldRMFJsazRRVE5UZUdka1YwSjJRMWt4ZVZrMGNXSm9kRXg0TlcxcGVXTkFNREl6TURReU9EY3lZekkzWlRjMU5qRTRabVZsTkRrME5qTmpaR0UxTmpCbU4yRm1OelZsWlRrd09ERm1ObU14TlRnMll6a3dOVEl3TkRGa01XTTNOQUEAABZLVno0dGx2VFNucUUyX3lsa2RsU2dRAgMB",
"join_url":"https://www.zhumu.me/j/1474362728",
"created_at":"2017-01-04T15:29:39+08:00",
"schedule_use_pmi":false,
"auto_recording":false,
"auto_savechat":false,
"disable_polling":false,
"disable_chat":false,
"enable_e2e":false,
"enable_silentmode":false,
"disable_recording":false,
"screen_share":false,
"audio_only":false,
"enable_group_hd":false,
"no_telephony":false,
"no_voip":false,
"disable_feedback":false,
"enable_other_teleconf":false,
"enable_cmr":false,
"enable_camera_control":false,
"enable_automic_recording_cloud":false,
"disable_private_chat":false,
"disable_host_unmute_self_muted_attendee":false,
"enable_pac":false,
"enable_bo":false,
"enable_webinar_practice":false,
"enable_enter_exit_chime":false,
"enable_enter_exit_chime_host_only":false,
"use_pac_1":false,
"use_pac_2":false,
"disable_screen_share":false,
"disable_remote_control":false,
"disable_local_recording":false,
"dual_camera_support":false,
"enable_support_session":false,
"enable_file_transfer":false,
"enable_watermark":false,
"enable_cohost":false,
"end_meeting_when_host_drop":false,
"enabled_join_meeting_enforce_login":false,
"enabled_join__meeting_enforce_login_same_account":false,
"enable_closed_caption":false,
"enable_pstn_password_protection":false,
"disable_peer_to_peer":false,
"agenda":null
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
创建虚拟会议室
端点: https://api.zhumu.me/v3/meeting/createvirtualmeeting
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| zcode | Y | 用户唯一标示 | |
| alternative_email | Y | 代理主持人账号 | |
| password | N | 会议密码.密码可以包含下列字符: [a-z A-Z 0-9 @ - _ *]. 最大10个字符. | |
| topic | Y | 会议主题，标题 | |
| type | Y | 创建会议类型，1-即时会议，2-计划会议，3-长期会议 | |
| start_time | N | 会议开始时间：2015-01-01 12:01:01 | |
| duration | N | 持续时间 | |
| option_jbh | N | false | 可以在主持人开始会议之前加入会议. |
| option_start_type | N | video | 会议开始类型，可以是"video"或者 "screen_share". (不赞成) |
| option_no_video_host | N | false | 当主持人加入会议时不打开视频. |
| option_no_video_participants | N | false | 当参与人加入会议室不打开视频. |
| option_audio | N | "both" | 会议语音选项。可以是"both", "telephony", “voip”. |
JSON示例
成功：会议信息
{
"uuid":"VkTVkSlVQD+JQjHXcRMEqg==",
"id":"1474362728",
"host_id":"XJW25bXgQ1W22V37L6l_Rg",
"topic":"xxxxxxx",
"password":"",
"h323_password":"",
"status":0,
"option_jbh":false,
"option_start_type":"video",
"option_host_video":true,
"option_participants_video":true,
"option_audio":"both",
"type":2,
"type_des":null,
"start_time":"2017-01-05T08:00:00+08:00",
"duration":1,
"timezone":"Asia/Shanghai",
"start_url":"https://www.zhumu.me/s/1474362728?zpk=oTh-N1xV6cPUwCeXX9WED120gQlxqzzRsiNCdO5sl60.BwYAAAFZaGIkHwAAHCAkMzEzZDliMDctMTNmMy00OGY5LThjYWYtYjBmYzA3NjcwODBkFlhKVzI1YlhnUTFXMjJWMzdMNmxfUmcWWEpXMjViWGdRMVcyMlYzN0w2bF9SZwd0ZXN0MDAxZACzSEd4bVAtLWxjN1RsaFRHcWwzZEZBX2VMX2FiT3VHVXB3QzlVLWhsSXdyMC5CZ0lnUldRMFJsazRRVE5UZUdka1YwSjJRMWt4ZVZrMGNXSm9kRXg0TlcxcGVXTkFNREl6TURReU9EY3lZekkzWlRjMU5qRTRabVZsTkRrME5qTmpaR0UxTmpCbU4yRm1OelZsWlRrd09ERm1ObU14TlRnMll6a3dOVEl3TkRGa01XTTNOQUEAABZLVno0dGx2VFNucUUyX3lsa2RsU2dRAgMB",
"join_url":"https://www.zhumu.me/j/1474362728",
"created_at":"2017-01-04T15:29:39+08:00",
"schedule_use_pmi":false,
"auto_recording":false,
"auto_savechat":false,
"disable_polling":false,
"disable_chat":false,
"enable_e2e":false,
"enable_silentmode":false,
"disable_recording":false,
"screen_share":false,
"audio_only":false,
"enable_group_hd":false,
"no_telephony":false,
"no_voip":false,
"disable_feedback":false,
"enable_other_teleconf":false,
"enable_cmr":false,
"enable_camera_control":false,
"enable_automic_recording_cloud":false,
"disable_private_chat":false,
"disable_host_unmute_self_muted_attendee":false,
"enable_pac":false,
"enable_bo":false,
"enable_webinar_practice":false,
"enable_enter_exit_chime":false,
"enable_enter_exit_chime_host_only":false,
"use_pac_1":false,
"use_pac_2":false,
"disable_screen_share":false,
"disable_remote_control":false,
"disable_local_recording":false,
"dual_camera_support":false,
"enable_support_session":false,
"enable_file_transfer":false,
"enable_watermark":false,
"enable_cohost":false,
"end_meeting_when_host_drop":false,
"enabled_join_meeting_enforce_login":false,
"enabled_join__meeting_enforce_login_same_account":false,
"enable_closed_caption":false,
"enable_pstn_password_protection":false,
"disable_peer_to_peer":false,
"agenda":null
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
修改会议
端点: https://api.zhumu.me/v3/meeting/update
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| meeting_id | Y | 会议ID | |
| zcode | Y | 用户唯一标示 | |
| password | N | 会议密码.密码可以包含下列字符: [a-z A-Z 0-9 @ - _ *]. 最大10个字符. | |
| topic | Y | 会议主题，标题 | |
| type | Y | 创建会议类型，1-即时会议，2-计划会议，3-长期会议 | |
| start_time | N | 会议开始时间：2015-01-01 12:01:01 | |
| duration | N | 持续时间 | |
| option_jbh | N | false | 可以在主持人开始会议之前加入会议. |
| option_start_type | N | video | 会议开始类型，可以是"video"或者 "screen_share". (不赞成) |
| option_no_video_host | N | false | 当主持人加入会议时不打开视频. |
| option_no_video_participants | N | false | 当参与人加入会议室不打开视频. |
| option_audio | N | "both" | 会议语音选项。可以是"both", "telephony", “voip”. |
JSON示例
成功：会议信息
{
"meeting_id":"1841152227",
"update_at":"2015-07-06T09:03:35Z"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
查询会议
端点: https://api.zhumu.me/v3/meeting/get
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| meeting_id | Y | 会议ID | |
| zcode | Y | 用户唯一标示 |
JSON示例
成功：会议信息
{
"uuid":"VkTVkSlVQD+JQjHXcRMEqg==",
"id":"1474362728",
"host_id":"XJW25bXgQ1W22V37L6l_Rg",
"topic":"xxxxxxx",
"password":"",
"h323_password":"",
"status":0,
"option_jbh":false,
"option_start_type":"video",
"option_host_video":true,
"option_participants_video":true,
"option_audio":"both",
"type":2,
"type_des":null,
"start_time":"2017-01-05T08:00:00+08:00",
"duration":1,
"timezone":"Asia/Shanghai",
"start_url":"https://www.zhumu.me/s/1474362728?zpk=oTh-N1xV6cPUwCeXX9WED120gQlxqzzRsiNCdO5sl60.BwYAAAFZaGIkHwAAHCAkMzEzZDliMDctMTNmMy00OGY5LThjYWYtYjBmYzA3NjcwODBkFlhKVzI1YlhnUTFXMjJWMzdMNmxfUmcWWEpXMjViWGdRMVcyMlYzN0w2bF9SZwd0ZXN0MDAxZACzSEd4bVAtLWxjN1RsaFRHcWwzZEZBX2VMX2FiT3VHVXB3QzlVLWhsSXdyMC5CZ0lnUldRMFJsazRRVE5UZUdka1YwSjJRMWt4ZVZrMGNXSm9kRXg0TlcxcGVXTkFNREl6TURReU9EY3lZekkzWlRjMU5qRTRabVZsTkRrME5qTmpaR0UxTmpCbU4yRm1OelZsWlRrd09ERm1ObU14TlRnMll6a3dOVEl3TkRGa01XTTNOQUEAABZLVno0dGx2VFNucUUyX3lsa2RsU2dRAgMB",
"join_url":"https://www.zhumu.me/j/1474362728",
"created_at":"2017-01-04T15:29:39+08:00",
"schedule_use_pmi":false,
"auto_recording":false,
"auto_savechat":false,
"disable_polling":false,
"disable_chat":false,
"enable_e2e":false,
"enable_silentmode":false,
"disable_recording":false,
"screen_share":false,
"audio_only":false,
"enable_group_hd":false,
"no_telephony":false,
"no_voip":false,
"disable_feedback":false,
"enable_other_teleconf":false,
"enable_cmr":false,
"enable_camera_control":false,
"enable_automic_recording_cloud":false,
"disable_private_chat":false,
"disable_host_unmute_self_muted_attendee":false,
"enable_pac":false,
"enable_bo":false,
"enable_webinar_practice":false,
"enable_enter_exit_chime":false,
"enable_enter_exit_chime_host_only":false,
"use_pac_1":false,
"use_pac_2":false,
"disable_screen_share":false,
"disable_remote_control":false,
"disable_local_recording":false,
"dual_camera_support":false,
"enable_support_session":false,
"enable_file_transfer":false,
"enable_watermark":false,
"enable_cohost":false,
"end_meeting_when_host_drop":false,
"enabled_join_meeting_enforce_login":false,
"enabled_join__meeting_enforce_login_same_account":false,
"enable_closed_caption":false,
"enable_pstn_password_protection":false,
"disable_peer_to_peer":false,
"agenda":null
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
删除会议
通过会议id删除已有会议。
端点: https://api.zhumu.me/v3/meeting/delete
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| meeting_id | Y | 会议ID | |
| zcode | Y | 用户唯一标示 |
JSON示例
成功：删除信息
{
"id":"1841152227",
"deleted_at":"2015-07-06T09:03:39Z"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
终止会议
通过会议id 强行终止会议。
端点: https://api.zhumu.me/v3/meeting/end
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| meeting_id | Y | 会议ID | |
| zcode | Y | 用户唯一标示 |
JSON示例
成功：删除信息
{
"id":"1841152227",
" ended_at ":"2015-07-06T09:03:39Z"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
列示会议
通过Z码获取该用户下的列示会议
端点: https://api.zhumu.me/v3/meeting/list
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| page_size | N | 10 | 每页显示数量 |
| page_number | N | 1 | 当前页码 |
| zcode | Y | 用户唯一标示 |
JSON示例
成功：会议信息列表
{
"page_count": "1",
"total_records": "2",
"page_number": "1",
"page_size": "10",
"meetings": [{
"uuid":"VkTVkSlVQD+JQjHXcRMEqg==",
id":"1474362728",
"host_id":"XJW25bXgQ1W22V37L6l_Rg",
"topic":"xxxxxxx",
"password":"",
"h323_password":"",
"status":0,
"option_jbh":false,
"option_start_type":"video",
"option_host_video":true,
"option_participants_video":true,
"option_audio":"both",
"type":2,
"type_des":null,
"start_time":"2017-01-05T08:00:00+08:00",
"duration":1,
"timezone":"Asia/Shanghai",
"start_url":"https://www.zhumu.me/s/1474362728?zpk=oTh-N1xV6cPUwCeXX9WED120gQlxqzzRsiNCdO5sl60.BwYAAAFZaGIkHwAAHCAkMzEzZDliMDctMTNmMy00OGY5LThjYWYtYjBmYzA3NjcwODBkFlhKVzI1YlhnUTFXMjJWMzdMNmxfUmcWWEpXMjViWGdRMVcyMlYzN0w2bF9SZwd0ZXN0MDAxZACzSEd4bVAtLWxjN1RsaFRHcWwzZEZBX2VMX2FiT3VHVXB3QzlVLWhsSXdyMC5CZ0lnUldRMFJsazRRVE5UZUdka1YwSjJRMWt4ZVZrMGNXSm9kRXg0TlcxcGVXTkFNREl6TURReU9EY3lZekkzWlRjMU5qRTRabVZsTkRrME5qTmpaR0UxTmpCbU4yRm1OelZsWlRrd09ERm1ObU14TlRnMll6a3dOVEl3TkRGa01XTTNOQUEAABZLVno0dGx2VFNucUUyX3lsa2RsU2dRAgMB", "join_url":"https://www.zhumu.me/j/1474362728",
"created_at":"2017-01-04T15:29:39+08:00",
"schedule_use_pmi":false,
"auto_recording":false,
"auto_savechat":false,
"disable_polling":false,
"disable_chat":false,
"enable_e2e":false,
"enable_silentmode":false,
"disable_recording":false,
"screen_share":false,
"audio_only":false,
"enable_group_hd":false,
"no_telephony":false,
"no_voip":false,
"disable_feedback":false,
"enable_other_teleconf":false,
"enable_cmr":false,
"enable_camera_control":false,
"enable_automic_recording_cloud":false,
"disable_private_chat":false,
"disable_host_unmute_self_muted_attendee":false,
"enable_pac":false,
"enable_bo":false,
"enable_webinar_practice":false,
"enable_enter_exit_chime":false,
"enable_enter_exit_chime_host_only":false,
"use_pac_1":false,
"use_pac_2":false,
"disable_screen_share":false,
"disable_remote_control":false,
"disable_local_recording":false,
"dual_camera_support":false,
"enable_support_session":false,
"enable_file_transfer":false,
"enable_watermark":false,
"enable_cohost":false,
"end_meeting_when_host_drop":false,
"enabled_join_meeting_enforce_login":false,
"enabled_join__meeting_enforce_login_same_account":false,
"enable_closed_caption":false,
"enable_pstn_password_protection":false,
"disable_peer_to_peer":false,
"agenda":null
},…]
}
会议报表
会议结束后可以获取会议报表,报表会有1-5秒的延迟
地址: https://api.zhumu.me/v3/meeting/getMeetingReport
请求方式: POST
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| zcode | Y | 创建会议用户zcode | |
| meeting_uuid | Y | 会议guid |
JSON示例
{
"id": 18612254712,
"topic": "Personal Meeting Room",
"start_time": "2015-11-05T20:11:53Z",
"end_time": "2015-11-05T20:12:25Z",
"duration": 1, //整个会议的时长,单位分钟,不足一分钟按一分钟计算
"total_minutes": 2,
"users": "张三,李四",
"participantDetail": "张三(4:11-4:12), 李四(4:12-4:12)",
"participants": [
{
"name": "张三",
"join_time": "2015-11-05T20:11:57Z",
"leave_time": "2015-11-05T20:12:28Z",
"duration": 1 //单位分钟,不足一分钟按一分钟计算
},
{
"name": "李四",
"join_time": "2015-11-05T20:12:20Z",
"leave_time": "2015-11-05T20:12:29Z",
"duration": 1
}
]
}
会议状态回调通知
当一个会议开始或者结束,瞩目会给会议所属Account指定的url地址发送一个通知
接受服务需要在30秒内给予回复
接受服务返回状态值必须是200
瞩目回调通知最多做3次重试,如果3次都失败,本次通知就不在做重试;
回调触发事件:
会议开始
会议结束
说明:
参会人员加入会议或离开会议,会议中网络中断再次入会或离开,暂时没有回调通知。
注册回调地址:
| 参数 | 是否必须 | 默认 | 描述 |
| url | Y | 接收回调通知的url地址 | |
| username | Y | 用户自定义用户名 | |
| password | Y |
请求方式 : POST
回调参数:
| 参数 | 是否必须 | 默认 | 描述 |
| meeting_uuid | Y | 会议guid | |
| meeting_id | Y | 会议号 | |
| zcode | Y | 会议创建人的zcode | |
| status | Y | 会议状态: STARTED, ENDED,JBH,JOIN | |
| eventtime | Y | 事件发生时间 | |
| authorization | Y | Md5(Md5(username +”:”+ password)) |
列示账户会议信息
端点: https://api.zhumu.me/v3/meeting/metrics
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| type | Y |
1-实时会议，无需输入from, to 2-历史会议，需输入 from, to |
|
| from | N | 2016/12/21 | |
| to | N | 2016/12/21 |
JSON示例
成功：会议信息列表
{
"Code":0,
"Message":null,
"Data":
{
"from":"2016-12-20",
"to":"2016-12-21",
"type":"Live Meetings",
"page_count":1,
"page_number":1,
"page_size":30,
"total_records":4,
"meetings":
[{
"uuid":"+PYGny5rTKyaAU4awmeyCg==",
"id":18325466545,
"host":" xxxxxx的会议室 ",
"email":"xxxxxxx@xxxx.xxx",
"user_type":"Corp",
"start_time":"2016-12-21T17:13:24+08:00",
"end_time":"",
"duration":"",
"participants":2,
"has_pstn":false,
"has_voip":true,
"has_3rd_party_audio":false,
"has_video":true,
"has_screen_share":true,
"recording":0,"error":null
},...],
}
}
列示账户会议详细信息
端点: https://api.zhumu.me/v3/meeting/metricsdetail
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| meeting_id | Y | 会议uuid | |
| type | Y |
1-实时会议，无需输入from, to 2-历史会议，需输入 from, to |
|
| from | N | 2016/12/21 | |
| to | N | 2016/12/21 |
JSON示例
成功：会议信息列表
{
"Code":0,
"Message":null,
"Data":
{
"uuid":"+XB/r+ghQyOUAbH3zbNioA==",
"id":181xxxxxxxx,
"type":"Live Meeting",
"host":" xxxxxxx ",
"email":"xxxxx@suirui.com",
"user_type":"Pro|Webinar",
"start_time":"2016-12-21T07:52:34Z",
"end_time":"0001-01-01T00:00:00",
"duration":"0 Hr 58 Minutes",
"has_pstn":false,
"has_voip":true,
"has_3rd_party_audio":false,
"has_video":true,
"has_screen_share":true,
"recording": 0,
"page_count":1,
"page_number":1,
"page_size":30,
"participants_count":3,
"participants":
[{
"user_id":"16778240",
"user_name":"xxxxx",
"device":"Windows",
"ip_address":"114.247.234.178",
"cn":"CN",
"city":"Beijing",
"network_type":null,
"join_time":"2016-12-21T07:52:34Z",
"leave_time":"0001-01-01T00:00:00"
},...],
}
}
列示会议云录制信息
端点: https://api.zhumu.me/v3/meeting/mcrecording
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| meeting_id | Y | 会议ID（会议号） | |
| zcode | Y | 用户唯一标示 | |
| from | N | 2016/12/21 | |
| to | N | 2016/12/21 |
JSON示例
成功：会议信息列表
{
"Code":0,
"Message":null,
"Data":
{
"meetings":
[{
"uuid":"7ZnbKfEvRY6rCtpC43M5Yg==",
"meeting_number":1851362691,
"account_id":"vbWTiSj8TAOJSUi0fFF9og",
"host_id":"Bf-MPUlLSxWp0rlm5e0xkA",
"topic":"xxxxxx'sZhumuMeeting",
"start_time":"2017-05-15T10:04:29+08:00",
"timezone":null,
"duration":1,
"total_size":4173784,
"recording_count":2,
"recording_files":
[{
"id":"12ec1df9-de82-4ce9-8b1f-4c6bb33452cd",
"meeting_id":"7ZnbKfEvRY6rCtpC43M5Yg==",
"recording_start":"2017-05-15T10:04:39+08:00",
"recording_end":"2017-05-15T10:05:02+08:00",
"file_type":"MP4",
"file_size":4013867,
"file_path":"https://recording.zhumu.me/replay/2017/05/15/1851362691/ED99DB29-F12F-458E-AB0A-DA42E3733962/GMT20170515-020439_-------s-Zhumu-Meeting_1280x720.mp4",
"error":null
},
{
"id":"a386ac70-b850-499e-be75-5de64f01f43d",
"meeting_id":"7ZnbKfEvRY6rCtpC43M5Yg==",
"recording_start":"2017-05-15T10:04:39+08:00",
"recording_end":"2017-05-15T10:05:02+08:00",
"file_type":"M4A",
"file_size":159917,
"file_path":"https://recording.zhumu.me/replay/2017/05/15/1851362691/ED99DB29-F12F-458E-AB0A-DA42E3733962/GMT20170515-020439_-------s-Zhumu-Meeting.m4a","error":null
}],
"error":null
}],
"page_count":1,
"page_number":1,
"page_size":2147483647,
"total_records":1,
"error":null
}
}
创建webinar
端点: https://api.zhumu.me/v3/webinar/create
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| zcode | Y | 用户唯一标示 | |
| topic | Y | 会议主题，标题 | |
| type | Y | 创建会议类型，5-即时会议，6-周期会议 | |
| start_time | N | 会议开始时间：2015-01-01 12:01:01 | |
| duration | N | 持续时间 | |
| option_audio | N | "both" | 会议语音选项。可以是"both", "telephony", “voip”. |
JSON示例
成功：会议信息
{
"uuid":"Li86Zpl+TuKGFrjUr8qMAg==",
"id":1592268516,
"host_id":"XJW25bXgQ1W22V37L6l_Rg",
"topic":"xxxxxxx",
"agenda":"both",
"status":0,
"option_start_type":"video",
"option_audio":"both",
"type":5,
"start_time":null,
"duration":0,
"timezone":"",
"start_url":"https://www.zhumu.me/s/1592268516?zpk=xsL_41bVkOBP5sDu2tnZO8Gxja-ih6tzTyz-sLz7mi0.BwYAAAFZaGqP9QAAHCAkYjg2MDNiOWQtZWViYy00MzkyLTlhZWUtMzg0NjM0MzFiNGRlFlhKVzI1YlhnUTFXMjJWMzdMNmxfUmcWWEpXMjViWGdRMVcyMlYzN0w2bF9SZwd0ZXN0MDAxZACzSEd4bVAtLWxjN1RsaFRHcWwzZEZBX2VMX2FiT3VHVXB3QzlVLWhsSXdyMC5CZ0lnUldRMFJsazRRVE5UZUdka1YwSjJRMWt4ZVZrMGNXSm9kRXg0TlcxcGVXTkFNREl6TURReU9EY3lZekkzWlRjMU5qRTRabVZsTkRrME5qTmpaR0UxTmpCbU4yRm1OelZsWlRrd09ERm1ObU14TlRnMll6a3dOVEl3TkRGa01XTTNOQUEAABZLVno0dGx2VFNucUUyX3lsa2RsU2dRAgMB",
"join_url":"https://www.zhumu.me/j/1592268516",
"created_at":"2017-01-04T15:38:51+08:00"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
修改webinar
通过用户id更新瞩目用户密码。
端点: https://api.zhumu.me/v3/webinar/update
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| meeting_id | Y | 会议ID | |
| zcode | Y | 用户唯一标示 | |
| topic | Y | 会议主题，标题 | |
| type | Y | 创建会议类型，5-即时会议，6-周期会议 | |
| start_time | N | 会议开始时间：2015-01-01 12:01:01 | |
| duration | N | 持续时间 | |
| option_audio | N | "both" | 会议语音选项。可以是"both", "telephony", “voip”. |
JSON示例
成功：会议信息
{
"meeting_id":"1841152227",
"update_at":"2015-07-06T09:03:35Z",
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
查询webinar
通过用户id更新瞩目用户密码。
端点: https://api.zhumu.me/v3/webinar/get
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| meeting_id | Y | 会议ID | |
| zcode | Y | 用户唯一标示 |
JSON示例
成功：会议信息
{
"meeting_uuid": “9qU8IsjNTUuFFjqyWohT7A==”, //会议uuid
"meeting_id": "123123123",
"start_url": "https://zhumu.me/s/123456789?zpk=hs65q23kd9sqliy612h23k",
"join_url": "https://zhumu.me/j/123456789",
"created_at": "2012-11-25T12:00:00Z",
"host_id": "dh23hdu23gd",
"topic": "Topic for this meeting",
"type": 2,
"start_time": "2012-11-25T12:00:00Z",
"duration": 30,
“status”:0
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
删除webinar
通过会议id删除已有会议。
端点: https://api.zhumu.me/v3/webinar/delete
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| meeting_id | Y | 会议ID | |
| zcode | Y | 用户唯一标示 |
JSON示例
成功：删除信息
{
"id":"1841152227",
"deleted_at":"2015-07-06T09:03:39Z"
}
失败：Code-错误编号
{
“code”: 200,
“msg”: "错误信息"
}
列示webinar
通过Z码获取该用户下的列示会议。
端点: https://api.zhumu.me/v3/webinar/list
参数：
| 参数 | 是否必须 | 默认 | 描述 |
| api_key | Y | 准许访问API用户名 | |
| api_secret | Y | 准许访问API密码 | |
| page_size | N | 10 | 每页显示数量 |
| page_number | N | 1 | 当前页码 |
| zcode | Y | 用户唯一标示 |
JSON示例
成功：会议信息列表
{
"page_count": "1",
"total_records": "2",
"page_number": "1",
"page_size": "10",
"meetings": [{
"uuid":"Li86Zpl+TuKGFrjUr8qMAg==",
"id":1592268516,
"host_id":"XJW25bXgQ1W22V37L6l_Rg",
"topic":"xxxxxxx",
"agenda":"both",
"status":0,
"option_start_type":"video",
"option_audio":"both",
"type":5,
"start_time":null,
"duration":0,
"timezone":"",
"start_url":"https://www.zhumu.me/s/1592268516?zpk=xsL_41bVkOBP5sDu2tnZO8Gxja-ih6tzTyz-sLz7mi0.BwYAAAFZaGqP9QAAHCAkYjg2MDNiOWQtZWViYy00MzkyLTlhZWUtMzg0NjM0MzFiNGRlFlhKVzI1YlhnUTFXMjJWMzdMNmxfUmcWWEpXMjViWGdRMVcyMlYzN0w2bF9SZwd0ZXN0MDAxZACzSEd4bVAtLWxjN1RsaFRHcWwzZEZBX2VMX2FiT3VHVXB3QzlVLWhsSXdyMC5CZ0lnUldRMFJsazRRVE5UZUdka1YwSjJRMWt4ZVZrMGNXSm9kRXg0TlcxcGVXTkFNREl6TURReU9EY3lZekkzWlRjMU5qRTRabVZsTkRrME5qTmpaR0UxTmpCbU4yRm1OelZsWlRrd09ERm1ObU14TlRnMll6a3dOVEl3TkRGa01XTTNOQUEAABZLVno0dGx2VFNucUUyX3lsa2RsU2dRAgMB",
"join_url":"https://www.zhumu.me/j/1592268516",
"created_at":"2017-01-04T15:38:51+08:00"
},
{
"uuid":"Li86Zpl+TuKGFrjUr8qMAg==",
"id":1592268516,
"host_id":"XJW25bXgQ1W22V37L6l_Rg",
"topic":"xxxxxxx",
"agenda":"both",
"status":0,
"option_start_type":"video",
"option_audio":"both",
"type":5,
"start_time":null,
"duration":0,
"timezone":"",
"start_url":"https://www.zhumu.me/s/1592268516?zpk=xsL_41bVkOBP5sDu2tnZO8Gxja-ih6tzTyz-sLz7mi0.BwYAAAFZaGqP9QAAHCAkYjg2MDNiOWQtZWViYy00MzkyLTlhZWUtMzg0NjM0MzFiNGRlFlhKVzI1YlhnUTFXMjJWMzdMNmxfUmcWWEpXMjViWGdRMVcyMlYzN0w2bF9SZwd0ZXN0MDAxZACzSEd4bVAtLWxjN1RsaFRHcWwzZEZBX2VMX2FiT3VHVXB3QzlVLWhsSXdyMC5CZ0lnUldRMFJsazRRVE5UZUdka1YwSjJRMWt4ZVZrMGNXSm9kRXg0TlcxcGVXTkFNREl6TURReU9EY3lZekkzWlRjMU5qRTRabVZsTkRrME5qTmpaR0UxTmpCbU4yRm1OelZsWlRrd09ERm1ObU14TlRnMll6a3dOVEl3TkRGa01XTTNOQUEAABZLVno0dGx2VFNucUUyX3lsa2RsU2dRAgMB",
"join_url":"https://www.zhumu.me/j/1592268516",
"created_at":"2017-01-04T15:38:51+08:00"
}]
}