翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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 です。最大長は 1,024 です。
Pattern:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+必須：はい
- MessagePayload
-
base64 エンコード後の SDP オファー内容。
型: 文字列
長さの制限：最小長は 1 です。最大長は 10,000 です。
Pattern:
[a-zA-Z0-9+/=]+必須：はい
- SenderClientId
-
セッションクライアントの一意の識別子 (ID)。
型: 文字列
長さの制限：最小長は 1 です。最大長は 256 です。
パターン：
[a-zA-Z0-9_.-]+必須：はい
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"Answer": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- Answer
-
base64 エンコード後の SDP 回答の内容。
型: 文字列
長さの制限：最小長は 1 です。最大長は 10,000 です。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- ClientLimitExceededException
-
許可されたクライアントコールの制限を超えているため、リクエストが調整されました。後で呼び出しを試みてください。
HTTP ステータスコード：400
- InvalidArgumentException
-
この入力パラメータの値は無効です。
HTTP ステータスコード：400
- NotAuthorizedException
-
呼び出し元には、この操作を実行するための権限がありません。
HTTP ステータスコード: 401
- ResourceNotFoundException
-
指定したリソースは見つかりませんでした。
HTTP ステータスコード: 404
その他の参照資料
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
