REST API voor azure SignalR Service-gegevensvlak - v1-preview
Dit artikel bevat de verouderde REST API's van de v1-preview-versie voor azure SignalR Service-gegevenslaag. Gebruik in plaats daarvan de nieuwste versie .
Beschikbare API's
API | Pad |
---|---|
post /api/v1-preview/hub/{hub}/user/{id} | POST /api/v1-preview/hub/{hub}/user/{id} |
post /api/v1-preview/hub/{hub}/users/{userList} | POST /api/v1-preview/hub/{hub}/users/{userList} |
post /api/v1-preview/hub/{hub} | POST /api/v1-preview/hub/{hub} |
post /api/v1-preview/hub/{hub}/group/{group} | POST /api/v1-preview/hub/{hub}/group/{group} |
post /api/v1-preview/hub/{hub}/groups/{groupList} | POST /api/v1-preview/hub/{hub}/groups/{groupList} |
post /api/v1-preview/hub/{hub}/user/{id}
POST /api/v1-preview/hub/{hub}/user/{id}
Beschrijving:
Een bericht verzenden naar één gebruiker.
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 | Doelgebruikers-id. | Ja | tekenreeks |
bericht | hoofdtekst | Ja | Bericht |
Antwoorden
Code | Omschrijving |
---|---|
202 | Geaccepteerd |
post /api/v1-preview/hub/{hub}/users/{userList}
POST /api/v1-preview/hub/{hub}/users/{userList}
Beschrijving:
Een bericht verzenden naar meerdere gebruikers.
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 |
Userlist | path | Door komma's gescheiden lijst met gebruikers-id's. | Ja | tekenreeks |
bericht | hoofdtekst | Ja | Bericht |
Antwoorden
Code | Omschrijving |
---|---|
202 | Geaccepteerd |
post /api/v1-preview/hub/{hub}
POST /api/v1-preview/hub/{hub}
Beschrijving:
Een bericht uitzenden naar alle clients die zijn verbonden met de doelhub.
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 |
bericht | hoofdtekst | Ja | Bericht |
Antwoorden
Code | Omschrijving |
---|---|
202 | Geaccepteerd |
post /api/v1-preview/hub/{hub}/group/{group}
POST /api/v1-preview/hub/{hub}/group/{group}
Beschrijving:
Een bericht uitzenden naar alle clients binnen de doelgroep.
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 | Naam van de doelgroep, die moet beginnen met alfabetische tekens en alleen alfanumerieke tekens of onderstrepingstekens bevatten. | Ja | tekenreeks |
bericht | hoofdtekst | Ja | Bericht |
Antwoorden
Code | Omschrijving |
---|---|
202 | Geaccepteerd |
post /api/v1-preview/hub/{hub}/groups/{groupList}
POST /api/v1-preview/hub/{hub}/groups/{groupList}
Beschrijving:
Een bericht uitzenden naar alle clients binnen de doelgroepen.
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 |
groupList | path | Door komma's gescheiden lijst met groepsnamen. Elke groepsnaam moet beginnen met alfabetische tekens en mag alleen alfanumerieke tekens of onderstrepingstekens bevatten. | Ja | tekenreeks |
bericht | hoofdtekst | Ja | Bericht |
Antwoorden
Code | Omschrijving |
---|---|
202 | Geaccepteerd |
Modellen
Bericht
Aanroepbericht van methode.
Naam | Type | Beschrijving | Vereist |
---|---|---|---|
doel | tekenreeks | Naam van doelmethode. | Nee |
Argumenten | [ object ] | Argumenten voor doelmethode. | Nee |