更新时间:2025-08-26 GMT+08:00

设置TTS租户级自定义读法配置

功能介绍

该接口用于设置TTS租户级自定义读法配置。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/ttsc/vocabulary-configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Request-Id

String

请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用uuId,若不携带,则后台自动生成

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息。

X-App-UserId

String

第三方用户ID。不允许输入中文。

表3 请求Body参数

参数

是否必选

参数类型

描述

type

String

支持配置的自定义读法类型。当前读法类型会映射为SSML标签,详见文本驱动SSML定义

包含如下选项:

  • CHINESE_G2P:拼音

  • PHONETIC_SYMBOL:音标

  • CONTINUUM:连读

  • ALIAS:别名

  • SAY_AS:数字/英文的读法。不同value值有不同的读法,详情如下所示。

    • date:读日期

    • number:读数字

    • figure:读数值

    • telephone:读电话

    英文的读法包括:

    • spell:读字母

    • english:读单词

数字的读法包括:

key

String

原始词。

默认取值:

不涉及

value

String

自定义读法。其中,音标的读法请参考词典

默认取值:

不涉及

group_id

String

分组id

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

配置项id。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

业务返回码

  • MSS.000000001 - 失败

  • MSS.000000002 - 内部错误

  • MSS.000000003 - 非法参数

  • MSS.000000004 - 非法访问,未鉴权或者鉴权失败

error_msg

String

返回描述

request_id

String

请求唯一标识

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

业务返回码

  • MSS.000000001 - 失败

  • MSS.000000002 - 内部错误

  • MSS.000000003 - 非法参数

  • MSS.000000004 - 非法访问,未鉴权或者鉴权失败

error_msg

String

返回描述

request_id

String

请求唯一标识

请求示例

  • 设置拼音读法

    POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs
    
    {
      "type" : "CHINESE_G2P",
      "key" : "同行",
      "value" : "tong2 xing2"
    }
  • 设置音标读法

    POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs
    
    {
      "type" : "PHONETIC_SYMBOL",
      "key" : "China",
      "value" : "ˈtʃaɪn(ə)"
    }
  • 设置连读

    POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs
    
    {
      "type" : "CONTINUUM",
      "key" : "数字人"
    }
  • 设置别名

    POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs
    
    {
      "type" : "ALIAS",
      "key" : "中国",
      "value" : "东方大国"
    }
  • 设置字母读法

    POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs
    
    {
      "type" : "SAY_AS",
      "key" : "API",
      "value" : "spell"
    }
  • 设置单词读法

    POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs
    
    {
      "type" : "SAY_AS",
      "key" : "API",
      "value" : "english"
    }
  • 设置数字读法

    POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs
    
    {
      "type" : "SAY_AS",
      "key" : 12345,
      "value" : "number"
    }
  • 设置数值读法

    POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs
    
    {
      "type" : "SAY_AS",
      "key" : 12345,
      "value" : "figure"
    }
  • 设置电话读法

    POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs
    
    {
      "type" : "SAY_AS",
      "key" : 13677642313,
      "value" : "telephone"
    }
  • 设置日期读法

    POST https://{endpoint}/v1/3f0924078d1b471c884a5383d4dec9fa/ttsc/vocabulary-configs
    
    {
      "type" : "SAY_AS",
      "key" : "2024-10-24",
      "value" : "date"
    }

响应示例

状态码:200

处理成功。

{
  "id" : "efc5300ecdba4ea48d1ff13a9d907bc0"
}

状态码

状态码

描述

200

处理成功。

400

参数异常

500

服务端异常

错误码

请参见错误码