Azure SignalR Service data plane REST API - v1-preview

Este artículo contiene las obsoletas APIs REST de la versión v1-preview para Azure SignalR Service data plane. Por favor, utiliza la última versión en su lugar.

API disponibles

API	Path
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}

Descripción:

Envía un mensaje a un solo usuario.

Parameters

Nombre	Ubicado en	Description	Obligatorio	Schema
centro	ruta	Nombre del centro de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado.	Sí	string
id	ruta	ID de usuario objetivo.	Sí	string
message	body		Sí	Mensaje

Responses

Code	Description
202	Aceptado

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

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

Descripción:

Envía un mensaje a varios usuarios.

Parameters

Nombre	Ubicado en	Description	Obligatorio	Schema
centro	ruta	Nombre del centro de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado.	Sí	string
userList	ruta	Lista separada por comas de IDs de usuario.	Sí	string
message	body		Sí	Mensaje

Responses

Code	Description
202	Aceptado

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

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

Descripción:

Difunde un mensaje a todos los clientes conectados al hub objetivo.

Parameters

Nombre	Ubicado en	Description	Obligatorio	Schema
centro	ruta	Nombre del centro de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado.	Sí	string
message	body		Sí	Mensaje

Responses

Code	Description
202	Aceptado

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

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

Descripción:

Difunde un mensaje a todos los clientes dentro del grupo objetivo.

Parameters

Nombre	Ubicado en	Description	Obligatorio	Schema
centro	ruta	Nombre del hub objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion bajo.	Sí	string
group	ruta	Nombre del grupo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subtirado.	Sí	string
message	body		Sí	Mensaje

Responses

Code	Description
202	Aceptado

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

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

Descripción:

Difunde un mensaje a todos los clientes dentro de los grupos objetivo.

Parameters

Nombre	Ubicado en	Description	Obligatorio	Schema
centro	ruta	Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado.	Sí	string
grupoLista	ruta	Lista de nombres de grupos separada por comas. El nombre de cada grupo debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o guion bajo.	Sí	string
message	body		Sí	Mensaje

Responses

Code	Description
202	Aceptado

Models

Mensaje

Mensaje de invocación de métodos.

Nombre	Tipo	Description	Obligatorio
target	string	Nombre del método objetivo.	No
argumentos	[ objeto ]	Argumentos del método objetivo.	No