Le point de terminaison des sessions de partage d'écran permet d'accéder au service de partage d'écran.
Point de terminaison des sessions de partage d'écran
| Paramètre | Obligatoire | Type de données | Définition |
|---|---|---|---|
| ext_session_id | TRUE | Chaîne | ID de la session de partage d'écran externe |
Point de terminaison :
Method: POST
Type: RAW
URL: https://{{subdomain}}.{{domain}}/apps/api/v1/cobrowse_sessions/
En-têtes
| Clé | Valeur | Description |
|---|---|---|
| Content-Type | application/json |
Corps :
{}
Exemple de requête et de réponses
Les sections suivantes fournissent des exemples de requêtes au point de terminaison.
Mettre fin à une session de partage d'écran à l'aide d'un ID de session externe
Cet exemple montre comment mettre fin à une session de partage d'écran en cours.
Requête
Vous pouvez mettre fin à une session de partage d'écran à l'aide d'un ID de session externe.
En-têtes
| Clé | Valeur | Description |
|---|---|---|
| Content-Type | application/json |
Requête
| Paramètre | Obligatoire | Type de données | Définition |
|---|---|---|---|
| ext_session_id | TRUE | Chaîne | ID de la session de partage d'écran externe |
URL de la requête :
POST https://SUBDOMAIN.DOMAIN/apps/api/v1/cobrowse_sessions/EXTERNAL_SESSION_ID/end
Remplacez les éléments suivants :
SUBDOMAIN: nom de votre locataire CCAI Platform.DOMAIN: domaine de votre instance.EXTERNAL_SESSION_ID: ID de session externe pour la session de partage d'écran que vous souhaitez terminer.
Réponse : Session terminée
{
"message": "Session terminated"
}
Code d'état : 200