Signalisation — REST

Utilisez l'API de signalisation OpenTok pour envoyer du texte et des données aux clients connectés à une session OpenTok.

Une fois que les terminaux clients sont connectés à une session à l'aide des SDK clients OpenTok, les développeurs peuvent choisir d'envoyer des signaux aux clients connectés depuis le serveur d'applications, plutôt qu'entre les terminaux clients. Contrairement aux fonctionnalités de modération du SDK JS, la seule fonction de l'API REST en matière de modération est d'offrir la possibilité de supprimer une connexion d'une session.

Cette rubrique comprend les sections suivantes :

Envoi d'un signal à un client spécifique au cours d'une session

Envoyez une requête HTTP POST à l'adresse signal ressource associée à un identifiant de connexion spécifique, pour un client connecté à la session :

SESSION_ID=SOMESESSIONID CONNECTION_ID=SOMECONNECTIONID API_KEY=123456 # Replace with a JSON web token -- # see /opentok/rest/#authentication: JWT=jwt_token DATA='{"type":"foo","data":"bar"}' curl -v \ -H "Content-Type: application/json" \ -X POST \ -H "X-OPENTOK-AUTH:${JWT}" \ -d "${DATA}" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID}/signal

Envoi d'un signal à tous les clients d'une session

Pour les deux exemples de signal ci-dessous, le corps de la requête sera utilisé pour transmettre à la fois le type et data champs. Ceux-ci correspondent au type et aux paramètres de données transmis aux gestionnaires de réception des signaux du client.

Envoyez une requête HTTP POST à l'adresse signal ressource de la session :

SESSION_ID=SOMESESSIONID API_KEY=123456 # Replace with a JSON web token -- # see /opentok/rest/#authentication: JWT=jwt_token DATA='{"type":"foo","data":"bar"}' curl -v \ -H "Content-Type: application/json" \ -X POST \ -H "X-OPENTOK-AUTH:${JWT}" \ -d "${DATA}" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/signal