SendAlexaOfferToMaster - Amazon Kinesis Video Streams

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

SendAlexaOfferToMaster

Anmerkung

Bevor Sie diese API verwenden, müssen Sie die GetSignalingChannelEndpoint API aufrufen, um einen Endpunkt zu erhalten. Anschließend geben Sie den Endpunkt und die Region in Ihrer SendAlexaOfferToMaster API-Anfrage an.

Diese API ermöglicht es Ihnen, WebRTC-fähige Geräte mit Alexa-Anzeigegeräten zu verbinden. Wenn sie aufgerufen wird, sendet sie das SDP-Angebot (Alexa Session Description Protocol) an den Master-Peer. Das Angebot wird zugestellt, sobald der Master mit dem angegebenen Signalkanal verbunden ist. Diese API gibt die SDP-Antwort vom verbundenen Master zurück. Wenn der Master nicht mit dem Signalkanal verbunden ist, werden Anfragen zur erneuten Zustellung gestellt, bis die Nachricht abläuft.

Anforderungssyntax

POST /v1/send-alexa-offer-to-master HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "MessagePayload": "string", "SenderClientId": "string" }

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ChannelARN

Der Amazon-Ressourcenname (ARN) des Signalkanals, über den Alexa und der Master-Peer kommunizieren.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 1024 Zeichen.

Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

Erforderlich: Ja

MessagePayload

Das Base64-kodierte SDP bietet Inhalte.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 10000.

Pattern: [a-zA-Z0-9+/=]+

Erforderlich: Ja

SenderClientId

Die eindeutige Kennung für den Absender-Client.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.

Pattern: [a-zA-Z0-9_.-]+

Erforderlich: Ja

Antwortsyntax

HTTP/1.1 200 Content-type: application/json { "Answer": "string" }

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

Answer

Der Base64-kodierte SDP-Antwortinhalt.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 10000.

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

ClientLimitExceededException

Ihre Anfrage wurde gedrosselt, weil Sie das Limit der erlaubten Client-Aufrufe überschritten haben. Versuchen Sie später, den Anruf zu tätigen.

HTTP Status Code: 400

InvalidArgumentException

Der Wert für diesen Eingabeparameter ist ungültig.

HTTP Status Code: 400

NotAuthorizedException

Der Anrufer ist nicht autorisiert, diesen Vorgang auszuführen.

HTTP-Statuscode: 401

ResourceNotFoundException

Die angegebene Ressource wurde nicht gefunden.

HTTP Status Code: 404

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: