你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Web Pub Sub - Send To User

服务:

Azure Web PubSub Service

API 版本:

2024-01-01

将请求正文内的内容发送给特定用户。

POST {endpoint}/api/hubs/{hub}/users/{userId}/:send?api-version=2024-01-01

具有可选参数:

POST {endpoint}/api/hubs/{hub}/users/{userId}/:send?api-version=2024-01-01&filter={filter}&messageTtlSeconds={messageTtlSeconds}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string url	Web PubSub 服务实例的 HTTP 或 HTTPS 终结点。
hub	path	True	string	目标中心名称，该名称应以字母字符开头，并且仅包含字母数字字符或下划线。 正则表达式模式: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
userId	path	True	string	用户 ID。
api-version	query	True	string	REST API 的版本。
filter	query		string	遵循 OData 筛选器语法来筛选出接收消息的订阅服务器。
messageTtlSeconds	query		integer int32	发送到服务的消息的生存时间（TTL）值（以秒为单位）。 0 是默认值，这意味着消息永不过期。 300 是最大值。 如果此参数为非零，则服务不会删除客户端在指定 TTL 内使用的消息。 当客户端的带宽受到限制时，此参数可以帮助。

请求正文

Media Types: "application/octet-stream", "text/plain", "application/json"

名称	类型	说明
message	string	有效负载正文。

响应

名称	类型	说明
202 Accepted		接受
Other Status Codes	ErrorDetail	错误响应 标头 x-ms-error-code: string

示例

WebPubSub_SendToUser

示例请求

HTTP

POST {endpoint}/api/hubs/hub1/users/user1/:send?api-version=2024-01-01&filter=startswith(userId, 'listener-')&messageTtlSeconds=15

"Message to send"

示例响应

状态代码:

202

定义

名称	说明
ErrorDetail	错误对象。
InnerError

ErrorDetail

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	ErrorDetail[]	导致此报告错误的特定错误的详细信息数组。
inner	InnerError
message	string	错误的人工可读表示形式。
target	string	错误的目标。

InnerError

名称	类型	说明
code	string	比包含的错误提供的错误代码更具体。
inner	InnerError