Compartir a través de

API REST del plano de datos de Azure SignalR Service: v1

  • Artículo

Este artículo contiene las API REST de la versión v1 para el plan de datos de Azure SignalR Service.

API disponibles

API Path
Retransmitir un mensaje a todos los clientes conectados al centro de destino. POST /api/v1/hubs/{hub}
Retransmitir un mensaje a todos los clientes que pertenecen al usuario de destino. POST /api/v1/hubs/{hub}/users/{id}
Enviar un mensaje a una conexión específica. POST /api/v1/hubs/{hub}/connections/{connectionId}
Comprobar si existe la conexión con el elemento connectionId especificado GET /api/v1/hubs/{hub}/connections/{connectionId}
Cerrar la conexión de cliente DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Retransmitir un mensaje a todos los clientes del grupo de destino. POST /api/v1/hubs/{hub}/groups/{group}
Comprobar si hay alguna conexión de cliente dentro del grupo especificado GET /api/v1/hubs/{hub}/groups/{group}
Comprobar si hay alguna conexión de cliente conectada para el usuario especificado GET /api/v1/hubs/{hub}/users/{user}
Agregar una conexión al grupo de destino. PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Quitar una conexión del grupo de destino. DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Comprobar si existe un usuario en el grupo de destino. GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Agregar un usuario al grupo de destino. PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Quitar un usuario del grupo de destino. DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Quitar un usuario de todos los grupos. DELETE /api/v1/hubs/{hub}/users/{user}/groups

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

POST /api/v1/hubs/{hub}

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
Excluido Query Identificadores de conexión excluidos No [ cadena ]
Respuestas
Código Descripción
202 Correcto
400 Bad Request

Retransmitir un mensaje a todos los clientes que pertenecen al usuario de destino.

POST /api/v1/hubs/{hub}/users/{id}

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
id path Id. de usuario. Sí cadena
Respuestas
Código Descripción
202 Correcto
400 Bad Request

Enviar un mensaje a una conexión específica.

POST /api/v1/hubs/{hub}/connections/{connectionId}

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
connectionId path Identificador de conexión. Sí cadena
Respuestas
Código Descripción
202 Correcto
400 Bad Request

Comprobar si existe la conexión con el elemento connectionId especificado

GET /api/v1/hubs/{hub}/connections/{connectionId}

Parámetros
Nombre Ubicado en Descripción Obligatorio Esquema
centro path Sí cadena
connectionId path Sí cadena
Respuestas
Código Descripción
200 Correcto
400 Bad Request
404 No encontrado

Cerrar la conexión de cliente

DELETE /api/v1/hubs/{hub}/connections/{connectionId}

Parámetros
Nombre Ubicado en Descripción Obligatorio Esquema
centro path Sí cadena
connectionId path Sí cadena
reason Query No cadena
Respuestas
Código Descripción
202 Correcto
400 Bad Request

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

POST /api/v1/hubs/{hub}/groups/{group}

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
group path Nombre del grupo de destino, cuya longitud debe ser mayor que 0 y menor que 1025. Sí cadena
Excluido Query Identificadores de conexión excluidos No [ cadena ]
Respuestas
Código Descripción
202 Correcto
400 Bad Request

Comprobar si hay alguna conexión de cliente dentro del grupo especificado

GET /api/v1/hubs/{hub}/groups/{group}

Parámetros
Nombre Ubicado en Descripción Obligatorio Esquema
centro path Sí cadena
group path Sí cadena
Respuestas
Código Descripción
200 Correcto
400 Bad Request
404 No encontrado

Comprobar si hay alguna conexión de cliente conectada para el usuario especificado

GET /api/v1/hubs/{hub}/users/{user}

Parámetros
Nombre Ubicado en Descripción Obligatorio Esquema
centro path Sí cadena
usuario path Sí cadena
Respuestas
Código Descripción
200 Correcto
400 Bad Request
404 No encontrado

Agregar una conexión al grupo de destino.

PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}

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
group path Nombre del grupo de destino, cuya longitud debe ser mayor que 0 y menor que 1025. Sí cadena
connectionId path Identificador de la conexión de destino Sí cadena
Respuestas
Código Descripción
200 Correcto
400 Bad Request
404 No encontrado

Quitar una conexión del grupo de destino.

DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}

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
group path Nombre del grupo de destino, cuya longitud debe ser mayor que 0 y menor que 1025. Sí cadena
connectionId path Identificador de la conexión de destino Sí cadena
Respuestas
Código Descripción
200 Correcto
400 Bad Request
404 No encontrado

Comprobar si existe un usuario en el grupo de destino.

GET /api/v1/hubs/{hub}/groups/{group}/users/{user}

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
group path Nombre del grupo de destino, cuya longitud debe ser mayor que 0 y menor que 1025. Sí cadena
usuario path Id. del usuario de destino Sí cadena
Respuestas
Código Descripción
200 Correcto
400 Bad Request
404 No encontrado

Agregar un usuario al grupo de destino.

PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}

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
group path Nombre del grupo de destino, cuya longitud debe ser mayor que 0 y menor que 1025. Sí cadena
usuario path Id. del usuario de destino Sí cadena
ttl Query Especifica los segundos que el usuario existe en el grupo. Si no se establece, el usuario reside en el grupo durante un máximo de 1 año. Tenga en cuenta que, cuando no se establece ttl, el servicio conserva 100 relaciones usuario-grupo por usuario y las relaciones usuario-grupo antiguas las sobrescriben las recién agregadas. No integer
Respuestas
Código Descripción
202 Correcto
400 Bad Request

Quitar un usuario del grupo de destino.

DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}

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
group path Nombre del grupo de destino, cuya longitud debe ser mayor que 0 y menor que 1025. Sí cadena
usuario path Id. del usuario de destino Sí cadena
Respuestas
Código Descripción
202 Correcto
400 Bad Request

Quitar un usuario de todos los grupos.

DELETE /api/v1/hubs/{hub}/users/{user}/groups

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
usuario path Id. del usuario de destino Sí cadena
Respuestas
Código Descripción
200 Se elimina el usuario.
202 Se ha aceptado la solicitud de eliminación y el servicio controla la solicitud en segundo plano.
400 Bad Request

Models

PayloadMessage

Nombre Tipo Descripción Obligatorio
Destino cadena No
Argumentos [ objeto ] No