POST

/v1/send-alexa-offer-to-master

http://kinesisvideo.{region}.amazonaws.com/v1/send-alexa-offer-to-master

This API allows you to connect WebRTC-enabled devices with Alexa display devices. When invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer. The offer is delivered as soon as the master is connected to the specified signaling channel. This API returns the SDP answer from the connected master. If the master is not connected to the signaling channel, redelivery requests are made until the message expires.

Access Token Required: API Key

Body Params

ChannelARNstringrequired

The ARN of the signaling channel by which Alexa and the master peer communicate.

MessagePayloadstringrequired

The base64-encoded SDP offer content.

SenderClientIdstringrequired

The unique identifier for the sender client.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://kinesisvideo.{region}.amazonaws.com/v1/send-alexa-offer-to-master' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}