Interfejs API REST płaszczyzny danych usługi Azure SignalR Service — wersja 1-zapoznawcza
Ten artykuł zawiera przestarzałe interfejsy API REST wersji 1 w wersji zapoznawczej dla płaszczyzny danych usługi Azure SignalR Service. Zamiast tego użyj najnowszej wersji .
Dostępne interfejsy API
Interfejs API | Ścieżka |
---|---|
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}
Opis rozwiązania:
Wyślij wiadomość do pojedynczego użytkownika.
Parametry
Nazwisko | Znajduje się w | opis | Wymagania | Schemat |
---|---|---|---|---|
Koncentratora | path | Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. | Tak | string |
identyfikator | path | Identyfikator użytkownika docelowego. | Tak | string |
wiadomość | treść | Tak | Wiadomość |
Odpowiedzi
Kod | opis |
---|---|
202 | Zaakceptowano |
post /api/v1-preview/hub/{hub}/users/{userList}
POST /api/v1-preview/hub/{hub}/users/{userList}
Opis rozwiązania:
Wyślij wiadomość do wielu użytkowników.
Parametry
Nazwisko | Znajduje się w | opis | Wymagania | Schemat |
---|---|---|---|---|
Koncentratora | path | Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. | Tak | string |
Userlist | path | Rozdzielona przecinkami lista identyfikatorów użytkownika. | Tak | string |
wiadomość | treść | Tak | Wiadomość |
Odpowiedzi
Kod | opis |
---|---|
202 | Zaakceptowano |
post /api/v1-preview/hub/{hub}
POST /api/v1-preview/hub/{hub}
Opis rozwiązania:
Emisja komunikatu do wszystkich klientów połączonych z koncentratorem docelowym.
Parametry
Nazwisko | Znajduje się w | opis | Wymagania | Schemat |
---|---|---|---|---|
Koncentratora | path | Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. | Tak | string |
wiadomość | treść | Tak | Wiadomość |
Odpowiedzi
Kod | opis |
---|---|
202 | Zaakceptowano |
post /api/v1-preview/hub/{hub}/group/{group}
POST /api/v1-preview/hub/{hub}/group/{group}
Opis rozwiązania:
Emisja komunikatu do wszystkich klientów w grupie docelowej.
Parametry
Nazwisko | Znajduje się w | opis | Wymagania | Schemat |
---|---|---|---|---|
Koncentratora | path | Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. | Tak | string |
grupa | path | Nazwa grupy docelowej, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. | Tak | string |
wiadomość | treść | Tak | Wiadomość |
Odpowiedzi
Kod | opis |
---|---|
202 | Zaakceptowano |
post /api/v1-preview/hub/{hub}/groups/{groupList}
POST /api/v1-preview/hub/{hub}/groups/{groupList}
Opis rozwiązania:
Emisja komunikatu do wszystkich klientów w grupach docelowych.
Parametry
Nazwisko | Znajduje się w | opis | Wymagania | Schemat |
---|---|---|---|---|
Koncentratora | path | Nazwa centrum docelowego, która musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. | Tak | string |
groupList | path | Rozdzielona przecinkami lista nazw grup. Każda nazwa grupy musi zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. | Tak | string |
wiadomość | treść | Tak | Wiadomość |
Odpowiedzi
Kod | opis |
---|---|
202 | Zaakceptowano |
Modele
Wiadomość
Komunikat wywołania metody.
Imię i nazwisko/nazwa | Pisz | Opis | Wymagania |
---|---|---|---|
target | string | Nazwa metody docelowej. | Nie. |
Argumenty | [ obiekt ] | Argumenty metody docelowej. | Nie. |