SendAlexaOfferToMaster - Amazon Kinesis Video Streams

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

SendAlexaOfferToMaster

注意

在使用此 API 之前,您必須調用 GetSignalingChannelEndpoint API 以獲取端點。然後,您可以在 SendAlexaOfferToMaster API 請求中指定端點和區域。

此 API 允許您將啟用 WebRTC 的設備與 Alexa 顯示設備連接起來。當調用時,它發送 Alexa 會話描述協議(SDP)提供給主對等。只要主機連線到指定的訊號通道,就會立即傳送選件。此 API 從連接的主服務器返回 SDP 答案。如果主機未連接到信令通道,則會發出重新傳遞請求,直到消息過期為止。

請求語法

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

URI 請求參數

請求不會使用任何 URI 參數。

請求主體

請求接受採用 JSON 格式的下列資料。

ChannelARN

Alexa 和主對等通訊所使用的信號通道的 Amazon 資源名稱 (ARN)。

類型:字串

長度限制:長度下限為 1。長度上限為 1024。

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

必要:是

MessagePayload

由 64 編碼的 SDP 提供內容。

類型:字串

長度限制:長度下限為 1。最大長度為 1 萬。

模式:[a-zA-Z0-9+/=]+

必要:是

SenderClientId

寄件者用戶端的唯一識別碼。

類型:字串

長度限制:長度下限為 1。長度上限為 256。

模式:[a-zA-Z0-9_.-]+

必要:是

回應語法

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

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

Answer

以 64 編碼的 SDP 回答內容。

類型:字串

長度限制:長度下限為 1。最大長度為 1 萬。

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

ClientLimitExceededException

您的請求被限制,因為您已超過允許的用戶端通話限制。稍後再嘗試撥打電話。

HTTP 狀態碼:400

InvalidArgumentException

此輸入參數的值無效。

HTTP 狀態碼:400

NotAuthorizedException

呼叫者沒有執行此操作的授權。

狀態碼:4

ResourceNotFoundException

找不到指定的資源。

HTTP 狀態碼:404

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: