Moderação — REST

Forçar um endpoint do cliente a se desconectar de uma sessão

Além de gerenciar os terminais de clientes conectados a partir do SDK do OpenTok.js, os servidores de aplicativos podem emitir uma solicitação HTTP DELETE do lado do servidor para forçar um cliente conectado a se desconectar de uma sessão.

Seu servidor de aplicativos pode desconectar um cliente de uma sessão do OpenTok enviando uma solicitação HTTP DELETE ao recurso correspondente à conexão desse 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 obter mais informações, consulte o Documentação da API REST do OpenTok.

Forçar as transmissões em uma sessão a silenciar o áudio publicado

Você pode usar o API REST do OpenTok para forçar um emissor de uma transmissão específica a silenciar o áudio publicado:

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

Você pode usar o API REST do OpenTok para forçar todas as transmissões (exceto uma lista opcional de transmissões) em uma sessão a silenciar o áudio 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

Os dados JSON incluem as seguintes propriedades:

  • active (Booleano, obrigatório) — Se os streams da sessão devem ser silenciados (true) e ativar o modo mudo da sessão, ou desativar o modo mudo da sessão (false). Com o modo mudo ativado (true), todos os fluxos atuais e futuros publicados na sessão (com exceção dos fluxos no excludedStreamIds (matriz) são silenciados. Ao chamar esse método com o active propriedade definida como false, as transmissões futuras publicadas na sessão não serão silenciadas (mas as transmissões já silenciadas permanecerão assim).

  • excludedStreamIds (Matriz de strings, opcional) — Os IDs das transmissões que não devem ser silenciadas. Esta é uma propriedade opcional. Se você omitir essa propriedade, todas as transmissões da sessão serão silenciadas. Essa propriedade só se aplica quando o active a propriedade está definida como true. Quando o active a propriedade está definida como false, ele é ignorado.

Para desativar o estado de mudo da sessão (para impedir que transmissões futuras sejam silenciadas), chame o método novamente com o active propriedade definida como 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