Signalisierung — REST

Verwenden Sie die OpenTok-Signalisierungs-API, um Text und Daten an Clients zu senden, die mit einer OpenTok-Sitzung verbunden sind.

Sobald Client-Endpunkte über die OpenTok-Client-SDKs mit einer Sitzung verbunden sind, können Entwickler Signale vom App-Server an die verbundenen Clients senden, anstatt diese zwischen den Client-Endpunkten auszutauschen. Im Gegensatz zu den Moderationsfunktionen des JS-SDK besteht die einzige Funktion der REST-API für die Moderation darin, die Möglichkeit zu bieten, eine Verbindung aus einer Sitzung zu entfernen.

Dieses Thema umfasst die folgenden Abschnitte:

Ein Signal an einen bestimmten Client in einer Sitzung senden

Sende einen HTTP-POST-Request an die signal Ressource einer bestimmten Verbindungs-ID, für einen mit der Sitzung verbundenen Client:

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

Ein Signal an alle Clients in einer Sitzung senden

Bei den beiden folgenden Signalbeispielen wird der Request-Body verwendet, um sowohl die type und data Felder. Diese entsprechen den Typ- und Datenparametern, die an die Handler für empfangene Client-Signale übergeben werden.

Sende einen HTTP-POST-Request an die signal Ressource der Sitzung:

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