Dela via

REST API för Azure SignalR Service-dataplan – v1-förhandsversion

Den här artikeln innehåller rest-API:er för den föråldrade v1-förhandsversionen för Azure SignalR Service-dataplanet. Använd den senaste versionen i stället.

Tillgängliga API:er

API Sökväg
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}

Beskrivning:

Skicka ett meddelande till en enskild användare.

Parameters
Name Finns i Description Obligatoriskt Schema
Nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
id path Målanvändar-ID. Ja sträng
meddelande brödtext Ja Meddelande
Svar
Kod Description
202 Godkänd

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

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

Beskrivning:

Skicka ett meddelande till flera användare.

Parameters
Name Finns i Description Obligatoriskt Schema
Nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
userList path Kommaavgränsad lista över användar-ID:t. Ja sträng
meddelande brödtext Ja Meddelande
Svar
Kod Description
202 Godkänd

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

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

Beskrivning:

Skicka ett meddelande till alla klienter som är anslutna till målhubben.

Parameters
Name Finns i Description Obligatoriskt Schema
Nav path Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
meddelande brödtext Ja Meddelande
Svar
Kod Description
202 Godkänd

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

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

Beskrivning:

Skicka ett meddelande till alla klienter i målgruppen.

Parameters
Name Finns i Description Obligatoriskt Schema
Nav path Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
grupp path Målgruppsnamn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
meddelande brödtext Ja Meddelande
Svar
Kod Description
202 Godkänd

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

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

Beskrivning:

Skicka ett meddelande till alla klienter i målgrupperna.

Parameters
Name Finns i Description Obligatoriskt Schema
Nav path Målhubbens namn, som måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
groupList path Kommaavgränsad lista med gruppnamn. Varje gruppnamn måste börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck. Ja sträng
meddelande brödtext Ja Meddelande
Svar
Kod Description
202 Godkänd

Modeller

Meddelande

Meddelande om anrop av metod.

Namn Type Beskrivning Obligatoriskt
mål sträng Namn på målmetod. Inga
Argument [ objekt ] Argument för målmetod. Inga