Screen Share エンドポイント

画面共有セッション エンドポイントは、画面共有サービスへのアクセスを提供します。

画面共有セッションのエンドポイント

パラメータ	必須	データ型	定義
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

リクエスト URL:

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

次のように置き換えます。

• SUBDOMAIN: CCAI プラットフォームのテナント名。

• DOMAIN: インスタンスのドメイン。

• EXTERNAL_SESSION_ID: 終了する画面共有セッションの外部セッション ID。

レスポンス: セッションが終了しました

{
    "message": "Session terminated"
}

ステータス コード: 200