SendAlexaOfferToMaster - Amazon Kinesis Video Streams
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

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 和主对等体通信的信令通道的亚马逊资源名称 (ARN)。

类型:字符串

长度限制:长度下限为 1。长度上限为 1024。

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

必需:是

MessagePayload

base64 编码的 SDP 提供内容。

类型:字符串

长度限制:长度下限为 1。最大长度为 10000。

模式:[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

base64 编码的 SDP 答案内容。

类型:字符串

长度限制:长度下限为 1。最大长度为 10000。

错误

有关所有操作的常见错误信息,请参阅常见错误

ClientLimitExceededException

您的请求已被限制,因为您已超出允许的客户端呼叫上限。稍后再尝试拨打电话。

HTTP 状态代码:400

InvalidArgumentException

此输入参数的值无效。

HTTP 状态代码:400

NotAuthorizedException

呼叫者无权执行此操作。

HTTP 状态代码:401

ResourceNotFoundException

未找到指定的资源。

HTTP 状态代码:404

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: