Modération — REST

Forcer un point de terminaison client à se déconnecter d'une session

Outre la gestion des terminaux clients connectés via le SDK OpenTok.js, les serveurs d'applications peuvent envoyer une requête HTTP DELETE depuis le serveur afin de forcer un client connecté à se déconnecter d'une session.

Votre serveur d'applications peut déconnecter un client d'une session OpenTok en envoyant une requête HTTP DELETE à la ressource correspondant à la connexion de ce client :

SESSION_ID=SOME_SESSION_ID CONNECTION_ID=SOME_CONNECTION_ID API_KEY=123456 API_SECRET=ABCDEF1234567890 curl -v \ -X DELETE \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID}

Pour plus d'informations, voir le Documentation de l'API REST OpenTok.

Forcer la mise en sourdine de l'audio publié lors d'une session de streaming

Vous pouvez utiliser le API REST d'OpenTok pour forcer un diffuseur d'un flux spécifique à couper le son de son contenu audio publié :

SESSION_ID=SOME_SESSION_ID STREAM_ID=SOME_STREAM_ID API_KEY=123456 API_SECRET=ABCDEF1234567890 JWT=jwt_token curl -v \ -X POST \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/stream/${STREAM_ID}/mute

Vous pouvez utiliser le API REST d'OpenTok pour forcer tous les flux (à l'exception d'une liste facultative de flux) d'une session à couper le son de l'audio publié :

SESSION_ID=SOME_SESSION_ID DATA='{"excludedStreamIds": ["excludedStreamId1", "excludedStreamId2"], "active": true}' API_KEY=123456 API_SECRET=ABCDEF1234567890 curl -v \ -H "Content-Type: application/json" \ -X POST \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/mute

Les données JSON comprennent les propriétés suivantes :

  • active (Booléen, obligatoire) — Indique s'il faut couper le son des flux audio de la session (true) et activer le mode « muet » de la session, ou désactiver le mode « muet » de la session (false). Lorsque la fonction « Muet » est activée (true), tous les flux actuels et futurs publiés dans la session (à l'exception des flux figurant dans le excludedStreamIds tableau) sont désactivés. Lorsque vous appelez cette méthode avec le active est définie comme étant la propriété false, les flux futurs publiés dans la session ne sont pas mis en sourdine (mais les flux déjà mis en sourdine le restent).

  • excludedStreamIds (Tableau de chaînes de caractères, facultatif) — Les identifiants des flux qui ne doivent pas être mis en sourdine. Il s'agit d'une propriété facultative. Si vous omettez cette propriété, tous les flux de la session seront mis en sourdine. Cette propriété ne s'applique que lorsque le active est fixée à true. Lorsque le active est fixée à false, elle est ignorée.

Pour désactiver le mode « muet » de la session (et empêcher que les flux futurs ne soient mis en mode « muet »), appelez à nouveau la méthode avec le active est définie comme étant la propriété false:

SESSION_ID=SOME_SESSION_ID DATA='{"active": false}' API_KEY=123456 API_SECRET=ABCDEF1234567890 curl -v \ -H "Content-Type: application/json" \ -X POST \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/mute