Azure SignalR 服务数据平面 REST API - v1 预览版

Artículo
10/13/2023

本文包含用于 Azure SignalR 服务数据平面的过时 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	目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。	是	string
id	path	目标用户 ID。	是	string
message	body		是	消息

响应

代码	说明
202	已接受

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

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

说明：

向多个用户发送消息。

参数

名称	所在位置	描述	必需	架构
中心	path	目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。	是	string
userList	path	以逗号分隔的用户 ID 列表。	是	string
message	body		是	消息

响应

代码	说明
202	已接受

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

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

说明：

将消息广播到所有连接到目标中心的客户端。

参数

名称	所在位置	描述	必需	架构
中心	path	目标中心名称，应以字母字符开头，并且仅包含字母数字字符或下划线。	是	string
message	body		是	消息

响应

代码	说明
202	已接受

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

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

说明：

将消息广播到目标组中的所有客户端。

参数

名称	所在位置	描述	必需	架构
中心	path	目标中心名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。	是	string
group	path	目标组名称，必须以字母字符开头，并且仅包含字母数字字符或下划线。	是	string
message	body		是	消息

响应

代码	说明
202	已接受

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

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

说明：