11.4 列出多个培训信息编程中调用 URL API URL API 语法 URL API 常用功能开会登陆一步执行加会... 2

Size: px

Start display at page:

Download "11.4 列出多个培训信息编程中调用 URL API URL API 语法 URL API 常用功能开会登陆一步执行加会... 2"

紬钞梅
5 years ago
Views:

1 WebEx API 快速指南 1 文档目的前提 API 种类 XML API XML API 测试页第一次调用 XML API XML API 结构 Request Response Error 数据格式 XML API 分类用户 API 创建用户取得用户信息会议 API 创建会议取得会议信息修改会议信息列出多个会议信息获得主持人开会地址按时段查询会议获得加会地址删除会议培训 API 创建培训取得培训信息修改培训信息... 17

2 11.4 列出多个培训信息编程中调用 URL API URL API 语法 URL API 常用功能开会登陆一步执行加会关闭会议详细文档 Mobile API 附录文档目的本文档目的是让用户快速了解 Webex API 的使用, 它是对 Webex 官方英文文档的简化 2 前提 1. 您大致了解了 WebEx 的会议系统, 以及关于站点, 用户, 会议, 参与者的概念 2. 在和 WebEx XML API 做集成开发前, 您应该已经知道你帐号的 WebEx 的站点名字 ( 下面以 SiteName 表示 ) 和您的用户名 (WebExID) 和密码 (Password) 下面的所有的 demo 中, 需要填写你自己的信息 3 API 种类 Webex 提供了 XMLAPI, URL API, WebEx Mobile API, TSPAPI,WebACD API, NBR Web Service API 本文档主要介绍 XML API,URL API 和 WebEx Mobile API

3 4 XML API XML API 是用 web 的方式访问, 用 post 方式发送一个 XML 文本请求, 服务器会返回一个 xml 文本 5 XML API 测试页你可以用下面的 test page 在浏览器中测试 XML API. 注意,WebEx 因为安全原因, 不久将来将只支持 https, 不支持 http 访问 <html> <head> <meta http-equiv="content-type" content="textml; charset=utf-8" /> </head> <font size="5" >WebEx XML API Test Page</font> <br> <br> <form action= method=get> <textarea rows =22 columns = 50 cols="88" name="xml"> </textarea> <br> <input name="submit" type="submit" value="submit"> </form> </html> 注意 : 需要用你的站点名称替换红色的 SiteName 然后将上面的文本存为 html 文件, 在浏览器中打开, 就可以进行简单的 Webex XML API 测试 6 第一次调用 XML API 配置完 Test Page 后就可以在浏览器中访问 test page 进行测试我们调用的第一个 API 是 GetUser API 这个 API 可以取得你自己的帐号信息, 下面是 request text

4 <?xml version="1.0" encoding="utf-8"?> <message <bodycontent xsi:type="java:com.webex.service.binding.user.getuser"> <webexid>webexid</webexid> </message> 在浏览器中打开刚才生成的 test page, 输上面的内容再将上面的 xml 文本, 红色的文字部分换成你的信息, 点击 submit 按钮就可以执行你将得到类似下面的结果

5 这样你就的第一个 XML API 就访问成功了注意, 如果测试的时候, 没有返回, 可以把测试页中的 method=post 改成 method=get, 或者换用 IE 浏览器试一试 7 XML API 结构你的第一个 API 调用成功, 现在就来介绍 XML API 的结构每个 XML API 都分成 Request ( 请求 ),Response ( 返回 ) 两部分通过上面的 Test page 可以看到通过 Http Post 提交 Request, 就会返回 response 7.1 Request XML API 的请求分为两部分一部分是请求头 (header) 另一部分是请求的主体 (body) header 部分, 里面主要包含 securitycontext 安全验证信息, 每个 API 都一样如上面最简单的 GetUser 请求为例 : 主要包含站点, 用户名, 和密码三个字段另一部分是 Body, 每个 API 都不相同包含请求的具体信息你需要在

