Compartilhar via

API REST do plano de dados do Serviço do Azure SignalR – v1-preview

  • Artigo

Este artigo contém as APIs REST da versão v1-preview obsoletas para o plano de dados do Serviço do Azure SignalR. Em vez disso, use a versão mais recente.

APIs Disponíveis

API Caminho
post /api/v1-preview/hub/{hub}/user/{id} POST /api/v1-preview/hub/{hub}/user/{id}
post /api/v1-preview/hub/{hub}/users/{userList} POST /api/v1-preview/hub/{hub}/users/{userList}
post /api/v1-preview/hub/{hub} POST /api/v1-preview/hub/{hub}
post /api/v1-preview/hub/{hub}/group/{group} POST /api/v1-preview/hub/{hub}/group/{group}
post /api/v1-preview/hub/{hub}/groups/{groupList} POST /api/v1-preview/hub/{hub}/groups/{groupList}

post /api/v1-preview/hub/{hub}/user/{id}

POST /api/v1-preview/hub/{hub}/user/{id}

Descrição:

Enviar uma mensagem para um usuário.

Parâmetros
Nome Localizado em Descrição Necessário Esquema
hub path O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado. Sim string
ID path ID do usuário de destino. Sim string
mensagem body Sim Message
Respostas
Código Descrição
202 Accepted

post /api/v1-preview/hub/{hub}/users/{userList}

POST /api/v1-preview/hub/{hub}/users/{userList}

Descrição:

Enviar uma mensagem a vários usuários.

Parâmetros
Nome Localizado em Descrição Necessário Esquema
hub path O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado. Sim string
userList path Lista de IDs de usuário separadas por vírgula. Sim string
mensagem body Sim Message
Respostas
Código Descrição
202 Accepted

post /api/v1-preview/hub/{hub}

POST /api/v1-preview/hub/{hub}

Descrição:

Transmitir uma mensagem para todos os clientes conectados ao hub de destino.

Parâmetros
Nome Localizado em Descrição Necessário Esquema
hub path O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado. Sim string
mensagem body Sim Message
Respostas
Código Descrição
202 Accepted

post /api/v1-preview/hub/{hub}/group/{group}

POST /api/v1-preview/hub/{hub}/group/{group}

Descrição:

Transmitir uma mensagem para todos os clientes dentro do grupo de destino.

Parâmetros
Nome Localizado em Descrição Necessário Esquema
hub path O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado. Sim string
grupo path O nome do grupo de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado. Sim string
mensagem body Sim Message
Respostas
Código Descrição
202 Accepted

post /api/v1-preview/hub/{hub}/groups/{groupList}

POST /api/v1-preview/hub/{hub}/groups/{groupList}

Descrição:

Transmitir uma mensagem para todos os clientes dentro dos grupos de destino.

Parâmetros
Nome Localizado em Descrição Necessário Esquema
hub path O nome do hub de destino, que deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado. Sim string
groupList path Lista de nomes de grupo separados por vírgula. Cada nome de grupo deve começar com caracteres alfabéticos e só conter caracteres alfanuméricos ou sublinhado. Sim string
mensagem body Sim Message
Respostas
Código Descrição
202 Accepted

Modelos

Message

Mensagem de invocação de método.

Nome Digitar Descrição Necessário
destino string Nome do método de destino. Não
argumentos [ objeto ] Argumentos de método de destino. Não