Sdílet prostřednictvím

Rozhraní REST API roviny dat služby Azure SignalR – v1-Preview

  • Článek

Tento článek obsahuje zastaralé rozhraní REST API verze v1-Preview pro rovinu dat služby Azure SignalR. Místo toho použijte nejnovější verzi .

Dostupná rozhraní API

API Cesta
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}

Popis:

Odešle zprávu jednomu uživateli.

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
ID path Id cílového uživatele. Ano řetězec
zpráva text Ano Message
Odpovědi
Kód Popis
202 Akceptováno

post /api/v1-preview/hub/{hub}/users/{userList}

POST /api/v1-preview/hub/{hub}/users/{userList}

Popis:

Odešlete zprávu více uživatelům.

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
userList path Čárkami oddělený seznam ID uživatele Ano řetězec
zpráva text Ano Message
Odpovědi
Kód Popis
202 Akceptováno

post /api/v1-preview/hub/{hub}

POST /api/v1-preview/hub/{hub}

Popis:

Vysílejte zprávu všem klientům připojeným k cílovému centru.

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
zpráva text Ano Message
Odpovědi
Kód Popis
202 Akceptováno

post /api/v1-preview/hub/{hub}/group/{group}

POST /api/v1-preview/hub/{hub}/group/{group}

Popis:

Vysílejte zprávu všem klientům v cílové skupině.

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
skupina path Název cílové skupiny, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
zpráva text Ano Message
Odpovědi
Kód Popis
202 Akceptováno

post /api/v1-preview/hub/{hub}/groups/{groupList}

POST /api/v1-preview/hub/{hub}/groups/{groupList}

Popis:

Vysílejte zprávu všem klientům v rámci cílových skupin.

Parametry
Název Nachází se v Popis Požaduje se Schéma
Rozbočovač path Název cílového centra, který musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
groupList path Seznam názvů skupin oddělených čárkami Každý název skupiny musí začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Ano řetězec
zpráva text Ano Message
Odpovědi
Kód Popis
202 Akceptováno

Modely

Message

Zpráva vyvolání metody

Name Typ Popis Požaduje se
target řetězec Název cílové metody. No
Argumenty [ objekt ] Argumenty cílové metody. No