调用该接口下发动态播报内容到设备进行播报。

QPS限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SpeechBySynthesis

系统规定参数。取值:SpeechBySynthesis。

AudioFormat String wav

音频格式,仅支持wavmp3amr格式。

Text String test

语料文本,当语料类型选择为自定义语料时,该参数必选。语料文本支持英文字母、汉字和空格,长度为1~100个字符,一个汉字占两个字符。

Voice String Siyue

语料播报声音,由系统预设,例如标准女声、标准男声等。可以选择的声音类型通过GetSpeechVoice进行查询,填入返回参数中VoiceListValue的值。

IotId String Q7uOhVRdZRRlDnTLv****00100

设备ID,该参数可以通过调用QuerySpeechDevice获取。

说明 如果传入该参数,则无需传入ProductKeyDeviceNameIotId作为设备唯一标识符,和ProductKeyDeviceName组合是一一对应的关系。如果您同时传入IotIdProductKeyDeviceName组合,则以IotId为准。
SpeechRate Integer 0

播报速度,取值范围:-500~500。

ProductKey String a1BwAGV****

设备所属的产品ProductKey。如果传入该参数,需同时传入DeviceName

DeviceName String test

设备的DeviceName

如果传入该参数,需同时传入ProductKey

SpeechId String 42000011392021112380********

下发给设备的唯一播报ID。

注意

若不传入则由系统生成,若业务上进行重试播报,需传入重试的播报ID,避免出现重复业务播报。

Volume Integer 50

音量大小,取值范围:0~100。

IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

注意
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无ID值,则无需传入。

实例的更多信息,请参见如何获取实例ID

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见错误码

ErrorMessage String An internal error occurred. Try again later.

调用失败时,返回的错误信息。

RequestId String 671D0F8F-FDC7-4B12-93FA-336C079C965A

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=SpeechBySynthesis
&AudioFormat=wav
&Text=test
&Voice=Siyue
&<公共请求参数>

正常返回示例

XML格式

<SpeechBySynthesisResponse>
  <RequestId>671D0F8F-FDC7-4B12-93FA-336C079C965A</RequestId>
  <Success>true</Success>
</SpeechBySynthesisResponse>

JSON格式

{
    "RequestId": "671D0F8F-FDC7-4B12-93FA-336C079C965A",
    "Success": "true"
}