Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
SendAlexaOfferToMaster
Nota
Prima di utilizzare questa API, è necessario richiamarla per ottenere un endpoint.GetSignalingChannelEndpoint
Quindi specifichi l'endpoint e la regione nella tua richiestaSendAlexaOfferToMaster
API.
Questa API consente di connettere dispositivi compatibili con WebRTC con dispositivi di visualizzazione Alexa. Quando viene richiamato, invia l'offerta Alexa Session Description Protocol (SDP) al peer master. L'offerta viene consegnata non appena il master è collegato al canale di segnalazione specificato. Questa API restituisce la risposta SDP dal master connesso. Se il master non è connesso al canale di segnalazione, le richieste di riconsegna vengono effettuate fino alla scadenza del messaggio.
Sintassi della richiesta
POST /v1/send-alexa-offer-to-master HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string
",
"MessagePayload": "string
",
"SenderClientId": "string
"
}
Parametri della richiesta URI:
La richiesta non utilizza parametri URI.
Corpo della richiesta
La richiesta accetta i seguenti dati in formato JSON.
- ChannelARN
-
Il nome della risorsa Amazon (ARN) del canale di segnalazione tramite cui comunicano Alexa e il peer master.
Tipo: String
Limitazioni di lunghezza: lunghezza minima di 1. La lunghezza massima è 1024 caratteri.
Pattern:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
Campo obbligatorio: sì
- MessagePayload
-
L'SDP con codifica base64 offre contenuti.
Tipo: String
Limitazioni di lunghezza: lunghezza minima di 1. La lunghezza massima è 10000
Pattern:
[a-zA-Z0-9+/=]+
Campo obbligatorio: sì
- SenderClientId
-
L'identificatore univoco del client mittente.
Tipo: String
Limitazioni di lunghezza: lunghezza minima di 1. La lunghezza massima è 256 caratteri.
Pattern:
[a-zA-Z0-9_.-]+
Campo obbligatorio: sì
Sintassi della risposta
HTTP/1.1 200
Content-type: application/json
{
"Answer": "string"
}
Elementi di risposta
Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.
I dati seguenti vengono restituiti in formato JSON mediante il servizio.
- Answer
-
Il contenuto della risposta SDP codificata con base64.
Tipo: String
Limitazioni di lunghezza: lunghezza minima di 1. La lunghezza massima è 10000
Errori
Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.
- ClientLimitExceededException
-
La tua richiesta è stata limitata perché hai superato il limite di chiamate client consentite. Prova a effettuare la chiamata più tardi.
Codice di stato HTTP: 400
- InvalidArgumentException
-
Il valore per questo parametro di input non è valido.
Codice di stato HTTP: 400
- NotAuthorizedException
-
Il chiamante non è autorizzato a eseguire questa operazione.
Codice di stato HTTP: 401
- ResourceNotFoundException
-
La risorsa specificata non è stata trovata.
Codice di stato HTTP: 404
Vedi anche
Per ulteriori informazioni sull'utilizzo di questa API in uno degli SDK AWS specifici della lingua, consulta quanto segue: