מצא את כל המידע החשוב הדרוש לך אודות ה- API של פגישות Webex של Cisco, כגון שינויי סכימה והכרזות אחרות.
לקבלת מידע נוסף על XML API 39 ו- XML API 11, עיין בסקירה הכללית של עדכוני XML API של פגישות Cisco Webex (XML API 39 ואילך)
לקבלת מידע נוסף על XML API 40, עיין בסקירה הכללית של עדכוני ה-API של XML של פגישות Webex של Cisco (XML API 40 ואילך).
לקבלת עדכונים עבור XML API 11 SP9 ואילך, עבור אל Cisco DevNet.
עדכוני API 41.12.0
עדכוני XML API 41.12.0
לחץ כאן כדי להוריד את סכימתXML API 41.12.0.
XMLAPI יחסום את לוח הזמנים והעריכה של אירועי Webex (קלאסי) בהתאם לפריט תצורת האתר של EnableClassicEvent
זה לא נכון
ממשקי API מושפעים ושינויי סכימה
בדף קביעת תצורה של ניהול אתר, אם תיבת הסימון 'הפעל אירוע קלאסי' היא שקרית, אתר זה לא יתמוך יותר בפגישות של אירועי Webex (קלאסיים).
אם תיבת הסימון הפוך את ה-ClassicEvent לזמין אינה נכונה, אתה קורא לממשקי API אלה כדי להפעיל את פגישת אירועי Webex (קלאסית):
CreateEvent
, SetEvent
, GetEvent
, GetSessionInfo
, LstsummaryEvent
, LstrecordedEvent
, LstsummaryProgram
, UploadEventImage
ה- API יגיב לחריגה חדשה 010106 האירוע הקלאסי הושבת.
שינויים בסכימה
אין שינויים בסכימה.
דוגמה לבקשת API ותגובה
יצירת בקשה ותגובה של API של CreateEvent
בקשה של CreateEvent
<bodyContent xsi:type="java:com.webex.service.binding.event.CreateEvent">
<accessControl>
<sessionPassword>XXXXXXXX</sessionPassword>
</accessControl>
<metaData>
<sessionName>XMLAPI EC Testing</sessionName>
</metaData>
<schedule>
<startDate>07/17/2021 01:29:15</startDate>
<openTime>15</openTime>
</schedule>
</bodyContent>
</body>
</serv:message>
תגובה של CreateEvent
<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common"
xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>FAILURE</serv:result>
<serv:reason>The classic Event has been disabled.</serv:reason>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
<serv:exceptionID>010106</serv:exceptionID>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent/>
</serv:body>
</serv:message>
CreateEvent3.1.3 משפיע על ממשקי API:
SetEvent GetEvent
GetSessionInfo
LstsummaryEvent
LstrecordedEvent
LstsummaryProgram
UploadEventImage
XMLAPI LstMeetingType
יגיב לאלמנט חדש של subProductCodePrefix
ממשקי API מושפעים
נוכחי את ה- API LstMeetingType
רכיב תגובה של productionCodePrefix
PRO, AUO ואחרים שהם Webex מוגדרים מראש פוגשים קידומת סוג.:
לאחר שיפור חדש זה, ה- API יגיב לרכיב חדש של subProdctCodePrefix
:P RO1, PRO2 וכו 'אשר ניתן להתאים אישית לפגוש קידומת סוג.
שינויים בסכימה ב-API: LstMeetingType
זה יגיב אלמנט חדש: subProdctCodePrefix
דוגמה לבקשת API ותגובה
LstMeetingType
בקשת API ותגובה
בקשה של LstMeetingType
<bodyContent xsi:type="java:com.webex.service.binding.meetingtype.LstMeetingType">
<meetingTypeID>13810</meetingTypeID>
</bodyContent>
</body>
</serv:message>
תגובה של LstMeetingType
<serv:body>
<serv:bodyContent xsi:type="mtgtype:lstMeetingTypeResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<mtgtype:matchingRecords>
<serv:total>1</serv:total>
<serv:returned>1</serv:returned>
<serv:startFrom>1</serv:startFrom>
</mtgtype:matchingRecords>
<mtgtype:meetingType>
<mtgtype:productCodePrefix>PRO</mtgtype:productCodePrefix>
<mtgtype:subProductCodePrefix>PRO3</mtgtype:subProductCodePrefix> //New element for customized meeting
type
<mtgtype:active>ACTIVATED</mtgtype:active>
<mtgtype:name>Cus_Chat_Closed</mtgtype:name>
<mtgtype:displayName>Cus_Chat_Closed</mtgtype:displayName>
API 41.11.0 עדכונים
XML API 41.11.0 עדכונים
לחץ כאן כדי להוריד את סכימתXML API 41.11.0.
XML API תומך בתאימות קדימה ב- API של ניהול משתמשים עבור אתרים מנוהלים של Control Hub
ממשקי API מושפעים ושינויי סכימה
אם יישום האינטגרציה שלך משתמש כעת בממשקי API של ניהול משתמשים של Webex XMLAPI: CreateUser
, SetUser
, DelUser
, וגם GetUser
כדי להקצות או לנהל משתמשים, לאחר שהאתר הקלאסי של Webex שלך הומר לאתר מנוהל של Control Hub, ממשקי API אלה ימשיכו לפעול לתאימות קדימה. ישנם כמה שינויי התנהגות כפי שצוין להלן:
בעת שימוש ב - createUser- אם מצב המשתמש ב- Control Hub אינו "פעיל" אז מצב המשתמש באתר לא יהיה פעיל. אם מצב המשתמש ב- Control Hub פעיל, מצב המשתמש באתר פעיל גם הוא, עיין: מצב משתמש של משתמשים חדשים ומומרים במרכזהבקרה.
אלמנט הסיסמה של ממשקי API של CreateUser ו- SetUser יתעלם, אנו מתחילים לשלוח דוא"ל הפעלה למשתמשים חדשים, משתמשים יכולים ללחוץ על הקישור בדוא"ל לחשבון חדש פעיל ולהזין סיסמה חדשה.
האלמנט הפעיל של CreateUser API יתעלם, לא ניתן יהיה להפעיל משתמש חדש (לא להיות מאומת) באמצעות פרמטר זה באמצעות API SetUser.
הערך של רכיב webExId בגוףחיבור של ממשקי API של CreateUser חייב להיות זהה לדואר אלקטרוני. אם webExId שונה מדואר אלקטרוני , אנו נתייחס ל - webExId זהה לדואר אלקטרוני בעת אחסון אותו ב- WebDB והערך יתעלם.
הערך של רכיב webExId בגוףקוונט של ממשקי API של SetUser חייב להיות זהות משתמש של כתובת דואר אלקטרוני, אתה יכול לשנות אותו באמצעות דואר אלקטרוני > ב- bodyContent.
ה - API של SetUser יתמוך בשינוי הודעת הדואר האלקטרוני של המשתמש הקיים: זה מצליח אם חשבון הפעולה ב- SecurityContext הוא מנהל האתר המלא של Control Hub. אחרת, ה- API מדווח על שגיאה באמצעות קוד שגיאה חדש והודעה להלן:
030120 החשבון חייב להיות מנהל אתר מלא כדי לשנות את הדואר האלקטרוני.
האלמנט newWebExId בגוףContent של SetUser API יתעלם.
ה- API של SetUser מנסה לשנות לדואר אלקטרוני שכבר נמצא בשימוש, ה- API מעלה מתחת לקוד שגיאה חדש ולהודעת שגיאה:
030118 דואר אלקטרוני כבר נמצא בשימוש באתרים מנוהלים של Control Hub.
ה- API של DelUser משבית את המשתמש בצד הפגישה של Webex ורישיון הפגישה המתאים מוסר מאתר Webex. ניתן להפעיל מחדש משתמש מושבת זה באמצעות API: SetUser (<active>ACTIVATED</active>) כל עוד המשתמש אומת לפני כן.
ממשקי ה- API של CreateUser ו - SetUser מעלים קוד שגיאה חדש ואת הודעת השגיאה כפי שמוצג להלן:
030117, משתמש זה קיים מחוץ לארגון שלך, ולכן יש לתבוע אותו, כדי לעבור לארגון שלך באמצעות תהליך המשתמש בתביעה. לקבלת שלבים לתבוע את המשתמש לארגון שלך, ראה תביעת משתמשים לארגון שלך (המרת משתמשים). יהיה עליך לאמת את התחום שאליו שייך המשתמש לפני תביעת המשתמש.
030119 אסימון הגישה של CI חייב לכלול את היקף webexsquare: מנהל בעת הקצאת משאבים למשתמש.
רק לתקופה מוגבלת נתמכת תאימות קדימה. אנו נספק הודעה מוקדמת לפני שתאימות זו תוסר. |
שינויים בסכימה
אין שינויים בסכימה בממשקי API אלה: CreateUser
, SetUser
, DelUser
, וגם GetUser
.
דוגמה לבקשת API ותגובה
CreateUser API בקשה ותגובה
API request:
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service http://www.webex.com/schemas/2002/06/service/service.xsd">
<header>
<securityContext>
<siteName>{siteName}</siteName>
<webExID>{site Admin account}</webExID>
<email>{site Admin account}</email>
<sessionTicket>xxxx</sessionTicket> or <password> or <webExAccessToken>
or <accessToken>, when using CI "accessToken", it must include scope webexsquare:admin when provisioning
user
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.CreateUser">
<webExId>Jack@qa.webex.com</webExId> --- it should is user identity of email address
<email>Jack@qa.webex.com</email>
<firstName>Jack</firstName>
<lastName>Smith</lastName>
<password>....</password>
<privilege>
<host>true</host>
</privilege>
<active>ACTIVATED</active> ---this parameter can't active the user directly until the user self activate itself via activation
email.
</bodyContent>
</body>
</serv:message>
API response example:
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common"
xmlns:use="http://www.webex.com/schemas/2002/06/service/user">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="use:createUserResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<use:userId>23778617</use:userId>
</serv:bodyContent>
</serv:body>
</serv:message>
ממשקי API של השפעה:
CreateUser
SetUser
DelUser
XML API תומך בתאימות קדימה של אימות משתמש קיים לאחר שהאתר הקלאסי של Webex מומר לאתר מנוהל של Control Hub
ממשקי API מושפעים
לאחר שהאתר הקלאסי של Webex מומר לאתר מנוהל של Control Hub, הערך של <webExID> רכיב ב- <securityContext> צריך להיות זהה לדואר אלקטרוני, פרטים להלן:
עבור משתמשים קיימים שנוצרו באתר הקלאסי של Webex, אנו תומכים בשני webExID ישנים (לדוגמה: Jack) ו- webExID חדש (התוכן זהה לדואר אלקטרוני, לדוגמה: Jack@xx.com) כדי להתחבר, תאימות לאחור של אימות זה מיועדת לכל ממשקי ה- API של XML.
עבור משתמשים חדשים שנוצרו באתרים מנוהלים של Control Hub, הערך של רכיב webExID חייב להיות זהה לדואר אלקטרוני לצורך כניסה.
<header>
<securityContext>
<siteName>{siteName}</siteName>
<webExID>{userName}</webExID> --- existing users were created in webEx classic site, it can be: jack or jack@xx.com;
new user must use jack@xx.com
<sessionTicket>xxxx</sessionTicket> or <password> or <webExAccessToken> or <accessToken>
</securityContext>
</header>
ממשקי API של השפעה:
כל ממשקי ה- API של XML.
לאחר שהאתר הקלאסי של Webex הומר לאתר מנוהל של Control Hub, הערך של <webExID> גוף הרכיבקוונט> צריך להיות זהה לדואר אלקטרוני, פרטים להלן:
עבור משתמשים קיימים שנוצרו באתר הקלאסי של Webex, אנו תומכים בשני webExId הישנים (למשל: Jack) ו- webExId חדש (התוכן זהה לדואר אלקטרוני, לדוגמה: Jack@xx.com) בגוףקוונט .
עבור משתמשים חדשים שנוצרו באתרים מנוהלים של Control Hub, הערך של רכיב webExId חייב להיות זהה לדואר אלקטרוני ב-
bodyContent
.
<bodyContent xsi:type="java:com.webex.service.binding.user.GetUser or SetUser or DelUser">
<webExId>xxxx</webExId> --- existing users were created in webEx classic site, it can be: jack or jack@xx.com; new user
must use jack@xx.com
</bodyContent>
ממשקי API של השפעה:GetUser
, SetUser
, וגם DelUser
.
שינויים בסכימה
אין שינויים בסכימה בממשקי API כלשהם.
דוגמה לבקשת API ותגובה
GetUser API בקשה ותגובה
API request:
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service http://www.webex.com/schemas/2002/06/service/service.xsd">
<header>
<securityContext>
<siteName>{siteName}</siteName>
<webExID>{userName}</webExID> --- existing users were created in webEx classic site, it can be: jack or jack@xx.com;
new user must use jack@xx.com
<sessionTicket>xxxx</sessionTicket> or <password> or <webExAccessToken> or <accessToken>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.user.GetUser or SetUser or DelUser">
<webExId>xxxx</webExId> --- existing users were created in webEx classic site, it can be: jack or jack@xx.com; new user
must use jack@xx.com
</bodyContent>
</body>
</serv:message>
API response example:
...same as before
שיפור היסטוריית התצוגה של היסטוריית הצפייה ב- API לתמיכה בפגישות Webex, אירועי Webex (חדש) ואירועי Webex (קלאסי)
ממשקי API מושפעים
API נוכחי: lstrecordaccessHistory
ו- lstrecordaccessDetailHistory
תומך רק בדוח ההיסטוריה של תצוגת ההקלטה של הדרכות Webex. השיפור החדש תומך גם בפגישות Webex, באירועי Webex (חדשים) ובתצוגת הקלטה (קלאסית) של Webex Events (קלאסית).
שינויים בסכימה
אנו תומכים להלן בסכימה חדשה לתוך API lstrecordaccessHistory בגוף בקשת API:
<serviceTypes>
<serviceType>MeetingCenter</serviceType>
<serviceType>TrainingCenter</serviceType>
<serviceType>EventCenter</serviceType>
</serviceTypes>
פרטים
ה-API: lstrecordaccessHistory
הוא מסוגל להחזיר את היסטוריית הגישה לתצוגת הקלטה עבור פגישות Webex, אירועי Webex (חדש), אירועי Webex (קלאסי) והדרכות Webex.
אם אין serviceType שצוין בבקשת API, ה- API של
lstrecordaccessHistory
מחזירה את היסטוריית ההקלטה של Webex Trainings עם גישה בלבד.כאשר סוג השירות הוא MeetingCenter, ה- API של
lstrecordaccessHistory
מחזיר הן את פגישות Webex והן את היסטוריית ההקלטה של תצוגת ההקלטה של Webex Events (חדשה).כאשר סוג השירות הוא EventCenter, ה- API של
lstrecordaccessHistory
מחזירה היסטוריית הקלטה של Webex Events (קלאסית) עם גישה.
ה-API: lstrecordaccessDetailHistory
מסוגל להחזיר פרטים על-ידי recordID
של פגישות Webex, אירועי Webex (חדש), אירועי Webex (קלאסי) והדרכות Webex.
דוגמה לבקשת API ותגובה
lstrecordaccessHistory
הבקשה והתגובה של API
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<header>
<securityContext>
<webExID>{userName}</webExID>
<password>{password}</password>
<siteName>{siteName}</siteName>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.history.LstrecordaccessHistory">
<viewTimeScope>
<viewTimeStart>9/20/2021 00:00:00</viewTimeStart>
<viewTimeEnd>9/28/2021 23:59:59</viewTimeEnd>
</viewTimeScope>
<listControl>
<startFrom>1</startFrom>
<maximumNum>100</maximumNum>
</listControl>
<order>
<orderBy>RECORDID</orderBy>
<orderAD>ASC</orderAD>
</order>
<serviceTypes>
<serviceType>MeetingCenter</serviceType>
<serviceType>TrainingCenter</serviceType>
<serviceType>EventCenter</serviceType>
</serviceTypes>
</bodyContent>
</body>
</serv:message>
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common"
xmlns:history="http://www.webex.com/schemas/2002/06/service/history">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="history:lstrecordaccessHistoryResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory test TC-20210924 1324-1</history:recordName>
<history:creationTime>09/24/2021 13:28:13</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>2</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>TestErollment_001-20210610 1905-1</history:recordName>
<history:creationTime>06/10/2021 19:10:15</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>0</history:downloaded>
<history:viewed>3</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>Test instant playback 2-20210705 0709-1</history:recordName>
<history:creationTime>07/05/2021 07:15:06</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>0</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>EC2.0_232423-20210922 0447-1</history:recordName>
<history:creationTime>09/22/2021 04:53:05</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>0</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory test EC2.0-20210924 1315-1</history:recordName>
<history:creationTime>09/24/2021 13:19:00</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>1</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory test MC-20210924 1319-1</history:recordName>
<history:creationTime>09/24/2021 13:25:12</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>1</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:recordAccessHistory>
<history:recordID>1XXXXXXX7</history:recordID>
<history:recordName>LstrecordaccessHistory test EC classic-20210924 1331-1</history:recordName>
<history:creationTime>09/24/2021 13:37:28</history:creationTime>
<history:registered>0</history:registered>
<history:downloaded>1</history:downloaded>
<history:viewed>1</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordAccessHistory>
<history:matchingRecords>
<serv:total>8</serv:total>
<serv:returned>7</serv:returned>
<serv:startFrom>1</serv:startFrom>
</history:matchingRecords>
</serv:bodyContent>
</serv:body>
</serv:message>
lstrecordaccessDetailHistory
הבקשה והתגובה של API
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:serv="http://www.webex.com/schemas/2002/06/service">
<header>
<securityContext>
<webExID>{userName}</webExID>
<password>{password}</password>
<siteName>{siteName}</siteName>
</securityContext>
</header>
<body>
<bodyContent xsi:type=
"java:com.webex.service.binding.history.LstrecordaccessDetailHistory">
<recondID>1XXXXXX7</recondID>
<timeZoneID>20</timeZoneID>
</bodyContent>
</body>
</serv:message>
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common"
xmlns:history="http://www.webex.com/schemas/2002/06/service/history">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="history:lstrecordaccessDetailHistoryResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<history:recordDetail>
<history:viewID>1XXXXXX7</history:viewID>
<history:participantName>Axxxg</history:participantName>
<history:participantEmail>Axxxg@qa.webex.com</history:participantEmail>
<history:accessTime>09/24/2021 13:27:26</history:accessTime>
<history:registered>false</history:registered>
<history:downloaded>false</history:downloaded>
<history:viewed>true</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordDetail>
<history:recordDetail>
<history:viewID>1XXXXXX7</history:viewID>
<history:participantName>Axxxg</history:participantName>
<history:participantEmail>Axxxg@qa.webex.com</history:participantEmail>
<history:accessTime>09/24/2021 13:27:39</history:accessTime>
<history:registered>false</history:registered>
<history:downloaded>true</history:downloaded>
<history:viewed>false</history:viewed>
<history:timeZoneID>20</history:timeZoneID>
</history:recordDetail>
<history:matchingRecords>
<serv:total>2</serv:total>
<serv:returned>2</serv:returned>
<serv:startFrom>1</serv:startFrom>
</history:matchingRecords>
</serv:bodyContent>
</serv:body>
</serv:message>
ממשקי API של השפעה:
lstrecordaccessHistory
lstrecordaccessDetailHistory
תקן את הפער של אורך התיאור המרבי המותר של אירועי Webex (קלאסי) בין XMLAPI לדף Webex.
ממשקי API מושפעים
ה-API של XML: רכיב התיאור של CreateEvent ו - SetEvent יאפשר כניסות של 10000 תווים לכל היותר, אם הזנת גודל יתר, התוצאה תהיה קוד השגיאה וההודעה החדשים:
060068 תיאור קלט לא חוקי. תיאור זה אינו יכול לחרוג מ- 10000 תווים.
שינויים בסכימה
אין שינוי סכימה.
דוגמה לבקשת API ותגובה
יצירת בקשה ותגובה של API של CreateEvent
#API request example:
...
<body>
<bodyContent xsi:type="java:com.webex.service.binding.event.CreateEvent"
xmlns:att="http://www.webex.com/schemas/2002/06/service/event" xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service/event
http://www.webex.com/schemas/2002/06/service/event/event.xsd">
<accessControl>
<sessionPassword>111111</sessionPassword>
<listing>PRIVATE</listing>
</accessControl>
<metaData>
<sessionName>EC test</sessionName>
<description>.......Suppose you filling in 10000 characters in description.......</description>
</metaData>
...
------------------------------------
#API response example when the description exceeds 10000 characters:
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common"
xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>FAILURE</serv:result>
<serv:reason>Illegal input description. The description can't exceed 10000 characters</serv:reason>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
<serv:exceptionID>060068</serv:exceptionID>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent/>
</serv:body>
</serv:message>
ממשקי API של השפעה:
CreateEvent
SetEvent
XML API: GetUser מחזיר אלמנט חדש של freeAccount
ממשקי API מושפעים
GetUser
החזרת רכיב חדש המזהה freeAccount
חשבון המשתמש הוא FreeAccount
או שלא.
שינויים בסכימה
דוגמה לתגובת GetUser
GetUser response:
<use:initials>AW</use:initials>
<use:isUploaded>false</use:isUploaded>
</use:avatar>
<use:largeEventCapacity>3</use:largeEventCapacity>
<use:freeAccount>false</use:freeAccount>
</serv:bodyContent>
</serv:body>
</serv:message>
ממשקי API של השפעה:
GetUser
API 41.10.0 עדכונים
אין שינויי סכימה בסכימת XML API 41.10.0. |
API 41.9.0 עדכונים
XML API 41.9.0 עדכונים
הוצאה משימוש של XML API 10.0.0 עבור כל אתרי T31
Webex מתכננת לתמוך בסוף החיים ב- XML API ver 10.0.0 עבור כל אתרי T31.
אנו מוציאים משימוש את קוד XML API 10.0.0 מכל ההפקות בעדכון 41.9.0.
API 41.8.0 עדכונים
עדכוני XML API 41.8.0
לחץ כאן כדי להוריד את סכימתXML API 41.8.0.
הוצאה משימוש של XML API 10.0.0 עבור כל אתרי T31
Webex מתכננת לתמוך בסוף החיים ב- XML API ver 10.0.0 עבור כל אתרי T31.
Webex מצאה חלק מהלקוחות שניגשים לכתובת ה-URL של XML API באמצעות דרך שגויה כגון: https://{siteName}.webex.com/WBXService/xml10.0.0/XMLService, הדרך הנכונה לגשת לכתובת URL של XML API כ: https://{siteName}.webex.com/WBXService/XMLService.
אנא החלף את ה- API של גישת הקוד שלך ל- XML באמצעות הדרך הנכונה כדי למנוע השפעה לפני שנסיים את התמיכה בסוף החיים ב- XML API גירסה 10.0.0.
API 41.7.0 עדכונים
עדכוני XML API 41.7.0
לחץ כאן כדי להוריד את סכימתXML API 41.7.0.
מחיקה ניידת והקלטת עריכה צריכות להיות נשלטות על ידי אפשרות ניהול האתר: אפשר למארחים להקצות מחדש, לערוך, להשבית ולמחוק הקלטות
ממשקי API מושפעים ושינויי סכימה
GetSite
יחזירו רכיבים חדשים מתן שמות לרכיבים: enableNBRMCModify
, וגם separateNoRecordingEdit
תחת כלים.
דוגמה לתגובה
GetSiteResponse
:
GetSite
<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common"
xmlns:ns1="http://www.webex.com/schemas/2002/06/service/site" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="ns1:getSiteResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
....
<ns1:tools>
...
<ns1:enableNBRMCModify>false</ns1:enableNBRMCModify>
<ns1:separateNoRecordingEdit>true</ns1:separateNoRecordingEdit>
...
</ns1:tools>
</serv:bodyContent>
</serv:body>
</serv:message>
API 41.6.3 עדכונים
XML API 41.6.3 עדכונים
לחץ כאן כדי להוריד את סכימתXML API 41.6.3.
GetSite
תגובה אלמנט חדש של supportLargeEvent
ממשקי API מושפעים ושינויי סכימה
GetSite: החזרת שמות של רכיבים חדשים supportLargeEvent
תחת siteCommonOptions
כדי ליידע את המתקשר אם האתר תומך באירוע גדול (אירוע Webex (חדש)) או לא.
שינוי סכימה
דוגמה לתגובה
GetSiteResponse
:
GetSite
<?xml version="1.0" encoding="ISO-8859-1"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common"
xmlns:ns1="http://www.webex.com/schemas/2002/06/service/site" xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="ns1:getSiteResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
....
<ns1:siteCommonOptions>
...
<ns1:enablePreMeetingLobby>false</ns1:enablePreMeetingLobby>
<ns1:supportLargeEvent>true</ns1:supportLargeEvent>
</ns1:siteCommonOptions>
</serv:bodyContent>
</serv:body>
</serv:message>
API 41.6.0 עדכונים
עדכוני XML API 41.6.0
לחץ כאן כדי להוריד את סכימתXML API 41.6.0.
XMLAPI תומך Webex אירועים 2.0 בהקצאה
ממשקי API מושפעים
GetUser
החזרת מתן שמות לרכיבים חדשים: largeEventCapacity
המציג את הקיבולת של אירוע חדש 2.0 (EC 2.0) תחת חשבון משתמש זה. לדוגמה, אם לחשבון המשתמש יש רישיון CI_EC3K, הערך של largeEventCapacity
הוא 3000.
שינויים בסכימה
דוגמה לתגובה
GetUserResponse:
זמן ההקלטה של XMLAPI LstRecording מחיל את שעת ההתחלה של ההקלטה
ממשקי API מושפעים
LstRecording
: LstRecording
תגובה CreateTime
כזמן שבו המשתמש למעשה לוחץ על כפתור ההקלטה.
פרטים
בעבר, XML API השתמש בחותמת זמן של מתי ההקלטה נוצרה במסד הנתונים כזמן היצירה ב- LstRecording
תגובה. עכשיו זה הזמן שהמשתמש באמת מתחיל לבצע את ההקלטה. שינוי זה חל על כל הקלטות השירות. אין שינוי סכימה.
עדכוני API 41.5.0
עדכוני XML API 41.5.0
לחץ כאן כדי להוריד את סכימתXML API 41.5.0.
ל- XMLAPI יש יכולת להפעיל פגישות מתוזמנות של Webex מ- PSTN כמארח
ממשקי API מושפעים
CreateUser
יוצר:hostPIN
ללא קשר PMR למשתמש מופעל או לא כאשר תפקיד המשתמש הוא מארח או מנהלי אתר מלאים או לקריאה בלבד או ניהול משתמשים בלבד.SetUser
סטים:hostPIN
באמצעותphones.hostPIN
מתיpersonalMeetingRoom.hostPIN
אינו נמצא בבקשת XML (תנאי מקדים: מתג תכונותAllowStartScheduledMtgFromPhone
מופעל).GetUser
החזרות:phones.hostPIN
ללא קשר ל- PMR של המשתמש מופעל או לא. מתג תכונותAllowStartScheduledMtgFromPhone
מופעל).
שינויים בסכימה
GetUserResponse
:
SetUser
:
דוגמה לתגובה
GetUserResponse
:
SetUser
:
XMLAPI GetSite
תגובה שני אלמנטים חדשים עבור לקוח נייד
ממשקי API מושפעים
GetSite
:GetSite
יגיב כעת שני אלמנטים חדשים לתמיכה בלקוח נייד יש את ההיגיון להציג או לא להציג את כרטיסיית ההקלטה.enableRecordingAccess
true או false, מנהלי-על של Webex יכולים להפעיל או להשבית את הגישה להקלטה על-ידי הלחצן הדו-מצבי (:EnableRecordingAccesses
).storageEmptyStatus
true או false, אם שני האתרים אינם תומכים בפונקציית NBR ומקצים את שטח האחסון של NBR כאפס, אז תגובת המצב נכונה, אחרת היא שקרית.:
שינויים בסכימה
בקשה לדוגמה עבור GetSite
תגובה לדוגמה עבור Getsite
נושא דוא"ל הכולל תווים שאינם ASCII יקודד באמצעות RFC2047. במקרה של נושא דואר אלקטרוני טהור של תו ASCII, אין קידוד
ממשקי API מושפעיםאין השפעות על כל בקשת API, מטען תגובות, אבל זה משנה את התנהגות הקידוד של נושא הדואר האלקטרוני. כאשר נושא הדואר האלקטרוני הכולל תווים שאינם ASCII יקודד באמצעות RFC2047. במקרה של נושא דוא"ל טהור של תו ASCII, אין קידוד.
שינויים בסכימה
אין שינויים בסכימה.
עדכוני API 41.4.0
עדכוני XML API 41.4.0
לחץ כאן כדי להוריד את סכימתXML API 41.4.0.
יצירת אירועי Webex מתוזמנים של אירועים יכולים למנף את ברירת המחדל ברמת האתר בטון הכניסה והיציאה
XMLAPI מיישר קו עם הלוגיקה החדשה הנוכחית לשליטה בטון הכניסה והיציאה. כל הצלילים עבור אירועי Webex נשלטו על ידי הגדרה שונה בניהול האתר. ב- GetSite
XMLAPI מחזיר שדה נוסף, entryExitToneEC
כדי לציין את הערך. במקור, כאשר מנהל האתר הגדיר ברירת מחדל לטון, יצירת אירוע לא תמנף הגדרה זו על-ידי החלת ברירת המחדל של XMLAPI.
ממשקי API מושפעים
ה-API של XML: GetSite מחזירה רכיב חדש אחד entryExitToneEC
כדי לציין את הערך.
ה-API של XML: CreateEvent, SetEvent, GetEvent, GetEvent לוגיקה עסקית בקצה האחורי קוראת את הערך של entryExitToneEC
.
שינויים בסכימה
XML API: דוגמת תגובה של GetSite:
<ns1:defaults>
<ns1:emailReminders>true</ns1:emailReminders>
<ns1:entryExitTone>ANNOUNCENAME</ns1:entryExitTone>
<ns1:entryExitToneEC>NOTONE</ns1:entryExitToneEC>
<ns1:voip>true</ns1:voip>
<ns1:teleconference>
<ns1:telephonySupport>NONE</ns1:telephonySupport>
</ns1:teleconference>
<ns1:joinTeleconfNotPress1>true</ns1:joinTeleconfNotPress1>
<ns1:updateTSPAccount>false</ns1:updateTSPAccount>
</ns1:defaults>
ממשקי API של השפעה:
GetSite
CreateEvent
SetEvent
GetEvent
XMLAPI פשוט מחזיר את פרטי האירוע הגדול (Webex Event 2.0)
אם פגישת Webex היא האירוע או שידור האינטרנט הגדולים,
GetSessionInfo
החזרת מידע מפורט כלשהו, כולל סיסמת פגישה, סיסמה מספרית לפגישה, סיסמת פאנליסט וסיסמה מספרית של פאנליסט (אין לשנות סכימה).XMLAPI אינו תומך ביצירה ועריכה של כל תכונת אירוע או שידור אינטרנט גדול, ולכן
CreateMeeting
ו-SetMeeting
החזר חריג חדש (110064, סוג ההפעלה של האירוע ושידור האינטרנט אינם נתמכים.) עבור אירוע גדול או אירוע שידור אינטרנט.
ממשקי API של השפעה
שם API |
תיאור |
הערה |
---|---|---|
|
אם פגישת Webex היא האירוע או שידור האינטרנט הגדולים, |
אין לשנות סכימה. |
|
אם המשתמש מנסה להשתמש |
ההתנהגות תשתנה. |
API 41.3.0 עדכונים
XML API 41.3.0 עדכונים
לחץ כאן כדי להוריד את סכימתXML API 41.3.0.
השינויים החדשים של XML API תומכים בתכונה Webex Events 2.0
ממשקי API מושפעים
שני ממשקי ה-API: GetSessionInfo ו- GetMeeting רכיבי החזרה enableEvent
ו- enableWebniar
גם.
שם הרכיב |
תיאור |
---|---|
enableEvent |
תומך ב- EC 2.0 בפגישת Webex |
enableWebniar |
תומך בסמינר מקוון בפגישת Webex |
תמיכת XMLAPI חוזרת מעל שני רכיבים עבור EC 2.0. המהדורה הנוכחית של XML API אינה תומכת בתזמון והגדרת פגישת EC2.0. |
שינויים בסכימה
GetSessionInfo
החזרת רכיבים enableEvent
ו- enableWebniar
עבור EC 2.0.
GetMeeting
החזרת רכיבים enableEvent
ו- enableWebniar
עבור EC 2.0.
דוגמה לתגובה:
GetSessionInfo
תגובה:
<ep:accessControl>
<ep:listStatus>PUBLIC</ep:listStatus>
<ep:registration>false</ep:registration>
<ep:passwordReq>true</ep:passwordReq>
<ep:isEnforceAudioPassword>false</ep:isEnforceAudioPassword>
<ep:isEnforceAudioLogin>false</ep:isEnforceAudioLogin>
<ep:enableEvent>false</ep:enableEvent>
<ep:enableWebniar>false</ep:enableWebniar>
<ep:enablePreMeetingLobby>true</ep:enablePreMeetingLobby>
</ep:accessControl>
GetMeeting
תגובה:
<meet:supportPKI>false</meet:supportPKI>
<meet:HQvideo>true</meet:HQvideo>
<meet:HDvideo>true</meet:HDvideo>
<meet:viewVideoThumbs>true</meet:viewVideoThumbs>
<meet:enableEvent>false</meet:enableEvent>
<meet:enableWebniar>false</meet:enableWebniar>
<meet:enablePreMeetingLobby>true</meet:enablePreMeetingLobby>
</meet:enableOptions>
השינויים החדשים של XMLAPI תומכים בתכונת הלובי לפני הפגישה
ממשקי API מושפעים
ה-API של XML: GetSite
, LstSummarySession
, GetSessionInfo
, וגם GetMeeting
יגיב לאלמנט החדש enablePreMeetingLobby
ללובי לפני הפגישה.
שינויים בסכימה
ה-API של XML: GetSite
מחזיר רכיב enablePreMeetingLobby
ללובי לפני הפגישה.
ה-API של XML: LstSummarySession
מחזיר רכיב enablePreMeetingLobby
ללובי לפני הפגישה.
ה-API של XML: GetSessionInfo
מחזיר רכיב enablePreMeetingLobby
ללובי לפני הפגישה.
ה-API של XML: GetMeeting
מחזיר רכיב enablePreMeetingLobby
ללובי לפני הפגישה.
דוגמה לתגובה:
GetSite
תגובה:
<ns1:siteCommonOptions>
<ns1:SupportCustomDialRestriction>false</ns1:SupportCustomDialRestriction>
<ns1:SupportTelePresence>false</ns1:SupportTelePresence>
<ns1:SupportTelePresencePlus>false</ns1:SupportTelePresencePlus>
<ns1:EnableCloudTelepresence>true</ns1:EnableCloudTelepresence>
<ns1:EnableCMRForAllUsers>true</ns1:EnableCMRForAllUsers>
<ns1:enablePersonalMeetingRoom>true</ns1:enablePersonalMeetingRoom>
<ns1:SupportAlternateHost>true</ns1:SupportAlternateHost>
<ns1:SupportXMLAPIReturnScheduledPMR>false</ns1:SupportXMLAPIReturnScheduledPMR>
<ns1:SupportAnyoneHostMeetings>true</ns1:SupportAnyoneHostMeetings>
<ns1:enablePreMeetingLobby>true</ns1:enablePreMeetingLobby>
</ns1:siteCommonOptions>
LstSummarySession
תגובה:
<ep:isException>false</ep:isException>
<ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>
<ep:seriesMeetingKey>0</ep:seriesMeetingKey>
<ep:isScheduledPMR>false</ep:isScheduledPMR>
<ep:enableEvent>false</ep:enableEvent>
<ep:enableWebniar>false</ep:enableWebniar>
<ep:enablePreMeetingLobby>true</ep:enablePreMeetingLobby>
</ep:session>
GetSessionInfo
תגובה:
<ep:accessControl>
<ep:listStatus>PUBLIC</ep:listStatus>
<ep:registration>false</ep:registration>
<ep:passwordReq>true</ep:passwordReq>
<ep:isEnforceAudioPassword>false</ep:isEnforceAudioPassword>
<ep:isEnforceAudioLogin>false</ep:isEnforceAudioLogin>
<ep:enableEvent>false</ep:enableEvent>
<ep:enableWebniar>false</ep:enableWebniar>
<ep:enablePreMeetingLobby>true</ep:enablePreMeetingLobby>
</ep:accessControl>
GetMeeting
תגובה:
<meet:supportPKI>false</meet:supportPKI>
<meet:HQvideo>true</meet:HQvideo>
<meet:HDvideo>true</meet:HDvideo>
<meet:viewVideoThumbs>true</meet:viewVideoThumbs>
<meet:enableEvent>false</meet:enableEvent>
<meet:enableWebniar>false</meet:enableWebniar>
<meet:enablePreMeetingLobby>true</meet:enablePreMeetingLobby>
</meet:enableOptions>
ה-API של XML GetSite
תגובה מידע שינוי התנהגות לחשוף
ממשקי API מושפעים
ה-API של XML: GetSite
רק תגובה מתחת לרכיבים עבור חשבון מנהל מערכת, הכוללים תפקידים: SiteAdmin
, RO_SiteAdmin
, וגם UserAdmin
.
<ns1:activeUserCount>...</ns1:activeUserCount>
<ns1:EEActiveUserCount>...</ns1:EEActiveUserCount>
<ns1:activeCETHost>...</ns1:activeCETHost>
<ns1:auoActiveUserCount>...</ns1:auoActiveUserCount>
<ns1:MCActiveUserCount>...</ns1:MCActiveUserCount>
<ns1:ECActiveUserCount>...</ns1:ECActiveUserCount>
<ns1:TCActiveUserCount>...</ns1:TCActiveUserCount>
<ns1:SCActiveUserCount>...</ns1:SCActiveUserCount>
ההתנהגות השתנתה
אפשר רק לתפקיד מנהל מערכת יש נתוני רשיון תגובה של GetSite
. מארח או משתתף לא יקבלו נתוני רשיון אלה ב GetSite
תגובה.
להלן API: GetSite's
דוגמה לתגובה עבור siteadmin
או מוכן בלבד siteadmin
או מנהל ניהול משתמשים:
API 41.2.0 עדכונים
עדכוני XML API 41.2.0
לחץ כאן כדי להוריד את סכימתXML API 41.2.0.
XMLAPI אמור לתמוך ב-"CMR Hybrid VOIP" אם האתר תומך בטלפוניה של Webex
ממשקי API מושפעים
GetSite
החזרת רכיב חדשIsWebexTelephony
בתגובה.CreateUser
ו-SetUser
יכול לעדכן אתcmrHybridVoip
רכיב אםIsWebexTelephony
נכון יחד עם תנאים אחרים.IsTSPUsingTelephonyAPI
היא כבר לא תוצאתית.
שינויים בסכימה
XML API: GetSite
תגובה מחזירה רכיב נוסף IsWebexTelephony
GetSite
התגובה כוללת רכיב חדש זה:
<ns1:telephonyConfig>
<ns1:isWebexTelephony>true</ns1:isWebexTelephony>
<ns1:isTSPUsingTelephonyAPI>false</ns1:isTSPUsingTelephonyAPI>
<ns1:serviceName>Personal Conference No.</ns1:serviceName>
<ns1:participantAccessCodeLabel>Attendee access code</ns1:participantAccessCodeLabel>
<ns1:subscriberAccessCodeLabel>Host access code</ns1:subscriberAccessCodeLabel>
<ns1:attendeeIDLabel>Attendee ID</ns1:attendeeIDLabel>
.....
</ns1:telephonyConfig>
LstSummarySession
תומך ב- EC2.0
ממשקי API של XML יושפעו
LstSummarySession
יחזיר שני רכיבים חדשים לתמיכה ב- EC 2.0
שם הרכיב |
תיאור |
---|---|
enableEvent |
תומך ב- EC 2.0 בפגישת Webex |
enableWebniar |
תומך בסמינר מקוון בפגישת Webex |
שינויים בסכימה
XML API: LstSummarySession
צרף את: < enableEvent
> ו enableWebniar
> אלמנטים
תגובה של XML API: LstSummarySession
תגובה עבור EC 2.0
<ep:isNextUpcomingInstance>true</ep:isNextUpcomingInstance>
<ep:seriesMeetingKey>0</ep:seriesMeetingKey>
<ep:isScheduledPMR>false</ep:isScheduledPMR>
<ep:enableEvent>true</ep:enableEvent>
<ep:enableWebniar>true</ep:enableWebniar>
</ep:session>
XMLAPI תומך בהחזרת משתמש האתר Webex-voice-assistant
אפשרות לשילוב MCT
API מושפע
GetUser
החזרת רכיב חדש webexAssistantEnabled
(נכון או לא נכון) בתגובה.
שינויים בסכימה
getUserResponse
:
דוגמה לתגובה
עדכוני API 41.1.0
אין שינויי סכימה בסכימת XML API 41.1. |