Tweet
WEBEX XML APIs
8.6. WEBEX XML APIs
Mô hình Webex XML tận dụng sự trao đổi của các tài liệu XML để triển khai các thông điệp. Mỗi thông điệp loại này liên quan đến một hoạt động Webex cụ thể. Một tài liệu XML chỉ ra các hành động mong muốn của một thành phần dịch vụ đặc biệt. Các trả lời dạng XML được trả về bởi Webex XML mô tả các trạng thái làm mới của dịch vụ, như được xác định bởi máy chủ Webex XML.
Như hình trên, một ứng dụng sẽ gửi một yêu cầu XML để thực hiện một hành động cụ thể, chẳng hạn như tạo một cuộc họp mới đến máy chủ Webex XML. Yêu cầu này sẽ mô tả trạng thái của các yếu tố kết hợp với các tác vụ của yêu cầu này. WebEx XML sau đó trả về ứng dụng ban đầu giá trị cập nhật của các thành phần này thông qua các kết quả ở định dạng XML từ WebEx.
Webex XML server có thể được truy cập ở địa chỉ https://api.Webex.com/WBXService/XMLService.
8.6.1. Tạo ra một buổi họp mới
API CreateMeeting cho phép người dùng định thời một cuộc họp. API này trả về một khóa duy nhất của phiên hịp. Bảng bên dưới mô tả API và phần thân XML để tạo ra một cuộc họp mới.
Ví dụ bên dưới mô tả làm thế nào để thực hiện một cuộc gọi API để tạo ra một buổi họp mới với một dòng tựa đề đặc biệt cho buổi họp. Kết quả thường là một meeting ID mới.
curl -X POST \
https://api.Webex.com/WBXService/XMLService \
-H 'cache-control: no-cache' \
-H 'content-type: application/xml' \
-d '<?xml version="1.0" encoding="UTF-8"?>
<serv:message
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<header>
<securityContext>
<WebexID>devasc</WebexID>
<password>Kc5Ac4Ml</password>
<siteName>apidemoeu</siteName>
</securityContext>
</header>
<body>
<bodyContent
xsi:type="java:com.Webex.service.binding.meeting.
CreateMeeting">
<metaData>
<confName>Branding
Meeting</confName>
</metaData>
<schedule>
<startDate/>
</schedule>
</bodyContent>
</body>
</serv:message>'
8.6.2. Loại API liệt kê tất cả các cuộc họp
API loại này liệt kê các thông tin tổng kết cho các cuộc họp được lên lịch. API này về khóa duy nhất cho một phiên. Bảng bên dưới mô tả dữ liệu XML cần phải được gửi theo thứ tự để liệt kê tất cả các cuộc họp, sắp xếp theo thời gian bắt đầu.
Ví dụ bên dưới mô tả làm thế nào để thực hiện một cuộc gọi API để liệt kê các cuộc họp theo thời gian.
curl -X POST \
https://api.Webex.com/WBXService/XMLService \
-H 'cache-control: no-cache' \
-H 'content-type: application/xml' \
-d '<serv:message
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<header>
<securityContext>
<WebexID>devasc</WebexID>
<password>Kc5Ac4Ml</password>
<siteName>apidemoeu</siteName>
</securityContext>
</header>
<body>
<bodyContent
xsi:type="java:com.Webex.service.binding.meeting.L stsummaryMeeting">
<order>
<orderBy>STARTTIME</orderBy>
</order>
</bodyContent>
</body>
</serv:message>'
8.6.3. Thiết lập hoặc thay đổi các thuộc tính của cuộc họp
API loại SetMeeting cho phép các máy, người dùng cập nhật thông tin cho một buổi họp đã lên lịch để họ có thể thay đổi thông tin. Bảng bên dưới mô tả các dữ liệu XML cần phải được gửi để thay đổi các thuộc tính của buổi họp.
Ví dụ bên dưới mô tả làm thế nào để thực hiện một cuộc gọi API để thêm vào một người tham dự mới (student@devasc.com) và gửi một thư mời cho người đó.
curl -X POST \
https://api.Webex.com/WBXService/XMLService \
-H 'cache-control: no-cache' \
-H 'content-type: application/xml' \
-d '<serv:message
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<header>
<securityContext>
<WebexID>devasc</WebexID>
<password>Kc5Ac4Ml</password>
<siteName>apidemoeu</siteName>
</securityContext>
</header>
<body>
<bodyContent
xsi:type="java:com.Webex.service.binding.meeting.S etMeeting">
<meetingkey>625579604</meetingkey>
<participants>
<attendees>
<attendee>
<person>
<email>student@devasc.com</email>
</person>
</attendee>
</attendees>
</participants>
<attendeeOptions>
<emailInvitations>true</emailInvitations>
</attendeeOptions>
<schedule>
<openTime>300</openTime>
</schedule>
</bodyContent>
</body>
</serv:message>'
8.6.4. Xóa một buổi họp
Loại API DelMeeting cho phép các máy có thể xóa một buổi họp không có đang diễn ra. API tiếp tục sử dụng phương thức POST, nhưng phần dữ liệu XML chứa tác vụ xóa cuộc họp. Bảng bên dưới mô tả các dữ liệu XML được gửi để xóa một cuộc họp.
Ví dụ bên dưới mô tả làm thế nào để thực hiện một cuộc gọi API để xóa buổi họp có meeting ID =625579604.
curl -X POST \
https://api.Webex.com/WBXService/XMLService \
-H 'cache-control: no-cache' \
-H 'content-type: application/xml' \
-d '<serv:message
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<header>
<securityContext>
<WebexID>devasc</WebexID>
<password>Kc5Ac4Ml</password>
<siteName>apidemoeu</siteName>
</securityContext>
</header>
<body>
<bodyContent
xsi:type="java:com.Webex.service.binding.meeting.D elMeeting">
<meetingKey>625579604</meetingKey>
</bodyContent>
</body>
</serv:message>'
Loại API Meeting XML đưa ra một phương pháp để tích hợp dịch vụ Webex Meeting vào trang web portal hay vào ứng dụng. Để biết thêm chi tiết về Webex Meetings APIs, hãy tham khảo https://developer.cisco.com/docs/Web...Webex-meetings.
Mô hình Webex XML tận dụng sự trao đổi của các tài liệu XML để triển khai các thông điệp. Mỗi thông điệp loại này liên quan đến một hoạt động Webex cụ thể. Một tài liệu XML chỉ ra các hành động mong muốn của một thành phần dịch vụ đặc biệt. Các trả lời dạng XML được trả về bởi Webex XML mô tả các trạng thái làm mới của dịch vụ, như được xác định bởi máy chủ Webex XML.
Như hình trên, một ứng dụng sẽ gửi một yêu cầu XML để thực hiện một hành động cụ thể, chẳng hạn như tạo một cuộc họp mới đến máy chủ Webex XML. Yêu cầu này sẽ mô tả trạng thái của các yếu tố kết hợp với các tác vụ của yêu cầu này. WebEx XML sau đó trả về ứng dụng ban đầu giá trị cập nhật của các thành phần này thông qua các kết quả ở định dạng XML từ WebEx.
Webex XML server có thể được truy cập ở địa chỉ https://api.Webex.com/WBXService/XMLService.
8.6.1. Tạo ra một buổi họp mới
API CreateMeeting cho phép người dùng định thời một cuộc họp. API này trả về một khóa duy nhất của phiên hịp. Bảng bên dưới mô tả API và phần thân XML để tạo ra một cuộc họp mới.
| Phương thức | API | Mô tả |
| POST | https://api.Webex.com/WB XService/XMLService with XML body: <body> <bodyContent xsi:type="java:com.Webex.service.binding.meeting.C reat eMeeting"> <metaData> <confName>Brandi ng Meeting</confName> </metaData> <schedule> <startDate/> </schedule> </bodyContent> </body> |
Tạo ra một buổi họp mới với các thuộc tính chẳng hạn như tên, thời gian bắt đầu, mật khẩu, tên người dùng. |
curl -X POST \
https://api.Webex.com/WBXService/XMLService \
-H 'cache-control: no-cache' \
-H 'content-type: application/xml' \
-d '<?xml version="1.0" encoding="UTF-8"?>
<serv:message
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<header>
<securityContext>
<WebexID>devasc</WebexID>
<password>Kc5Ac4Ml</password>
<siteName>apidemoeu</siteName>
</securityContext>
</header>
<body>
<bodyContent
xsi:type="java:com.Webex.service.binding.meeting.
CreateMeeting">
<metaData>
<confName>Branding
Meeting</confName>
</metaData>
<schedule>
<startDate/>
</schedule>
</bodyContent>
</body>
</serv:message>'
8.6.2. Loại API liệt kê tất cả các cuộc họp
API loại này liệt kê các thông tin tổng kết cho các cuộc họp được lên lịch. API này về khóa duy nhất cho một phiên. Bảng bên dưới mô tả dữ liệu XML cần phải được gửi theo thứ tự để liệt kê tất cả các cuộc họp, sắp xếp theo thời gian bắt đầu.
| Phương thức | API | Mô tả |
| POST | https://api.Webex.com/WBXService/X MLService with XML body: <body> <bodyContent xsi:type="java:com.Webex.service.b inding.meeting.LstsummaryMeeting"> <order> <orderBy>STARTTIME</orderBy > </order> </bodyContent> </body> |
Liệt kê tất cả các cuộc họp đáp ứng một tiêu chuẩn nào đó. |
curl -X POST \
https://api.Webex.com/WBXService/XMLService \
-H 'cache-control: no-cache' \
-H 'content-type: application/xml' \
-d '<serv:message
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<header>
<securityContext>
<WebexID>devasc</WebexID>
<password>Kc5Ac4Ml</password>
<siteName>apidemoeu</siteName>
</securityContext>
</header>
<body>
<bodyContent
xsi:type="java:com.Webex.service.binding.meeting.L stsummaryMeeting">
<order>
<orderBy>STARTTIME</orderBy>
</order>
</bodyContent>
</body>
</serv:message>'
8.6.3. Thiết lập hoặc thay đổi các thuộc tính của cuộc họp
API loại SetMeeting cho phép các máy, người dùng cập nhật thông tin cho một buổi họp đã lên lịch để họ có thể thay đổi thông tin. Bảng bên dưới mô tả các dữ liệu XML cần phải được gửi để thay đổi các thuộc tính của buổi họp.
| Phương thức | API | Mô tả |
| POST | https://api.Webex.com/ WBXService/XMLServic e with XML body: <bodyContent xsi:type="java:com.W ebex.service.binding.mee ting.SetMeeting"> <meetingkey>625579 604</meetingkey> <participants> <attendees> <attendee> <person> <email>student@devasc.com</email> </person> </attendee> </attendees> </bodyContent> |
Cập nhật các thuộc tính cuộc họp chẳng hạn như về người tha dự, ghi lại cuộc họp, lên lịch và hỗ trợ các loại tài liệu. |
curl -X POST \
https://api.Webex.com/WBXService/XMLService \
-H 'cache-control: no-cache' \
-H 'content-type: application/xml' \
-d '<serv:message
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<header>
<securityContext>
<WebexID>devasc</WebexID>
<password>Kc5Ac4Ml</password>
<siteName>apidemoeu</siteName>
</securityContext>
</header>
<body>
<bodyContent
xsi:type="java:com.Webex.service.binding.meeting.S etMeeting">
<meetingkey>625579604</meetingkey>
<participants>
<attendees>
<attendee>
<person>
<email>student@devasc.com</email>
</person>
</attendee>
</attendees>
</participants>
<attendeeOptions>
<emailInvitations>true</emailInvitations>
</attendeeOptions>
<schedule>
<openTime>300</openTime>
</schedule>
</bodyContent>
</body>
</serv:message>'
8.6.4. Xóa một buổi họp
Loại API DelMeeting cho phép các máy có thể xóa một buổi họp không có đang diễn ra. API tiếp tục sử dụng phương thức POST, nhưng phần dữ liệu XML chứa tác vụ xóa cuộc họp. Bảng bên dưới mô tả các dữ liệu XML được gửi để xóa một cuộc họp.
| Phương thức | API | Mô tả |
| POST | https://api.Webex.com/WBXServic e/XMLService with XML body: <body> <bodyContent xsi:type="java:com.Webex.se rvice.binding.meeting.DelMeeting" > <meetingKey>625579604</ meetingKey> </bodyContent> </body> |
Xóa hay hủy một buổi họp có meeting ID. |
curl -X POST \
https://api.Webex.com/WBXService/XMLService \
-H 'cache-control: no-cache' \
-H 'content-type: application/xml' \
-d '<serv:message
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<header>
<securityContext>
<WebexID>devasc</WebexID>
<password>Kc5Ac4Ml</password>
<siteName>apidemoeu</siteName>
</securityContext>
</header>
<body>
<bodyContent
xsi:type="java:com.Webex.service.binding.meeting.D elMeeting">
<meetingKey>625579604</meetingKey>
</bodyContent>
</body>
</serv:message>'
Loại API Meeting XML đưa ra một phương pháp để tích hợp dịch vụ Webex Meeting vào trang web portal hay vào ứng dụng. Để biết thêm chi tiết về Webex Meetings APIs, hãy tham khảo https://developer.cisco.com/docs/Web...Webex-meetings.