Azure SignalR Service REST API

  • Artículo

Versión: 2022-06-01

API disponibles

API Path
Obtenga el estado de mantenimiento del servicio. HEAD /api/health
Cierre todas las conexiones del centro. POST /api/hubs/{hub}/:closeConnections
Retransmitir un mensaje a todos los clientes conectados al centro de destino. POST /api/hubs/{hub}/:send
Comprobar si existe la conexión con el elemento connectionId especificado HEAD /api/hubs/{hub}/connections/{connectionId}
Cerrar la conexión de cliente DELETE /api/hubs/{hub}/connections/{connectionId}
Enviar un mensaje a una conexión específica. POST /api/hubs/{hub}/connections/{connectionId}/:send
Comprobar si hay alguna conexión de cliente dentro del grupo especificado HEAD /api/hubs/{hub}/groups/{group}
Cierre las conexiones del grupo específico. POST /api/hubs/{hub}/groups/{group}/:closeConnections
Retransmitir un mensaje a todos los clientes del grupo de destino. POST /api/hubs/{hub}/groups/{group}/:send
Agregar una conexión al grupo de destino. PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Quitar una conexión del grupo de destino. DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}
Quitar una conexión de todos los grupos DELETE /api/hubs/{hub}/connections/{connectionId}/groups
Comprobar si hay alguna conexión de cliente conectada para el usuario especificado HEAD /api/hubs/{hub}/users/{user}
Cierre las conexiones del usuario específico. POST /api/hubs/{hub}/users/{user}/:closeConnections
Retransmitir un mensaje a todos los clientes que pertenecen al usuario de destino. POST /api/hubs/{hub}/users/{user}/:send
Comprobar si existe un usuario en el grupo de destino. HEAD /api/hubs/{hub}/users/{user}/groups/{group}
Agregar un usuario al grupo de destino. PUT /api/hubs/{hub}/users/{user}/groups/{group}
Quitar un usuario del grupo de destino. DELETE /api/hubs/{hub}/users/{user}/groups/{group}
Quitar un usuario de todos los grupos. DELETE /api/hubs/{hub}/users/{user}/groups

/api/health

Resumen

Obtenga el estado de mantenimiento del servicio.

Obtención del estado de mantenimiento del servicio

HEAD /api/health

Parámetros
Nombre Ubicado en Descripción Obligatorio Esquema
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción
200 El servicio es correcto
default Respuesta de error

/api/hubs/{hub}/:close Conectar ions

PUBLICAR

Resumen

Cierre todas las conexiones del centro.

Cierre todas las conexiones del centro

POST /api/hubs/{hub}/:closeConnections

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
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
Excluido Query Excluya estos connectionIds al cerrar las conexiones en el centro. No [ cadena ]
reason Query Motivo por el que se cierran las conexiones de cliente. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
204 Correcto
default Respuesta de error ErrorDetail

/api/hubs/{hub}/:send

PUBLICAR

Resumen

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

Difusión de un mensaje a todos los clientes conectados al centro de destino

POST /api/hubs/{hub}/:send

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
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
Excluido Query Identificadores de conexión excluidos No [ cadena ]
api-version Query Versión de las API REST. Sí cadena
message body Mensaje de carga. Sí PayloadMessage
Respuestas
Código Descripción Esquema
202 Correcto ServiceResponse
default Respuesta de error ErrorDetail

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

HEAD

Resumen

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

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

HEAD /api/hubs/{hub}/connections/{connectionId}

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
connectionId path Identificador de conexión. Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
200 Correcto ServiceResponse
default Respuesta de error ErrorDetail

DELETE

Resumen

Cerrar la conexión de cliente

Cerrar la conexión de cliente

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

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
connectionId path Identificador de conexión. Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
reason Query Motivo del cierre de la conexión. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
200 Correcto ServiceResponse
default Respuesta de error ErrorDetail

/api/hubs/{hub}/connections/{connectionId}/:send

PUBLICAR

Resumen

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

Enviar mensaje a la conexión específica

POST /api/hubs/{hub}/connections/{connectionId}/:send

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
connectionId path Identificador de conexión. Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
message body Mensaje de carga. Sí PayloadMessage
Respuestas
Código Descripción Esquema
202 Correcto ServiceResponse
default Respuesta de error ErrorDetail

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

HEAD

Resumen

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

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

HEAD /api/hubs/{hub}/groups/{group}

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
group path Nombre del grupo de destino, cuya longitud debe ser mayor que 0 y menor que 1025. Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
200 Correcto ServiceResponse
404 No encontrado
default Respuesta de error ErrorDetail

/api/hubs/{hub}/groups/{group}/:close Conectar ions

PUBLICAR

Resumen

Cierre las conexiones del grupo específico.

Cerrar conexiones en el grupo específico

POST /api/hubs/{hub}/groups/{group}/:closeConnections

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
group path Nombre del grupo de destino, cuya longitud debe ser mayor que 0 y menor que 1025. Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
Excluido Query Excluya estos connectionIds al cerrar las conexiones en el centro. No [ cadena ]
reason Query Motivo por el que se cierran las conexiones de cliente. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
204 Correcto
default Respuesta de error ErrorDetail

/api/hubs/{hub}/groups/{group}/:send