6 xsi:type 中指定到底访问的是哪个 API 同样以 GetUser 为例 <bodycontent xsi:type="java:com.webex.service.binding.user.getuser"> <webexid>webexid</webexid> com.webex.service.binding.user.getuser 指定的是具体需要执行的 API 至于具体内容, 其实只有一个 WebexID, 就是你想要要取的用户帐号的帐号名 7.2 Response 返回的 response 部分也同 request 一样, 包含 header 和 body 两部分, header 内容包含命令执行成功还是失败以及当前服务器是 PRIMARY 还是 BACKUP. 所有的 API 返回都是一样 GetUser 例子如下 <serv:header> <serv:response> <serv:result>success</serv:result> <serv:gsbstatus>primary</serv:gsbstatus> </serv:response> </serv:header> body 里包含返回的主体每个 API 都不一样 GetUser 例子如下它返回了所有用户相关信息 <serv:body> <serv:bodycontent xmlns:xsi=" xsi:type="use:getuserresponse"> <use:firstname>bigpade</use:firstname> </serv:bodycontent> </serv:body> 7.3 Error 如果 API request 错误比如上面的 request 中的用户名使用某个不存在的 ID 就会返回下面的错误 response

7 ...> <serv:header> <serv:response> <serv:result>failure</serv:result> <serv:reason>corresponding User not found</serv:reason> <serv:gsbstatus>primary</serv:gsbstatus> <serv:exceptionid>030001</serv:exceptionid> </serv:response> </serv:header> <serv:body> <serv:bodycontent /> </serv:body> 你可以根据 result 是否为 FAILURE, 判断是是否出错还可以取具体错误原因 reason 和错误 ID exceptionid 7.4 数据格式 API 中的 Date 类型的格式为 MM/dd/yyyy HH:mm:ss 8 XML API 分类 Webex 提供了许多服务根据服务不同,XML API 可以分为下面几类 : User service : 提供用户相关 API General Session service : 通用的会议相关 API Meeting service: 会议中心 (MC) 相关 API Training Session Service: 培训中心 (TC) 相关 API Event Session Service: 网络研讨会, 事件中心 (EC) 相关 API Support Session Service: 支持中心 (SC) 相关 API History Service: 历史记录相关 API Site Service: 站点管理相关 API Meeting Attendee Service: 会议参加者相关 API Meeting Type Service: 会议类型相关 API 具体可以参考附录中的官方 xml API 参考手册本文档只简单介绍几种常用的 API 其他 API, 以及具体 API 的细节, 都可以在 API 参考手册, 以及 API 的 xsd 文件中查找到具体使用规范

8 注意, 下面的所有的 xml 文档, 测试时, 都需要把用户信息和上面 GetUser API 一样替换成自己的相关信息, 文档中不会再做说明 9 用户 API User service 里面常用的是 CreateUser,GetUser. 9.1 创建用户建立个拥有开会权限的新用户 Create User <?xml version="1.0" encoding="utf-8"?> <bodycontent xsi:type="java:com.webex.service.binding.user.createuser"> <firstname>jason</firstname> <lastname>chen</lastname> <webexid>jasonc</webexid> < >jasonc@sina.com</ > <password>111111</password> <active>activated</active> <privilege> <host>true</host> </privilege>

9 9.2 取得用户信息文档开始第一次调用的 API, 就是 GetUser API 10 会议 API 会议 API,Meeting service 里面最常用的是 create meeting,get Meeting, Set Meeting,List meeting,del meeting, 已经取到开会和加会信息 10.1 创建会议你可以用 Create Meeting API 创建会议比如用户安排了一个 2015 年 11 月 30 号 10 点开的一个会议, 会议的密码是 , 时间 20 分钟, 会议的名称是 sample meeting, 议程为 test XML request <?xml version="1.0" encoding="utf-8"?> <bodycontent xsi:type="java:com.webex.service.binding.meeting.createmeeti ng"> <accesscontrol> <meetingpassword>111111</meetingpassword> </accesscontrol> <metadata> <confname>sample Meeting</confName> <agenda>test</agenda> </metadata> <schedule> <startdate>11/30/ :00:00</startDate> <duration>20</duration>

