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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	Web PubSub 服務實例的 HTTP 或 HTTPS 端點。
hub	path	True	string	目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 Regex 模式: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
userId	path	True	string	用戶標識碼。
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"

名稱	類型	Description
message	string	承載主體。

回應

名稱	類型	Description
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

定義

名稱	Description
ErrorDetail	error 物件。
InnerError

ErrorDetail

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	ErrorDetail[]	導致此錯誤之特定錯誤的詳細數據陣列。
inner	InnerError
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

InnerError

名稱	類型	Description
code	string	比包含的錯誤所提供更明確的錯誤碼。
inner	InnerError