智能语音交互：接口说明

功能介绍

• 支持输出PCM、WAV和MP3编码格式数据。

• 支持设置语速、语调和音量。

• 支持一次性合成300字符以内的文字，其中1个汉字、1个英文字母、1个标点或1个句子中间空格均算作1个字符，超过300个字符的内容将会截断。

• 仅支持采用UTF-8编码的文本输入。

• 如果生僻字发音不准，可使用SSML的<phoneme>标签指定拼音，或替换为同音字。

服务地址

交互流程

1. 鉴权

   客户端与服务端建立WebSocket连接时，使用Token进行鉴权。

2. 开始合成

   客户端发起语音合成请求，在请求消息中进行参数设置，各参数含义如下表所示。

   参数	类型	是否必需	说明
   appkey	String	是	管控台创建的项目Appkey。
   text	String	是	待合成文本，文本内容必须采用UTF-8编码，长度不超过300个字符（英文字母之间需要添加空格）。 说明 只有支持多情感的音色，才能使用<emotion>标签，否则会报错：Illegal ssml text。
   voice	String	否	发音人，默认是xiaoyun。
   format	String	否	音频编码格式，支持.pcm、.wav和.mp3格式。默认值：pcm。
   sample_rate	Integer	否	音频采样率，默认值：16000 Hz。
   volume	Integer	否	音量，取值范围：0～100。默认值：50。
   speech_rate	Integer	否	语速，取值范围：-500～500，默认值：0。 [-500, 0, 500] 对应的语速倍速区间为 [0.5, 1.0, 2.0]。 -500表示默认语速的0.5倍速。 0表示默认语速的1倍速。1倍速是指模型默认输出的合成语速，语速会依据每一个发音人略有不同，大概每秒钟4个字左右。 500表示默认语速的2倍速。 计算方法如下： 0.8倍速（1-1/0.8）/0.002 = -125 1.2倍速（1-1/1.2）/0.001 = 166 说明 小于1倍速时，使用0.002系数。 大于1倍速时，使用0.001系数。 实际算法结果取近似值。
   pitch_rate	Integer	否	语调，取值范围：-500～500，默认值：0。
   enable_subtitle	Boolean	否	开启字级别时间戳。更多使用方法，请参见语音合成时间戳功能介绍。

3. 接收合成数据

   服务端返回合成的语音二进制数据，SDK接收并处理二进制数据。

4. 结束合成

   语音合成完毕，服务端发送合成完毕事件通知，举例如下。

   {
       "header": {
           "message_id": "05450bf69c53413f8d88aed1ee60****",
           "task_id": "640bc797bb684bd6960185651307****",
           "namespace": "SpeechSynthesizer",
           "name": "SynthesisCompleted",
           "status": 20000000,
           "status_message": "GATEWAY|SUCCESS|Success."
       }
   }

   说明

   文档示例将合成的音频保存在文件中，如果您需要播放音频且对实时性要求较高，建议使用流式播放，即边接收语音数据边播放，减少延时。

5. 合成失败处理

   当因为参数或其他原因导致合成任务失败时，会收到任务失败（TaskFailed）通知，举例如下。收到任务失败通知后，对应底层连接将断开。

   {
      "header":{
         "namespace":"Default",
         "name":"TaskFailed",
         "status":41020001,
         "message_id":"62c126f7d9b340deb82b5b7eaca0****",
         "task_id":"4552df26d1f547aab9a2c4a94678****",
         "status_text":"TTS:TtsClientError:[tts]Engine return error code: 418"
      }
   }

音色列表

服务状态码

服务的每一次响应都包含status字段，即服务状态码，各状态码含义如下。

通用错误：

网关错误：

配置错误：

TTS（Text to Speech）错误：