10 </schedule> 执行成功后返回如下注意返回的 meetingkey 需要记下来, 这是会议的 ID, 取这个会议信息的时候需要用 10.2 取得会议信息你可以用 GetMeeting API 取到某个会议的详细信息 XML request 如下 <?xml version="1.0" encoding="utf-8"?> <bodycontent xsi:type="java:com.webex.service.binding.meeting.getmeeting" > <meetingkey> </meetingkey>

11 注意 meeting key 用的是上面 Create Meeting response 的 meeting key Reponse 此处省略 10.3 修改会议信息创建会议后, 你还可以用 SetMeeting API 来修改 meeting 比如你想修改上面创建会议的议程你可以用下面的 request 注意, 你会发现所有 Meeting service 的 xsd 是一样的也就是 Create Meeting,Set meeting 的输入格式和 Get meeting 的返回格式是一致的你可以根据 xsd, 也可以参考 Get meeting 的 response 来写 request 其他类别的 API 也一样 <?xml version="1.0" encoding="utf-8"?> <bodycontent xsi:type="java:com.webex.service.binding.meeting.setmeeting" > <metadata> <agenda>chnanged</agenda> </metadata> <meetingkey> </meetingkey>

12 10.4 列出多个会议信息如果你希望 list 多个 Meeting 信息, 你可以调用 LstsummaryMeeting API, 这个 API 可以安装你的条件, 进行内容列表比如下面的 request 就是列出这个 site 所有的 meeting (public, 公开的会议 ) 按照会议的开始时间排序 <?xml version="1.0" encoding="utf-8"?> <bodycontent xsi:type="java:com.webex.service.binding.meeting.lstsummarym eeting"> <listcontrol> <startfrom>1</startfrom> <maximumnum>10</maximumnum> <listmethod>or</listmethod> </listcontrol> <order> <orderby>starttime</orderby> <orderad>asc</orderad> </order> 这里面有两个在 API 比较通用的 element Order: 按照多个条件进行排序 listcontrol: 分页显示

13 10.5 获得主持人开会地址当你开会的时候, 你希望获得开会地址, 你可以通过 GethosturlMeeting API 来获得开会地址 <?xml version="1.0" encoding="utf-8"?> <bodycontent xsi:type="java:com.webex.service.binding.meeting.gethosturlm eeting"> <meetingkey> </meetingkey> 返回信息为在浏览器上输入返回的 hostmeetingurl 地址, 就可以直接打开 webex meeting client 开会

14 10.6 按时段查询会议当你想查询某个时段的会议信息, 或者某个时段某人的会议, 你可以通过 LstsummarySession API 来获得会议的信息 <?xml version="1.0" encoding="utf-8"?> xmlns:xsi=" xmlns:serv=" <sitename> SiteName </sitename> <webexid> WebexID </webexid> <bodycontent xsi:type="java:com.webex.service.binding.ep.lstsummarysessio n"> <datescope> <startdatestart>01/22/ :00:00</startDateStart> <enddateend>01/22/ :00:00</endDateEnd> <timezoneid>45</timezoneid> </datescope> 10.7 获得加会地址同样道理, 调用 GetjoinurlMeeting <?xml version="1.0" encoding="utf-8"?>

15 <bodycontent xsi:type="java:com.webex.service.binding.meeting.getjoinurlm eeting"> <meetingkey> </meetingkey> 会返回 joinmeetingurl, 该地址可以用来加会 10.8 删除会议如果你改变计划, 希望删除掉某个会议, 可以用 DelMeeting 来删除会议 <?xml version="1.0" encoding="utf-8"?> <bodycontent xsi:type="java:com.webex.service.binding.meeting. DelMeeting"> <meetingkey>111111</meetingkey>

