Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
SendAlexaOfferToMaster
nota
Antes de usar esta API, debe llamar a la GetSignalingChannelEndpoint
API para obtener un punto final. A continuación, especificas el punto final y la región en tu solicitud de SendAlexaOfferToMaster
API.
Esta API le permite conectar dispositivos habilitados para WebRTC con dispositivos de pantalla Alexa. Cuando se invoca, envía la oferta del Protocolo de descripción de sesiones (SDP) de Alexa al par maestro. La oferta se entrega tan pronto como el maestro se conecta al canal de señalización especificado. Esta API devuelve la respuesta SDP del maestro conectado. Si el maestro no está conectado al canal de señalización, las solicitudes de reenvío se realizan hasta que caduque el mensaje.
Sintaxis de la solicitud
POST /v1/send-alexa-offer-to-master HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string
",
"MessagePayload": "string
",
"SenderClientId": "string
"
}
Parámetros de solicitud del URI
La solicitud no utiliza ningún parámetro de URI.
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- ChannelARN
-
El nombre de recurso de Amazon (ARN) del canal de señalización mediante el cual se comunican Alexa y el par maestro.
Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1024 caracteres.
Patrón:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
Obligatorio: sí
- MessagePayload
-
El SDP codificado en base64 ofrece contenido.
Tipo: string
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 10000.
Patrón:
[a-zA-Z0-9+/=]+
Obligatorio: sí
- SenderClientId
-
El identificador único del cliente remitente.
Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Patrón:
[a-zA-Z0-9_.-]+
Obligatorio: sí
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"Answer": "string"
}
Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- Answer
-
El contenido de la respuesta SDP codificado en base64.
Tipo: string
Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 10000.
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- ClientLimitExceededException
-
Tu solicitud se ha retrasado porque has superado el límite de llamadas de clientes permitidas. Intenta hacer la llamada más tarde.
Código de estado HTTP: 400
- InvalidArgumentException
-
El valor de este parámetro de entrada no es válido.
Código de estado HTTP: 400
- NotAuthorizedException
-
La persona que llama no está autorizada a realizar esta operación.
Código de estado HTTP: 401
- ResourceNotFoundException
-
No se encuentra el recurso especificado.
Código de estado HTTP: 404
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: