Moderación — REST

Forzar la desconexión de un punto final de cliente de una sesión

Además de gestionar los terminales de los clientes conectados desde el SDK de OpenTok.js, los servidores de aplicaciones pueden enviar una solicitud HTTP DELETE desde el lado del servidor para forzar a un cliente conectado a desconectarse de una sesión.

Tu servidor de aplicaciones puede desconectar a un cliente de una sesión de OpenTok enviando una solicitud HTTP DELETE al recurso correspondiente a la conexión de ese cliente:

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}

Para más información, consulte el Documentación de la API REST de OpenTok.

Forzar el silenciamiento del audio publicado en las transmisiones de una sesión

Puedes utilizar el API REST de OpenTok para obligar a un emisor de una transmisión concreta a silenciar el audio que está emitiendo:

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

Puedes utilizar el API REST de OpenTok para forzar que todas las transmisiones (excepto una lista opcional de transmisiones) de una sesión silencien el audio publicado:

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

Los datos JSON incluyen las siguientes propiedades:

  • active (Booleano, obligatorio) — Indica si se deben silenciar las transmisiones de la sesión (true) y activar el modo de silencio de la sesión, o desactivar el modo de silencio de la sesión (false). Con la función de silencio activada (true), todas las transmisiones actuales y futuras publicadas en la sesión (a excepción de las transmisiones de la excludedStreamIds matriz) se silencian. Cuando se invoca este método con el active con el valor false, las transmisiones futuras que se publiquen en la sesión no se silenciarán (pero las transmisiones que ya estén silenciadas seguirán siendosilenciadas).

  • excludedStreamIds (Matriz de cadenas, opcional) — Los identificadores de las transmisiones que no deben silenciarse. Se trata de una propiedad opcional. Si se omite esta propiedad, todas las transmisiones de la sesión se silenciarán. Esta propiedad solo se aplica cuando el active se establece en true. Cuando el active se establece en false, se ignora.

Para desactivar el estado de silencio de la sesión (y evitar que se silencien las transmisiones futuras), vuelve a llamar al método con el active con el valor 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