# Amazon Kinesis Video Signaling Channels The following actions are supported by Amazon Kinesis Video Signaling Channels: + [GetIceServerConfig](API_signaling_GetIceServerConfig.md) + [SendAlexaOfferToMaster](API_signaling_SendAlexaOfferToMaster.md) # GetIceServerConfig **Note:** Before using this API, you must call the `GetSignalingChannelEndpoint` API to request the HTTPS endpoint. You then specify the endpoint and region in your `GetIceServerConfig` API request. Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, user name, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to set up the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server. TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see [A REST API For Access To TURN Services](https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00). You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify the Amazon Resource Name (ARN) of your signaling channel in order to invoke this API. ## Request Syntax ``` POST /v1/get-ice-server-config HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "ClientId": "string", "Service": "string", "Username": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ChannelARN](#API_signaling_GetIceServerConfig_RequestSyntax) ** The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: Yes ** [ClientId](#API_signaling_GetIceServerConfig_RequestSyntax) ** Unique identifier for the viewer. Must be unique within the signaling channel. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ** [Service](#API_signaling_GetIceServerConfig_RequestSyntax) ** Specifies the desired service. Currently, `TURN` is the only valid value. Type: String Valid Values: `TURN` Required: No ** [Username](#API_signaling_GetIceServerConfig_RequestSyntax) ** An optional user ID to be associated with the credentials. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "IceServerList": [ { "Password": "string", "Ttl": number, "Uris": [ "string" ], "Username": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [IceServerList](#API_signaling_GetIceServerConfig_ResponseSyntax) ** The list of ICE server information objects. Type: Array of [IceServer](API_signaling_IceServer.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Your request was throttled because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** InvalidClientException ** The specified client is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ** ResourceNotFoundException ** The specified resource is not found. HTTP Status Code: 404 ** SessionExpiredException ** If the client session is expired. Once the client is connected, the session is valid for 45 minutes. Client should reconnect to the channel to continue sending/receiving messages. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-signaling-2019-12-04/GetIceServerConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-signaling-2019-12-04/GetIceServerConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-signaling-2019-12-04/GetIceServerConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-signaling-2019-12-04/GetIceServerConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-signaling-2019-12-04/GetIceServerConfig) # SendAlexaOfferToMaster **Note** Before using this API, you must call the `GetSignalingChannelEndpoint` API to get an endpoint. You then specify the endpoint and region in your `SendAlexaOfferToMaster` API request. 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. ## Request Syntax ``` POST /v1/send-alexa-offer-to-master HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "MessagePayload": "string", "SenderClientId": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ChannelARN](#API_signaling_SendAlexaOfferToMaster_RequestSyntax) ** The Amazon Resource Name (ARN) of the signaling channel by which Alexa and the master peer communicate. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+` Required: Yes ** [MessagePayload](#API_signaling_SendAlexaOfferToMaster_RequestSyntax) ** The base64-encoded SDP offer content. Type: String Length Constraints: Minimum length of 1. Maximum length of 10000. Pattern: `[a-zA-Z0-9+/=]+` Required: Yes ** [SenderClientId](#API_signaling_SendAlexaOfferToMaster_RequestSyntax) ** The unique identifier for the sender client. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9_.-]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Answer": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Answer](#API_signaling_SendAlexaOfferToMaster_ResponseSyntax) ** The base64-encoded SDP answer content. Type: String Length Constraints: Minimum length of 1. Maximum length of 10000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClientLimitExceededException ** Your request was throttled because you have exceeded the limit of allowed client calls. Try making the call later. HTTP Status Code: 400 ** InvalidArgumentException ** The value for this input parameter is invalid. HTTP Status Code: 400 ** NotAuthorizedException ** The caller is not authorized to perform this operation. HTTP Status Code: 401 ** ResourceNotFoundException ** The specified resource is not found. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-signaling-2019-12-04/SendAlexaOfferToMaster)