Freigeben über

REST-API für die Azure SignalR Service-Datenebene: v1-preview

  • Artikel

Dieser Artikel enthält Informationen zur veralteten Version v1-preview der REST-APIs für die Azure SignalR Service-Datenebene. Verwenden Sie stattdessen die neueste Version.

Verfügbare APIs

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

Beschreibung:

Senden einer Nachricht an einen einzelnen Benutzer

Parameter
Name Enthalten in Beschreibung Erforderlich Schema
Hub path Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten. Ja Zeichenfolge
id path Zielbenutzer-ID Ja Zeichenfolge
Nachricht body Ja Nachricht
Antworten
Code Beschreibung
202 Akzeptiert

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

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

Beschreibung:

Senden einer Nachricht an mehrere Benutzer

Parameter
Name Enthalten in Beschreibung Erforderlich Schema
Hub path Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten. Ja Zeichenfolge
userList path Durch Kommas getrennte Liste mit Benutzer-IDs. Ja Zeichenfolge
Nachricht body Ja Nachricht
Antworten
Code Beschreibung
202 Akzeptiert

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

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

Beschreibung:

Übertragen einer Nachricht an alle Clients, die mit dem Zielhub verbunden sind

Parameter
Name Enthalten in Beschreibung Erforderlich Schema
Hub path Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten. Ja Zeichenfolge
Nachricht body Ja Nachricht
Antworten
Code Beschreibung
202 Akzeptiert

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

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

Beschreibung:

Übertragen einer Nachricht an alle Clients innerhalb der Zielgruppe

Parameter
Name Enthalten in Beschreibung Erforderlich Schema
Hub path Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten. Ja Zeichenfolge
group path Name der Zielgruppe. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten. Ja Zeichenfolge
Nachricht body Ja Nachricht
Antworten
Code Beschreibung
202 Akzeptiert

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

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

Beschreibung:

Übertragen einer Nachricht an alle Clients innerhalb der Zielgruppen

Parameter
Name Enthalten in Beschreibung Erforderlich Schema
Hub path Name des Zielhubs. Muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten. Ja Zeichenfolge
groupList path Durch Kommas getrennte Liste mit Gruppennamen. Jeder Gruppenname muss mit alphabetischen Zeichen beginnen und darf nur alphanumerische Zeichen oder Unterstriche enthalten. Ja Zeichenfolge
Nachricht body Ja Nachricht
Antworten
Code Beschreibung
202 Akzeptiert

Modelle

`Message`

Methodenaufrufnachricht

Name Typ Beschreibung Erforderlich
target Zeichenfolge Name der Zielmethode Nein
Argumente [ Objekt ] Zielmethodenargumente Nein