分享螢幕畫面端點

分享螢幕畫面工作階段端點可存取分享螢幕畫面服務。

分享螢幕畫面工作階段端點

參數 必填 資料類型 定義
ext_session_id TRUE 字串 外部螢幕分享工作階段 ID

端點:

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

標題:

說明
Content-Type application/json

內文:

{}

要求和回應範例

下列各節提供端點的要求範例。

使用外部工作階段 ID 結束螢幕分享工作階段

本例示範如何結束目前的螢幕分享工作階段。

要求

您可以使用外部工作階段 ID 結束螢幕分享工作階段。

標題:

說明
Content-Type application/json

查詢:

參數 必填 資料類型 定義
ext_session_id TRUE 字串 外部螢幕分享工作階段 ID

要求網址:

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

更改下列內容:

  • SUBDOMAIN:CCAI 平台租戶名稱。

  • DOMAIN:執行個體的網域。

  • EXTERNAL_SESSION_ID:要結束的螢幕分享工作階段外部工作階段 ID。

回應:工作階段已終止
{
    "message": "Session terminated"
}

狀態碼:200