As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
SendAlexaOfferToMaster
nota
Antes de usar essa API, você deve chamar a GetSignalingChannelEndpoint API para obter um endpoint. Em seguida, você especifica o endpoint e a região na sua solicitação de SendAlexaOfferToMaster API.
Essa API permite que você conecte dispositivos habilitados para WebRTC com dispositivos de exibição Alexa. Quando invocado, ele envia a oferta do Alexa Session Description Protocol (SDP) para o peer principal. A oferta é entregue assim que o mestre é conectado ao canal de sinalização especificado. Essa API retorna a resposta SDP do mestre conectado. Se o mestre não estiver conectado ao canal de sinalização, as solicitações de reentrega serão feitas até que a mensagem expire.
Sintaxe da Solicitação
POST /v1/send-alexa-offer-to-master HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"MessagePayload": "string",
"SenderClientId": "string"
}Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
- ChannelARN
-
O Amazon Resource Name (ARN) do canal de sinalização pelo qual a Alexa e o peer principal se comunicam.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.024.
Padrão:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+Exigido: Sim
- MessagePayload
-
O SDP codificado em base64 oferece conteúdo.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 10000.
Padrão:
[a-zA-Z0-9+/=]+Exigido: Sim
- SenderClientId
-
O identificador exclusivo do cliente remetente.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 256.
Padrão:
[a-zA-Z0-9_.-]+Exigido: Sim
Sintaxe da Resposta
HTTP/1.1 200
Content-type: application/json
{
"Answer": "string"
}Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- Answer
-
O conteúdo da resposta SDP codificada em base64.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 10000.
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- ClientLimitExceededException
-
Sua solicitação foi restringida porque você excedeu o limite permitido de chamadas de clientes. Tente fazer a ligação mais tarde.
Código de Status HTTP: 400
- InvalidArgumentException
-
O valor desse parâmetro de entrada é inválido.
Código de Status HTTP: 400
- NotAuthorizedException
-
O chamador não está autorizado a realizar essa operação.
Código de status HTTP: 401
- ResourceNotFoundException
-
O recurso especificado não foi encontrado.
Código de Status HTTP: 404
Consulte Também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:
