Partilhar via

Web Pub Sub - Send To User

  • Referência
Serviço:
Azure Web PubSub Service
Versão da API:
2024-01-01

Envie conteúdo dentro do corpo da solicitação para o usuário específico.

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

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
 path True

string

url

Ponto de extremidade HTTP ou HTTPS para a instância do serviço Web PubSub.
hub
 path True

string

Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado.

Padrão Regex: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
userId
 path True

string

O ID do usuário.
api-version
 query True

string

A versão das APIs REST.
filter
 query

string

Seguindo a sintaxe do filtro OData para filtrar os assinantes que recebem as mensagens.
messageTtlSeconds
 query

integer

int32

O valor de tempo de vida (TTL) em segundos para mensagens enviadas ao serviço. 0 é o valor padrão, o que significa que a mensagem nunca expira. 300 é o valor máximo. Se esse parâmetro for diferente de zero, as mensagens que não forem consumidas pelo cliente dentro do TTL especificado serão descartadas pelo serviço. Este parâmetro pode ajudar quando a largura de banda do cliente é limitada.

Corpo do Pedido

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

Name Tipo Description
message

string

O corpo da carga útil.

Respostas

Name Tipo Description
202 Accepted

Aceito
Other Status Codes

ErrorDetail

Resposta de erro

Cabeçalhos

x-ms-error-code: string

Exemplos

WebPubSub_SendToUser

Pedido de amostra

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

"Message to send"

Resposta da amostra

Código de estado:
202

Definições

Name Description
ErrorDetail

O objeto de erro.
InnerError

ErrorDetail

O objeto de erro.

Name Tipo Description
code

string

Um de um conjunto de códigos de erro definido pelo servidor.
details

ErrorDetail[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
inner

InnerError

message

string

Uma representação legível por humanos do erro.
target

string

O alvo do erro.

InnerError

Name Tipo Description
code

string

Um código de erro mais específico do que foi fornecido pelo erro que contém.
inner

InnerError