调用该接口同步组合播报设备中的语料。

QPS限制

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

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

调试

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

请求参数

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

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

CombinationList.N RepeatList ZFBDZ

组合播报内容,包括以下类型:

  • 播报已成功推送至设备中的语料,填入语料的标识。
  • 播报支持的动态内容,根据设备支持的具体规则传入。

    示例:金额,格式为{$xxx},xxx为具体的金额数,如{$1000},则设备播报1000元

    设备根据下发的CombinationList进行顺序播报。

IotId String Q7uOhVRdZRRlDnTLv****00100

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

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

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

DeviceName String test

设备的DeviceName

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

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

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

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

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

AudioFormat String wav

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

SpeechId String 42000011392021112380********

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

注意

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

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

返回数据

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

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

Data Struct

返回的结果。

Detail String Bat_Pt:99 RSSI: -92

设备播报详情。

DeviceErrorCode String 1

设备播报返回错误码。

DeviceErrorMessage String speech model not found

设备播报返回错误信息。

Id String 42000011392021112380********

下发给设备的唯一播报ID,即请求的参数SpeechId,若不传入则由系统生成。

MaxRetryCount Integer 2

最多重试次数。

RetryCount Integer 1

重试次数。

Success Boolean true

播报是否成功。

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=SyncSpeechByCombination
&CombinationList.1=ZFBDZ
&<公共请求参数>

正常返回示例

XML格式

<SyncSpeechByCombinationResponse>
  <RequestId>671D0F8F-FDC7-4B12-93FA-336C079C965A</RequestId>
  <Data>
        <MaxRetryCount>2</MaxRetryCount>
        <RetryCount>0</RetryCount>
        <Id>42000011392021112380********</Id>
        <Detail>Bat_Pt:99 RSSI: -92</Detail>
        <Success>true</Success>
  </Data>
  <Success>true</Success>
</SyncSpeechByCombinationResponse>

JSON格式

{
    "SyncSpeechByCombinationResponse": {
        "RequestId": "671D0F8F-FDC7-4B12-93FA-336C079C965A",
        "Data": {
            "MaxRetryCount": 2,
            "RetryCount": 0,
            "Id": "42000011392021112380********",
            "Detail": "Bat_Pt:99 RSSI: -92",
            "Success": true
        },
        "Success": true
    }
}