Web Pub Sub - Send To User

Servicio:

Azure Web PubSub Service

Versión de la API:

2024-01-01

Envíe contenido dentro del cuerpo de la solicitud al usuario específico.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string url	Punto de conexión HTTP o HTTPS para la instancia del servicio Web PubSub.
hub	path	True	string	Nombre del centro de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. Patrón de Regex: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
userId	path	True	string	Identificador de usuario.
api-version	query	True	string	Versión de las API REST.
filter	query		string	Siguiendo la sintaxis de filtro de OData para filtrar los suscriptores que reciben los mensajes.
messageTtlSeconds	query		integer int32	Valor de período de vida (TTL) en segundos para los mensajes enviados al servicio. 0 es el valor predeterminado, lo que significa que el mensaje nunca expira. 300 es el valor máximo. Si este parámetro no es cero, el servicio quitará los mensajes que no consuma el cliente dentro del TTL especificado. Este parámetro puede ayudar cuando el ancho de banda del cliente está limitado.

Cuerpo de la solicitud

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

Nombre	Tipo	Description
message	string	El cuerpo de la carga.

Respuestas

Nombre	Tipo	Description
202 Accepted		Aceptado
Other Status Codes	ErrorDetail	Respuesta de error Encabezados x-ms-error-code: string

Ejemplos

WebPubSub_SendToUser

Solicitud de ejemplo

HTTP

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

"Message to send"

Respuesta de muestra

status code:

202

Definiciones

Nombre	Description
ErrorDetail	Objeto de error.
InnerError

ErrorDetail

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	ErrorDetail[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
inner	InnerError
message	string	Representación legible del error.
target	string	Destino del error.

InnerError

Nombre	Tipo	Description
code	string	Código de error más específico del proporcionado por el error contenedor.
inner	InnerError