16 11 培训 API Train Session Service ( 在线培训 ) 和 Meeting service 类似, 不过一个管理的是培训课程 (Train session ), 一个管理的是会议里面最常用的是 create Train Session,get Train Session,Set Train Session 和 List Train Session 11.1 创建培训使用 Create Train Session API 用户安排了一个 2015 年 11 月 30 号 10 点开的一个培训课程, 会议的密码是 , 时间 60 分钟, 会议的名称是 sample training session, 议程为 test <?xml version="1.0" encoding="iso "?> <bodycontent xsi:type= "java:com.webex.service.binding.training.createtrainingsessi on"> <accesscontrol> <sessionpassword>111111</sessionpassword> </accesscontrol> <schedule> <startdate>11/30/ :00:00</startDate> <duration>60</duration> </schedule> <metadata> <confname>sample training session </confname> <agenda>test</agenda>

17 <description>description</description> </metadata> 11.2 取得培训信息取某个培训课程的信息 <?xml version="1.0" encoding="iso "?> <bodycontent xsi:type="java:com.webex.service.binding.training.gettrainin gsession"> <sessionkey> </sessionkey> 11.3 修改培训信息修改某个培训课程的信息 <?xml version="1.0" encoding="iso "?>

18 <bodycontent xsi:type="java:com.webex.service.binding.training.settrainin gsession"> <metadata> <agenda>changed</agenda> </metadata> <sessionkey> </sessionkey> 11.4 列出多个培训信息 LstsummaryTrainingSession API 列出从 2015 年 3 月 10 日起的, 这个 site 所有的培训课程 (public, 公开的会议 ) 按照开始时间排序 <?xml version="1.0" encoding="iso "?> <bodycontent xsi:type= "java:com.webex.service.binding.training.lstsummarytrainings ession"> <listcontrol> <startfrom>1</startfrom> <maximumnum>10</maximumnum>

19 <listmethod>or</listmethod> </listcontrol> <order> <orderby>starttime</orderby> <orderad>asc</orderad> </order> <datescope> <startdatestart>03/10/ :00:00</startDateStart> <timezoneid>45</timezoneid> </datescope> 12 编程中调用测试的时候, 你可以用 test page 去测试实际在代码中调用 XML API 可以参考下面 sample Java code 调用例子 javasample.txt PHP,ASP,C# code 调用的例子可以参考 13 URL API XML API 只能处理会前会后的逻辑如果开会, 加会, 可以按照上面介绍, 先调用 XML 取得开会加会地址, 然后再加会也可以通过另外的方法, 使用 WebEx URL API 直接加会下面对 URL API 使用也做个简单介绍 WebEx URL API 提供一种基于浏览器 (HTTPS) 对 WebEx 的操作, 你可以在浏览器地址栏中直接执行 14 URL API 语法 URL AP 的语法为 &commandargument

20 sitename : 你帐号的 WebEx 的站点名 function : 这个 API 的 funtion page,url api 把按照功能分为几个 php page 功能比如 meeting 相关的功能都集中在 m.php command : 是这个 funciton 下面的子功能比如 start meeting 就是 HM commandargument : URL 格式的多个 API 参数下面以 start meeting 为例, 在 test site 上召开 meeting key 为的会议 API 为注意 get 格式只是为了方便说明格式,WebEx 因为安全原因, 要求密码的 API 只能使用 POST 方式, 请参照如下代码提交 ( 请用相应的值替换 %% 变量 ): <html> <form action=" method="post"> <input name="at" Type="text" value="li" size=30 /> <br> <input name="wid" Type="text" value="%username%" size=30 /> <br> <input name="pw" Type="text" value="%password%" size=30 /> <br> <input name="mu" Type="text" value= &MK=%MeetingNumber% size=75 /> <br> <input type="submit" text="submit" /> <form> </html> 15 URL API 常用功能 15.1 开会你可以通过 HM(Host Meeting )API 来开会语法 m.php?at=hm &MK=MeetingKey

