Web Pub Sub - Send To User

Servizio:

Azure Web PubSub Service

Versione API:

2024-01-01

Inviare contenuto all'interno del corpo della richiesta all'utente specifico.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string url	Endpoint HTTP o HTTPS per l'istanza del servizio Web PubSub.
hub	path	True	string	Nome dell'hub di destinazione, che deve iniziare con caratteri alfabetici e contenere solo caratteri alfanumerici o caratteri di sottolineatura. Criterio di espressione regolare: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
userId	path	True	string	ID utente.
api-version	query	True	string	Versione delle API REST.
filter	query		string	Seguendo la sintassi del filtro OData per filtrare i sottoscrittori che ricevono i messaggi.
messageTtlSeconds	query		integer int32	Valore TTL (Time-to-Live) in secondi per i messaggi inviati al servizio. 0 è il valore predefinito, il che significa che il messaggio non scade mai. 300 è il valore massimo. Se questo parametro è diverso da zero, i messaggi non utilizzati dal client all'interno del TTL specificato verranno eliminati dal servizio. Questo parametro può essere utile quando la larghezza di banda del client è limitata.

Corpo della richiesta

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

Nome	Tipo	Descrizione
message	string	Corpo del payload.

Risposte

Nome	Tipo	Descrizione
202 Accepted		Accettato
Other Status Codes	ErrorDetail	Risposta di errore Intestazioni x-ms-error-code: string

Esempio

WebPubSub_SendToUser

Esempio di richiesta

HTTP

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

"Message to send"

Risposta di esempio

Codice di stato:

202

Definizioni

Nome	Descrizione
ErrorDetail	Oggetto error.
InnerError

ErrorDetail

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	ErrorDetail[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
inner	InnerError
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

InnerError

Nome	Tipo	Descrizione
code	string	Codice di errore più specifico di quello fornito dall'errore contenitore.
inner	InnerError