Dela via

Web Pub Sub - Send To User

Tjänst:
Azure Web PubSub Service
API-version:
2024-01-01

Skicka innehåll inuti begärandetexten till den specifika användaren.

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

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string (url)

HTTP- eller HTTPS-slutpunkt för web pubsub-tjänstinstansen.
hub
 path True

string

pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$

Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.
userId
 path True

string

minLength: 1

Användar-ID:t.
api-version
 query True

string

Versionen av REST-API:erna.
filter
 query

string

Följ OData-filtersyntaxen för att filtrera bort prenumeranterna som tar emot meddelandena.
messageTtlSeconds
 query

integer (int32)

minimum: 0
maximum: 300

TTL-värdet (time-to-live) i sekunder för meddelanden som skickas till tjänsten. 0 är standardvärdet, vilket innebär att meddelandet aldrig upphör att gälla. 300 är det maximala värdet. Om den här parametern inte är noll kommer meddelanden som inte förbrukas av klienten inom den angivna TTL:en att tas bort av tjänsten. Den här parametern kan vara till hjälp när klientens bandbredd är begränsad.

Begärandetext

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

Name Typ Description
message

string (binary)

Nyttolastens brödtext.

Svar

Name Typ Description
202 Accepted

Accepterad
Other Status Codes

ErrorDetail

Felsvar

Sidhuvuden

x-ms-error-code: string

Exempel

WebPubSub_SendToUser

Exempelbegäran

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

"Message to send"

Exempelsvar

Statuskod:
202

Definitioner

Name Description
ErrorDetail

Felobjektet.
InnerError

ErrorDetail

Objekt

Felobjektet.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.
details

ErrorDetail[]

En matris med information om specifika fel som ledde till det rapporterade felet.
inner

InnerError

message

string

En mänsklig läsbar representation av felet.
target

string

Målet för felet.

InnerError

Objekt
Name Typ Description
code

string

En mer specifik felkod än vad som angavs av det innehållande felet.
inner

InnerError