PUBLICAR

Resumen

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

Difundir un mensaje a todos los clientes del grupo de destino

POST /api/hubs/{hub}/groups/{group}/:send

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
group path Nombre del grupo de destino, cuya longitud debe ser mayor que 0 y menor que 1025. Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
Excluido Query Identificadores de conexión excluidos No [ cadena ]
api-version Query Versión de las API REST. Sí cadena
message body Mensaje de carga. Sí PayloadMessage
Respuestas
Código Descripción Esquema
202 Correcto ServiceResponse
default Respuesta de error ErrorDetail

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

PUT

Resumen

Agregar una conexión al grupo de destino.

Adición de una conexión al grupo de destino

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

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
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
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
200 Correcto ServiceResponse
404 No encontrado
default Respuesta de error ErrorDetail

DELETE

Resumen

Quitar una conexión del grupo de destino.

Quitar una conexión del grupo de destino

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

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
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
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
200 Correcto ServiceResponse
404 No encontrado
default Respuesta de error ErrorDetail

/api/hubs/{hub}/connections/{connectionId}/groups

DELETE

Resumen

Quitar una conexión de todos los grupos

Quitar una conexión de todos los grupos

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

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
connectionId path Identificador de la conexión de destino Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
200 Correcto ServiceResponse
default Respuesta de error ErrorDetail

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

HEAD

Resumen

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

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

HEAD /api/hubs/{hub}/users/{user}

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
usuario path Id. de usuario. Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
200 Correcto ServiceResponse
404 No encontrado
default Respuesta de error ErrorDetail

/api/hubs/{hub}/users/{user}/:close Conectar ions

PUBLICAR

Resumen

Cierre las conexiones del usuario específico.

Cierre las conexiones del usuario específico.

POST /api/hubs/{hub}/users/{user}/:closeConnections

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
usuario path Id. de usuario. Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
Excluido Query Excluya estos connectionIds al cerrar las conexiones en el centro. No [ cadena ]
reason Query Motivo por el que se cierran las conexiones de cliente. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
204 Correcto
default Respuesta de error ErrorDetail

/api/hubs/{hub}/users/{user}/:send

PUBLICAR

Resumen

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

Difundir un mensaje a todos los clientes pertenecen al usuario de destino

POST /api/hubs/{hub}/users/{user}/:send

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
usuario path Id. de usuario. Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
message body Mensaje de carga. Sí PayloadMessage
Respuestas
Código Descripción Esquema
202 Correcto ServiceResponse
default Respuesta de error ErrorDetail

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

HEAD

Resumen

Comprobar si existe un usuario en el grupo de destino.

Comprobar si existe un usuario en el grupo de destino

HEAD /api/hubs/{hub}/users/{user}/groups/{group}

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
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
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
200 Correcto ServiceResponse
404 No encontrado
default Respuesta de error ErrorDetail

PUT

Resumen

Agregar un usuario al grupo de destino.

Agregar un usuario al grupo de destino

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

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
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
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
ttl Query Especifica los segundos que el usuario existe en el grupo. Si no se establece, el usuario reside en el grupo durante 1 año como máximo. Si un usuario se agrega a algunos grupos sin limitación ttl, solo se reservarán los 100 grupos actualizados más recientes entre todos los grupos que se han unido al usuario sin TTL. Si ttl = 0, solo se agregarán las conexiones conectadas actuales del usuario de destino al grupo de destino. No integer
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
200 Correcto ServiceResponse
default Respuesta de error ErrorDetail

DELETE

Resumen

Quitar un usuario del grupo de destino.

Quitar un usuario del grupo de destino

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

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
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
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
204 Correcto
default Respuesta de error ErrorDetail

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

DELETE

Resumen

Quitar un usuario de todos los grupos.

Eliminación de un usuario de todos los grupos

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

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
usuario path Id. del usuario de destino Sí cadena
application Query El nombre de la aplicación de destino, que debe comenzar con caracteres alfabéticos y solo contener caracteres alfanuméricos o caracteres de subrayado. No cadena
api-version Query Versión de las API REST. Sí cadena
Respuestas
Código Descripción Esquema
204 Correcto
default Respuesta de error ErrorDetail

Models

ErrorDetail

Objeto de error.

Nombre Tipo Descripción Obligatorio
code cadena Uno de un conjunto definido por el servidor de códigos de error. No
message cadena Representación legible del error. No
Destino cadena El destino del error. No
detalles [ ErrorDetail ] Matriz de detalles sobre errores específicos que llevaron a este error notificado. No
inner InnerError No

InnerError

Nombre Tipo Descripción Obligatorio
code cadena Código de error más específico del proporcionado por el error contenedor. No
inner InnerError No

PayloadMessage

Nombre Tipo Descripción Obligatorio
Destino cadena Sí
argumentos [ ] No

ServiceResponse

Nombre Tipo Descripción Obligatorio
code string No
Nivel cadena Enum:"Info", , "Warning""Error" No
scope cadena Enum:"Unknown", , "Connection""Request", , , "User""Group" No
errorKind cadena Enum:"Unknown", , "NotExisted", "NotInGroup", "Invalid" No
message cadena No
jsonObject No
isSuccess boolean No