Endpunkt für die Bildschirmfreigabe

Der Endpunkt für Bildschirmfreigabesitzungen bietet Zugriff auf den Bildschirmfreigabedienst.

Endpoint für Bildschirmfreigabesitzungen

Parameter Erforderlich Datentyp Definition
ext_session_id TRUE String Die externe ID der Bildschirmfreigabesitzung

Endpunkt:

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

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Text:

{}

Beispielanfrage und -antworten

In den folgenden Abschnitten finden Sie Beispielanfragen an den Endpunkt.

Bildschirmfreigabe mit einer externen Sitzungs-ID beenden

In diesem Beispiel wird gezeigt, wie Sie eine laufende Bildschirmfreigabesitzung beenden.

Anfrage

Sie können eine Bildschirmfreigabesitzung mit einer externen Sitzungs-ID beenden.

Überschriften:

Schlüssel Wert Beschreibung
Content-Type application/json

Suchanfrage

Parameter Erforderlich Datentyp Definition
ext_session_id TRUE String Die externe ID der Bildschirmfreigabesitzung

Abfrage-URL:

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

Ersetzen Sie Folgendes:

  • SUBDOMAIN: Der Name Ihres CCAI Platform-Mandanten.

  • DOMAIN: Die Domain für Ihre Instanz.

  • EXTERNAL_SESSION_ID: Die externe Sitzungs-ID für die Bildschirmfreigabesitzung, die Sie beenden möchten.

Antwort: Sitzung beendet
{
    "message": "Session terminated"
}

Statuscode:200