API REST del piano dati Servizio Azure SignalR - v1-preview
Questo articolo contiene le API REST della versione v1-preview obsoleta per Servizio Azure SignalR piano dati. Usare invece la versione più recente.
API disponibili
API | Percorso |
---|---|
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}
Descrizione:
Inviare un messaggio a un singolo utente.
Parametri
Nome | Posizione | Descrizione | Richiesto | Schema |
---|---|---|---|---|
hub | path | Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. | Sì | stringa |
ID | path | ID utente di destinazione. | Sì | stringa |
messaggio | corpo | Sì | Messaggio |
Risposte
Codice | Descrizione |
---|---|
202 | Accettata |
post /api/v1-preview/hub/{hub}/users/{userList}
POST /api/v1-preview/hub/{hub}/users/{userList}
Descrizione:
Inviare un messaggio a più utenti.
Parametri
Nome | Posizione | Descrizione | Richiesto | Schema |
---|---|---|---|---|
hub | path | Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. | Sì | stringa |
Userlist | path | Elenco delimitato da virgole di ID utente. | Sì | stringa |
messaggio | corpo | Sì | Messaggio |
Risposte
Codice | Descrizione |
---|---|
202 | Accettata |
post /api/v1-preview/hub/{hub}
POST /api/v1-preview/hub/{hub}
Descrizione:
Trasmettere un messaggio a tutti i client connessi all'hub di destinazione.
Parametri
Nome | Posizione | Descrizione | Richiesto | Schema |
---|---|---|---|---|
hub | path | Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. | Sì | stringa |
messaggio | corpo | Sì | Messaggio |
Risposte
Codice | Descrizione |
---|---|
202 | Accettata |
post /api/v1-preview/hub/{hub}/group/{group}
POST /api/v1-preview/hub/{hub}/group/{group}
Descrizione:
Trasmettere un messaggio a tutti i client all'interno del gruppo di destinazione.
Parametri
Nome | Posizione | Descrizione | Richiesto | Schema |
---|---|---|---|---|
hub | path | Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. | Sì | stringa |
gruppo | path | Nome del gruppo di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. | Sì | stringa |
messaggio | corpo | Sì | Messaggio |
Risposte
Codice | Descrizione |
---|---|
202 | Accettata |
post /api/v1-preview/hub/{hub}/groups/{groupList}
POST /api/v1-preview/hub/{hub}/groups/{groupList}
Descrizione:
Trasmettere un messaggio a tutti i client all'interno dei gruppi di destinazione.
Parametri
Nome | Posizione | Descrizione | Richiesto | Schema |
---|---|---|---|---|
hub | path | Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. | Sì | stringa |
groupList | path | Elenco delimitato da virgole di nomi di gruppo. Ogni nome di gruppo deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. | Sì | stringa |
messaggio | corpo | Sì | Messaggio |
Risposte
Codice | Descrizione |
---|---|
202 | Accettata |
Modelli
Message
Messaggio di chiamata al metodo.
Nome | Digita | Descrizione | Richiesto |
---|---|---|---|
bersaglio | stringa | Nome del metodo di destinazione. | No |
arguments | [ object ] | Argomenti del metodo di destinazione. | No |