Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
SendAlexaOfferToMaster
Note
Avant d'utiliser cette API, vous devez appeler l'GetSignalingChannelEndpointAPI pour obtenir un point de terminaison. Vous spécifiez ensuite le point de terminaison et la région dans votre demande d'SendAlexaOfferToMasterAPI.
Cette API vous permet de connecter des appareils compatibles WebRTC à des appareils d'affichage Alexa. Lorsqu'il est invoqué, il envoie l'offre du protocole de description de session Alexa (SDP) à l'homologue principal. L'offre est délivrée dès que le master est connecté au canal de signalisation spécifié. Cette API renvoie la réponse SDP du maître connecté. Si le maître n'est pas connecté au canal de signalisation, les demandes de retransmission sont effectuées jusqu'à l'expiration du message.
Syntaxe de la demande
POST /v1/send-alexa-offer-to-master HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"MessagePayload": "string",
"SenderClientId": "string"
}Paramètres de demande URI
La demande n'utilise pas de paramètres URI.
Corps de la demande
Cette demande accepte les données suivantes au format JSON.
- ChannelARN
-
Le nom de ressource Amazon (ARN) du canal de signalisation par lequel Alexa et le pair principal communiquent.
Type : String
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.
Modèle :
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+Obligatoire : oui
- MessagePayload
-
Le contenu de l'offre SDP codé en base64.
Type : String
Contraintes de longueur : Longueur minimum de 1. Longueur maximale de 10 000.
Modèle :
[a-zA-Z0-9+/=]+Obligatoire : oui
- SenderClientId
-
Identifiant unique du client expéditeur.
Type : String
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 256.
Modèle :
[a-zA-Z0-9_.-]+Obligatoire : oui
Syntaxe de la réponse
HTTP/1.1 200
Content-type: application/json
{
"Answer": "string"
}Eléments de réponse
Si l'action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
- Answer
-
Le contenu de la réponse SDP codé en base64.
Type : String
Contraintes de longueur : Longueur minimum de 1. Longueur maximale de 10 000.
Erreurs
Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.
- ClientLimitExceededException
-
Votre demande a été limitée car vous avez dépassé la limite d'appels clients autorisés. Essayez de passer l'appel plus tard.
Code d'état HTTP : 400
- InvalidArgumentException
-
La valeur de ce paramètre d'entrée n'est pas valide.
Code d'état HTTP : 400
- NotAuthorizedException
-
L'appelant n'est pas autorisé à effectuer cette opération.
Code d'état HTTP : 401
- ResourceNotFoundException
-
La ressource spécifiée est introuvable.
Code d'état HTTP : 404
Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :
