נקודת קצה של שיתוף מסך

נקודת הקצה של סשנים של שיתוף מסך מספקת גישה לשירות שיתוף המסך.

נקודת קצה של סשנים של שיתוף מסך

פרמטר	חובה	סוג הנתונים	הגדרה
ext_session_id	TRUE	String	מזהה חיצוני של סשן שיתוף המסך

נקודת קצה (endpoint):

Method: POST
Type: RAW
URL: https://{​{subdomain}​}.{​{domain}​}/apps/api/v1/cobrowse_sessions/

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json

Body:

{}

דוגמה לבקשה ולתשובות

בקטעים הבאים מופיעות דוגמאות לבקשות לנקודת הקצה.

סיום סשן של שיתוף מסך באמצעות מזהה סשן חיצוני

בדוגמה הזו מוסבר איך לסיים סשן שיתוף מסך פעיל.

בקשה

אפשר לסיים שיתוף מסך באמצעות מזהה סשן חיצוני.

כותרות:

מפתח	ערך	תיאור
סוג התוכן	application/json

שאילתה:

פרמטר	חובה	סוג הנתונים	הגדרה
ext_session_id	TRUE	String	מזהה חיצוני של סשן שיתוף המסך

כתובת URL של הבקשה:

POST https://SUBDOMAIN.DOMAIN/apps/api/v1/cobrowse_sessions/EXTERNAL_SESSION_ID/end

מחליפים את מה שכתוב בשדות הבאים:

• ‫SUBDOMAIN: שם הדייר שלכם ב-CCAI Platform.

• ‫DOMAIN: הדומיין של המופע.

• ‫EXTERNAL_SESSION_ID: מזהה הסשן החיצוני של הסשן של שיתוף המסך שרוצים לסיים.

תשובה: הסשן הסתיים

{
    "message": "Session terminated"
}

קוד הסטטוס: 200