21 MK, 你相要开会的会议号 meeting key, 这个会议好你安排会议后应该会得到的例子见上面请参照 14 URL API 语法及 html sample code 去提交你的链接 (post 方式 ) 15.2 登陆上面的命令是 Start meeting, 但是在 Start meeting 前, 你必须要登陆, 验证了你身份后, 才有权限开会下面是登录的语法 p.php?at=li &WID=WebExID [&PW=Password] WID: 你的 webex 帐号 PW: 你的帐号密码请参照 14 URL API 语法及 html sample code 去提交你的链接 (post 方式 ) 下面例子为 get 方式 : 例子你可以在浏览器中执行这个 API, 就会发现用户会处于登录后状态再在这个浏览器地址栏执行上面的开会命令, 就可以开会了 15.3 一步执行上面开会分为两部,URL API 也支持通过一个 API 来执行你可以在登录后再执行下一个 API 把 start meeting API url encode 后作为 MU 的参数加在 login API 后面就可以了系统会在执行 Login API 后在执行 MU 的参数比如上面两个 API 一步执行的例子如下 f%2ftest.webex.com.cn%2ftest%2fm.php%3fat%3dhm%26mk%3d 这样就可以在浏览器上执行一次就可以登陆开会了

22 15.4 加会如果你不是 meeting 主持人, 你可以通过调用下面 JM(Join Meeting)API 加入会议 m.php?at=jm &MK=MeetingKey [&AN=AttendeeName] [&AE=Attendee ] MK, 会议号 meeting key AN 和 AE, 加会时候需要输入的参加者姓名和邮件, 可选, 如果在 API 里面填写了, 加会时就不需要再输入了请参照 14 URL API 语法及 html sample code 去提交你的链接 (post 方式 ) 下面例子为 get 方式 : 例子关闭会议如何你是 host, 你还可以通过 KM(kill meeting) API 来关闭会议语法 w.php?at=km &MK=MeetingKey [&WID=WebExID] [&PW=Password] MK, 会议号 meeting key WID: 你的 webex 帐号 PW: 你的帐号密码 15.6 详细文档上面只是 URLAPI 简单的介绍, 详细文档, 可以参考附录中的 webex 官方文档

23 16 Mobile API 可以通过 wbx schema 在移动端实现一键启会, 和一键加会比如在 Android 加会可以使用下面的 url wbx://meeting?mk= &mpw= 在 Android 端用下面的代码调用 Intent intent = new Intent(Intent.ACTION_VIEW); intent.setdata(uri.parse(url)); activity.startactivityforresult(intent,webexinvokerequest); 将会调用 WebEx app 的加入会议功能具体可以参考相关文档 17 附录 ce/ WebEx XML API 最新版本官方手册 WebEx XML API 手册 esponsedocuments.html 虽然这个文档 API 不是最新, 但是这个文档里面比最新手册多了相关概念的介绍和附录更全面最新的 WebEx XML API xsd WebEx URL API Overview WebEx URL API release and guide

09 (File Processes) (mkdir) 9-3 (createnewfile) 9-4 (write) 9-5 (read) 9-6 (deletefile) 9-7 (deletedir) (Exercises)

09 (File Processes) (mkdir) 9-3 (createnewfile) 9-4 (write) 9-5 (read) 9-6 (deletefile) 9-7 (deletedir) (Exercises) 09 (File Processes) 9-1 9-2 (mkdir) 9-3 (createnewfile) 9-4 (write) 9-5 (read) 9-6 (deletefile) 9-7 (deletedir) (Exercises) Java Servlet 9-1 Servlet (File Processes) Client Servlet Servlet Java Java (Stream)

11.4 列出多个培训信息 编程中调用 URL API URL API 语法 URL API 常用功能 开会 登陆 一步执行 加会... 2

11.4 列出多个培训信息编程中调用 URL API URL API 语法 URL API 常用功能开会登陆一步执行加会... 2