Establecimiento de la conexión

Después de recuperar un punto de conexión, utiliza la API de conexión para establecer una conexión WebSocket con el servidor back-end de Amazon Chime SDK y recibir mensajes para un AppInstanceUser. Debe usar la versión 4 de firma de AWS para firmar solicitudes. Para más información sobre la firma de una solicitud, consulte Firma de solicitudes de AWS con la versión 4 de la firma.

nota

Para recuperar el punto de conexión, puede invocar la API GetMessagingSessionEndpoint. Puede usar la biblioteca cliente de WebSocket que prefiera para conectarse al punto de conexión.

Sintaxis de la solicitud

GET /connect
?X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIARALLEXAMPLE%2F20201214%2Fregion%2Fchime%2Faws4_request
&X-Amz-Date=20201214T171359Z
&X-Amz-Expires=10
&X-Amz-SignedHeaders=host
&sessionId={sessionId}
&userArn={appInstanceUserArn}
&X-Amz-Signature=db75397d79583EXAMPLE

Parámetros de solicitud del URI

Todos los parámetros de consulta de solicitud de URI deben estar codificados en URL.

X-Amz-Algorithm

Identifica la versión de la firma de AWS y el algoritmo que utilizó para calcular la firma. Amazon Chime SDK solo admite la autenticación con la versión 4 de firma de AWS, por lo que su valor es AWS4-HMAC-SHA256.

X-Amz-Credential

Además del ID de clave de acceso, este parámetro también proporciona la región de AWS y el servicio, el alcance para el que es válida la firma. Este valor debe coincidir con el ámbito que utilice en los cálculos de la firma. La forma general para el valor de este parámetro es la siguiente:

<yourAccessKeyId>/<date>/<awsRegion>/<awsService >/aws4_request

Por ejemplo:

AKIAIOSFODNN7EXAMPLE/20201214/us-east-1/chime/aws4_request

X-Amz-Date

El formato de fecha y hora debe seguir la norma ISO 8601, y tener el formato yyyyMMddTHHmmssZ. Por ejemplo, debe convertir 08/01/2020 15:32:41.982-700 a la hora universal coordinada (UTC) y enviarla como 20200801T083241Z.

X-Amz-Signed-Headers

Muestra los encabezados que utilizó para calcular la firma. Los siguientes encabezados son obligatorios para los cálculos de firmas:

• El encabezado del host HTTP.

• Cualquier encabezado x-amz-* que planee agregar a la solicitud.

nota

Para mayor seguridad, debe firmar todos los encabezados de solicitud que planea incluir en su solicitud.

X-Amz-Signatures

Proporciona la firma para autenticar la solicitud. Esta firma debe coincidir con la firma que calcula Amazon Chime SDK. Si no lo hace, Amazon Chime SDK deniega la solicitud. Por ejemplo, 733255ef022bec3f2a8701cd61d4b371f3f28c9f19EXAMPLEd48d5193d7.

X-Amz-Security-Token

Parámetro de credenciales opcional si se utilizan credenciales procedentes del servicio de token de seguridad. Para obtener más información sobre el servicio, consulte https://docs.aws.amazon.com/STS/latest/APIReference/.

SessionId

Indica un identificador único para la conexión WebSocket que se está estableciendo.

UserArn

Indica la identidad del AppInstanceUser que intenta establecer una conexión. El valor debe ser el ARN de AppInstanceUser. Por ejemplo, arn:aws:chime:us%2Deast%2D1:123456789012:app%2Dinstance/694d2099%2Dcb1e%2D463e%2D9d64%2D697ff5b8950e/user/johndoe.