调用该接口创建语料。

调试

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

请求参数

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

系统规定参数,取值:CreateSpeech。

ProjectCode String Md3ZiTL888K9llXDy7890***********

项目ID,是项目的唯一标识,您可以通过项目管理控制台获取项目ID。如果没有项目,可以创建项目后获取项目ID。

Voice String Xiaoyun

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

SpeechType String custom

语料类型,分为自定义语料和常用语料。

说明 该参数为非必选参数,当这个参数不填时,默认为自定义语料,必须要填语料标识和语料文本两个参数,否则调用会失败。
  • 自定义语料:取值为custom,是自定义语料时,必须填写语料标识和语料文本。
  • 常用语料:由系统预置的常用语料文本,包括以下类型:
    • 数字:取值为number,包含:数字0~9,点,幺。
    • 量词:取值为measure_word,包含:个,十,百,千,万,十万,百万,亿等。
    • 货币单位:取值为monetary_unit,包含:分,角,元等。
    • 时间单位:取值为time_unit,包含:时,分,秒,月,日,年等。
    • 单位时间:取值为unit_time,包含:每秒,每分,每小时,每天,每周,每月,每年等。
    • 长度单位:取值为length_unit,包含:毫米,厘米,分米,米,千米,公里,英寸,英尺,英里等。
IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。

必须传入实例ID,否则调用会失败。您可在物联网平台控制台的实例概览页面,查看您的实例ID。

注意

如果公共实例没有ID,请参见如何获取实例ID

BizCode String identifying

语料标识,当设备调用多个语料进行组合播报时,通过该标识播报指定的语料。

  • 语料类型选择为自定义语料时,该参数必选。语料标识由用户自定义,支持英文字母和数字,长度为1~32个字符,项目下保证唯一。建议将语料语义的拼音首字母设置为语料标识,例如:支付到账设置为ZFDZ
  • 语料类型选择为常用语料时,语料标识由系统自动生成,无需用户自定义。
SpeechRate Integer 0

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

Volume Integer 50

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

Text String test

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

AudioFormat String wav

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

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

返回数据

名称 类型 示例值 描述
Code String iot.speechsolution.NotSigned

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

Data String Md3ZiTL888K9llXDy7890***********

创建成功时返回的语料ID(SpeechCode),是语料的唯一标识。

ErrorMessage String speech solution has not been signed

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

RequestId String 66FF51D3-***-49F1-B1A2-***

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

Success Boolean true

是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateSpeech
&ProjectCode=Md3ZiTL888K9llXDy7890***********
&Voice=Xiaoyun
&<公共请求参数>

正常返回示例

XML格式

<CreateSpeechResponse>
  <RequestId>66FF51D3-***-49F1-B1A2-***</RequestId>
  <Data>Md3ZiTL888K9llXDy7890***********</Data>
  <Success>true</Success>
</CreateSpeechResponse>

JSON格式

{
    "RequestId": "66FF51D3-***-49F1-B1A2-***",
    "Data": "Md3ZiTL888K9llXDy7890***********",
    "Success": true
}