Azure SignalR Service 資料平面 REST API - v1-preview

發行項
10/24/2023

本文包含 Azure SignalR Service 資料平面的過時 v1 預覽版 REST API。請改用最新版本。

可用的 API

API	路徑
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}

描述：

將訊息傳送給單一使用者。

參數

名稱	位於	描述	必要	結構描述
集線器	path	目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。	Yes	string
id	path	目標使用者識別碼。	Yes	string
message	本文		Yes	訊息

回覆

代碼	描述
202	已接受

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

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

描述：

將訊息傳送給多個使用者。

參數

名稱	位於	描述	必要	結構描述
集線器	path	目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。	Yes	string
userList	path	使用者識別碼的逗號分隔清單。	Yes	string
message	本文		Yes	訊息

回覆

代碼	描述
202	已接受

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

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

描述：

將訊息廣播至連線至目標中樞的所有用戶端。

參數

名稱	位於	描述	必要	結構描述
集線器	path	目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。	Yes	string
message	本文		Yes	訊息

回覆

代碼	描述
202	已接受

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

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

描述：

將訊息廣播至目標群組內的所有用戶端。

參數

名稱	位於	描述	必要	結構描述
集線器	path	目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。	Yes	string
群組	path	目標群組名，其開頭必須是字母字元，且只包含英數位元或底線。	Yes	string
message	本文		Yes	訊息

回覆

代碼	描述
202	已接受

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

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

描述：

將訊息廣播至目標群組內的所有用戶端。

參數

名稱	位於	描述	必要	結構描述
集線器	path	目標中樞名稱，其開頭必須是字母字元，且只包含英數位元或底線。	Yes	string
groupList	path	以逗號分隔的組名清單。每個組名必須以字母字元開頭，且只包含英數位元或底線。	Yes	string
message	本文		Yes	訊息

回覆

代碼	描述
202	已接受

模型

訊息

方法調用訊息。

名稱	類型	描述	必要
目標	string	目標方法名稱。	No
參數	[ 物件 ]	目標方法引數。	No

共用方式為