Endpoint di condivisione schermo

L'endpoint delle sessioni di condivisione schermo fornisce l'accesso al servizio di condivisione schermo.

Endpoint delle sessioni di condivisione schermo

Parametro Obbligatorio Tipo di dati Definizione
ext_session_id VERO Stringa ID sessione di condivisione schermo esterna

Endpoint:

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

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Corpo:

{}

Esempio di richiesta e risposte

Le sezioni seguenti forniscono richieste di esempio all'endpoint.

Terminare una sessione di condivisione schermo utilizzando un ID sessione esterno

Questo esempio mostra come terminare una sessione di condivisione schermo corrente.

Richiesta

Puoi terminare una sessione di condivisione schermo utilizzando un ID sessione esterno.

Intestazioni:

Chiave Valore Descrizione
Content-Type application/json

Query:

Parametro Obbligatorio Tipo di dati Definizione
ext_session_id VERO Stringa ID sessione di condivisione schermo esterna

Richiedi URL:

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

Sostituisci quanto segue:

  • SUBDOMAIN: il nome del tenant CCAI Platform.

  • DOMAIN: il dominio per l'istanza.

  • EXTERNAL_SESSION_ID: l'ID sessione esterno per la sessione di condivisione schermo che vuoi terminare.

Risposta: Sessione terminata
{
    "message": "Session terminated"
}

Codice di stato: 200