Delen via

REST API voor azure SignalR Service-gegevensvlak - v1

  • Artikel

Dit artikel bevat de V1-versie REST API's voor het gegevensvlak azure SignalR Service.

Beschikbare API's

API Pad
Een bericht uitzenden naar alle clients die zijn verbonden met de doelhub. POST /api/v1/hubs/{hub}
Een bericht uitzenden naar alle clients behoort tot de doelgebruiker. POST /api/v1/hubs/{hub}/users/{id}
Verzend een bericht naar de specifieke verbinding. POST /api/v1/hubs/{hub}/connections/{connectionId}
Controleer of de verbinding met de opgegeven connectionId bestaat GET /api/v1/hubs/{hub}/connections/{connectionId}
Sluit de clientverbinding DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Een bericht uitzenden naar alle clients binnen de doelgroep. POST /api/v1/hubs/{hub}/groups/{group}
Controleer of er clientverbindingen in de opgegeven groep zijn GET /api/v1/hubs/{hub}/groups/{group}
Controleer of er clientverbindingen zijn verbonden voor de opgegeven gebruiker GET /api/v1/hubs/{hub}/users/{user}
Voeg een verbinding toe aan de doelgroep. PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Verwijder een verbinding uit de doelgroep. DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Controleer of een gebruiker in de doelgroep bestaat. GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Voeg een gebruiker toe aan de doelgroep. PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Verwijder een gebruiker uit de doelgroep. DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Een gebruiker uit alle groepen verwijderen. DELETE /api/v1/hubs/{hub}/users/{user}/groups

Een bericht uitzenden naar alle clients die zijn verbonden met de doelhub.

POST /api/v1/hubs/{hub}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Ja tekenreeks
Uitgesloten query Uitgesloten verbindings-id's Nee [ tekenreeks ]
Antwoorden
Code Omschrijving
202 Geslaagd
400 Onjuiste aanvraag

Een bericht uitzenden naar alle clients behoort tot de doelgebruiker.

POST /api/v1/hubs/{hub}/users/{id}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Ja tekenreeks
id path De gebruikers-id. Ja tekenreeks
Antwoorden
Code Omschrijving
202 Geslaagd
400 Onjuiste aanvraag

Verzend een bericht naar de specifieke verbinding.

POST /api/v1/hubs/{hub}/connections/{connectionId}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Ja tekenreeks
connectionId path De verbindings-id. Ja tekenreeks
Antwoorden
Code Omschrijving
202 Geslaagd
400 Onjuiste aanvraag

Controleer of de verbinding met de opgegeven connectionId bestaat

GET /api/v1/hubs/{hub}/connections/{connectionId}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Ja tekenreeks
connectionId path Ja tekenreeks
Antwoorden
Code Omschrijving
200 Voltooid
400 Onjuiste aanvraag
404 Niet gevonden

Sluit de clientverbinding

DELETE /api/v1/hubs/{hub}/connections/{connectionId}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Ja tekenreeks
connectionId path Ja tekenreeks
reason query Nee tekenreeks
Antwoorden
Code Omschrijving
202 Geslaagd
400 Onjuiste aanvraag

Een bericht uitzenden naar alle clients binnen de doelgroep.

POST /api/v1/hubs/{hub}/groups/{group}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Ja tekenreeks
groeperen path De naam van de doelgroep, waarvan de lengte groter moet zijn dan 0 en kleiner dan 1025. Ja tekenreeks
Uitgesloten query Uitgesloten verbindings-id's Nee [ tekenreeks ]
Antwoorden
Code Omschrijving
202 Geslaagd
400 Onjuiste aanvraag

Controleer of er clientverbindingen in de opgegeven groep zijn

GET /api/v1/hubs/{hub}/groups/{group}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Ja tekenreeks
groeperen path Ja tekenreeks
Antwoorden
Code Omschrijving
200 Voltooid
400 Onjuiste aanvraag
404 Niet gevonden

Controleer of er clientverbindingen zijn verbonden voor de opgegeven gebruiker

GET /api/v1/hubs/{hub}/users/{user}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Ja tekenreeks
Gebruiker path Ja tekenreeks
Antwoorden
Code Omschrijving
200 Voltooid
400 Onjuiste aanvraag
404 Niet gevonden

Voeg een verbinding toe aan de doelgroep.

PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Ja tekenreeks
groeperen path De naam van de doelgroep, waarvan de lengte groter moet zijn dan 0 en kleiner dan 1025. Ja tekenreeks
connectionId path Doelverbindings-id Ja tekenreeks
Antwoorden
Code Omschrijving
200 Voltooid
400 Onjuiste aanvraag
404 Niet gevonden

Verwijder een verbinding uit de doelgroep.

DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Ja tekenreeks
groeperen path De naam van de doelgroep, waarvan de lengte groter moet zijn dan 0 en kleiner dan 1025. Ja tekenreeks
connectionId path Doelverbindings-id Ja tekenreeks
Antwoorden
Code Omschrijving
200 Voltooid
400 Onjuiste aanvraag
404 Niet gevonden

Controleer of een gebruiker in de doelgroep bestaat.

GET /api/v1/hubs/{hub}/groups/{group}/users/{user}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Ja tekenreeks
groeperen path De naam van de doelgroep, waarvan de lengte groter moet zijn dan 0 en kleiner dan 1025. Ja tekenreeks
Gebruiker path Doelgebruikers-id Ja tekenreeks
Antwoorden
Code Omschrijving
200 Voltooid
400 Onjuiste aanvraag
404 Niet gevonden

Voeg een gebruiker toe aan de doelgroep.

PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Ja tekenreeks
groeperen path De naam van de doelgroep, waarvan de lengte groter moet zijn dan 0 en kleiner dan 1025. Ja tekenreeks
Gebruiker path Doelgebruikers-id Ja tekenreeks
ttl query Hiermee geeft u de seconden op dat de gebruiker in de groep bestaat. Als deze optie niet is ingesteld, woont de gebruiker maximaal 1 jaar in de groep. Houd er rekening mee dat wanneer ttl niet is ingesteld, de service 100 relaties per gebruiker en oude relatie tussen gebruikersgroepen en oude gebruikersgroepsrelaties overschreven wordt door nieuw toegevoegde relaties. Nee geheel getal
Antwoorden
Code Omschrijving
202 Geslaagd
400 Onjuiste aanvraag

Verwijder een gebruiker uit de doelgroep.

DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Ja tekenreeks
groeperen path De naam van de doelgroep, waarvan de lengte groter moet zijn dan 0 en kleiner dan 1025. Ja tekenreeks
Gebruiker path Doelgebruikers-id Ja tekenreeks
Antwoorden
Code Omschrijving
202 Geslaagd
400 Onjuiste aanvraag

Een gebruiker uit alle groepen verwijderen.

DELETE /api/v1/hubs/{hub}/users/{user}/groups

Parameters
Naam Gelegen in Omschrijving Vereist Schema
Hub path Doelhubnaam, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. Ja tekenreeks
Gebruiker path Doelgebruikers-id Ja tekenreeks
Antwoorden
Code Omschrijving
200 De gebruiker wordt verwijderd
202 De verwijderaanvraag wordt geaccepteerd en de service verwerkt de aanvraag op de achtergrond
400 Onjuiste aanvraag

Modellen

PayloadMessage

Naam Type Beschrijving Vereist
Doel tekenreeks Nee
Argumenten [ object ] Nee