Versión preliminar de REST API - v1-preview del plano de datos de Azure SignalR Service

  • Artículo

Este artículo contiene las API REST v1-preview obsoletas para el plan de datos de Azure SignalR Service. Use la versión más reciente 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íe un mensaje a un único usuario.

Parámetros
Nombre Ubicado en Descripción Obligatorio Esquema
centro path El nombre del centro de destino, que debe comenzar con los caracteres alfabéticos y solo puede contener caracteres alfanuméricos o un guion bajo. Sí cadena
id path Id. de usuario de destino. Sí cadena
message body Sí Mensaje
Respuestas
Código Descripción
202 Aceptadas

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

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

Descripción:

Envíe un mensaje a varios usuarios.

Parámetros
Nombre Ubicado en Descripción Obligatorio Esquema
centro path El nombre del centro de destino, que debe comenzar con los caracteres alfabéticos y solo puede contener caracteres alfanuméricos o un guion bajo. Sí cadena
userList path Lista separada por comas de identificadores de usuario. Sí cadena
message body Sí Mensaje
Respuestas
Código Descripción
202 Aceptadas

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

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

Descripción:

Retransmitir un mensaje a todos los clientes conectados al centro de destino.

Parámetros
Nombre Ubicado en Descripción Obligatorio Esquema
centro path El nombre del centro de destino, que debe comenzar con los caracteres alfabéticos y solo puede contener caracteres alfanuméricos o un guion bajo. Sí cadena
message body Sí Mensaje
Respuestas
Código Descripción
202 Aceptadas

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

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

Descripción:

Retransmitir un mensaje a todos los clientes del grupo de destino.

Parámetros
Nombre Ubicado en Descripción Obligatorio Esquema
centro path Nombre del centro de destino, que tiene que comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o un guion bajo. Sí cadena
group path Nombre del grupo de destino, que tiene que comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o un guion bajo. Sí cadena
message body Sí Mensaje
Respuestas
Código Descripción
202 Aceptadas

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

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

Descripción:

Difunda un mensaje a todos los clientes de los grupos de destino.

Parámetros
Nombre Ubicado en Descripción Obligatorio Esquema
centro path El nombre del centro de destino, que tiene que comenzar con caracteres alfabéticos y solo puede contener caracteres alfanuméricos o un guion bajo. Sí cadena
groupList path Lista separada por comas de nombres de grupo. Cada nombre de grupo tiene que comenzar con caracteres alfabéticos y solo puede contener caracteres alfanuméricos o un guion bajo. Sí cadena
message body Sí Mensaje
Respuestas
Código Descripción
202 Aceptadas

Models

Mensaje

Mensaje de invocación de método.

Nombre Tipo Descripción Obligatorio
Destino cadena Nombre de método de destino No
argumentos [ objeto ] Argumentos del método de destino. No