本文包含已淘汰的v1預覽版REST APIS for Azure SignalR 服务 data plane。 请使用 最新版本 。
可用 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}
说明:
给单个用户发送消息。
参数
| Name | 位于 | Description | 必需 | 架构 |
|---|---|---|---|---|
| 中心 | 路径 | 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 | Yes | 字符串 |
| id | 路径 | 目标用户ID。 | Yes | 字符串 |
| 消息 | body | Yes | 消息 |
Responses
| Code | Description |
|---|---|
| 202 | 已接受 |
post /api/v1-preview/hub/{hub}/users/{userList}
POST /api/v1-preview/hub/{hub}/users/{userList}
说明:
向多个用户发送消息。
参数
| Name | 位于 | Description | 必需 | 架构 |
|---|---|---|---|---|
| 中心 | 路径 | 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 | Yes | 字符串 |
| 用户列表 | 路径 | 用户ID的逗号分隔列表。 | Yes | 字符串 |
| 消息 | body | Yes | 消息 |
Responses
| Code | Description |
|---|---|
| 202 | 已接受 |
post /API/v1-preview/hub/{hub}
POST /api/v1-preview/hub/{hub}
说明:
向所有连接到目标枢纽的客户端广播消息。
参数
| Name | 位于 | Description | 必需 | 架构 |
|---|---|---|---|---|
| 中心 | 路径 | 目标中心名称，应以字母字符开头，仅包含字母数字字符或下划线。 | Yes | 字符串 |
| 消息 | body | Yes | 消息 |
Responses
| Code | Description |
|---|---|
| 202 | 已接受 |
Post /API/V1-Preview/Hub/{hub}/Group/{group}
POST /api/v1-preview/hub/{hub}/group/{group}
说明:
向目标组内的所有客户端广播消息。
参数
| Name | 位于 | Description | 必需 | 架构 |
|---|---|---|---|---|
| 中心 | 路径 | 目标枢纽名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 | Yes | 字符串 |
| 组 | 路径 | 目标组名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 | Yes | 字符串 |
| 消息 | body | Yes | 消息 |
Responses
| Code | Description |
|---|---|
| 202 | 已接受 |
post /api/v1-preview/hub/{hub}/groups/{groupList}
POST /api/v1-preview/hub/{hub}/groups/{groupList}
说明:
向目标组内的所有客户端广播消息。
参数
| Name | 位于 | Description | 必需 | 架构 |
|---|---|---|---|---|
| 中心 | 路径 | 目标集线器名称，必须以字母字符开头，且仅包含字母数字字符或下划线。 | Yes | 字符串 |
| 组列表 | 路径 | 乐队名称的逗号分隔列表。 每个组名必须以字母字符开头，且仅包含字母数字字符或下划线。 | Yes | 字符串 |
| 消息 | body | Yes | 消息 |
Responses
| Code | Description |
|---|---|
| 202 | 已接受 |
模型
Message
方法调用消息。
| Name | 类型 | Description | 必需 |
|---|---|---|---|
| 目标 | 字符串 | 目标方法名称。 | No |
| arguments | [ 物体 ] | 目标方法参数。 | No |