超拟人语音合成

# 超拟人语音合成V3

## 一、接入须知
1. 开通授权举例
```text
appid: 1234567
channel: uts
function: 
chars.total 加10000 字符
vcn.x4_lingxiaoyue_oral
```

## 二、接口文档

### 1. 请求示例
(正式) 调用地址
```text
ws(s)://cbm01.cn-huabei-1.xf-yun.com/v1/private/mcd9m97e6
```
> Note:  
> 1. 正式调用地址包含通过测试已上架二级商用能力的vcn，可以进行商用。  
> 2. 为现网服务，不可进行压测。  
> 3. 鉴权参考, [接口鉴权](https://aidocs.xfyun.cn/docs/public/aipaas.html)

- 请求体示例
```json
{
    "header": {
        "app_id": "123456",
        "res_id": "xxxxx",
        "uid":"user_id",
        "status": 2,
    },
    "parameter": {
        "oral": {
            "oral_level":"mid"
        },
        "tts": {
            "vcn": "x4_lingfeiyi_oral",
            "speed": 50,
            "volume": 50,
            "pitch": 50,
            "bgs": 0,
            "reg": 0,
            "rdn": 0,
            "rhy": 0,
            "scn": 0,
            "version": 0,
            "L5SilLen": 0,
            "ParagraphSilLen": 0,
            "audio": {
                "encoding": "lame",
                "sample_rate": 16000,
                "channels": 1,
                "bit_depth": 16,
                "frame_size": 0
            },
            "pybuf": {
                "encoding": "utf8",
                "compress": "raw",
                "format": "plain"
            }
        }
    },
    "payload": {
        "text": {
            "encoding": "utf8",
            "compress": "raw",
            "format": "plain",
            "status": 2,
            "seq": 0,
            "text": "xxxxxxx"
        }
    }
}
```

**协议结构说明**

| 字段                | 含义       | 类型   | 说明                                          | 是否必传 |
| ------------------- | ---------- | ------ | --------------------------------------------- | -------- |
| header              | 协议头部   | Object | 协议头部，用于描述平台特性的参数              | 是       |
| parameter           | 能力参数   | Object | AI 能力功能参数，用于控制 AI 引擎特性的开关。 | 是       |
| parameter.oral      | 服务别名   | Object | oral能力功能参数                              | 是       |
| parameter.tts       | 服务别名   | Object | tts能力功能参数                               | 是       |
| parameter.tts.audio | 期望输出   | Object | 期望输出                                      | 是       |
| payload             | 输入数据段 | Object | 数据段，携带请求的数据。                      | 是       |
| payload.text        | 输入数据   | Object | 待合成文本                                    | 是       |

**平台参数**

| 字段        | 含义                                                      | 类型   | 限制                    | 是否必传 |
| ----------- | --------------------------------------------------------- | ------ | ----------------------- | -------- |
| app\_id     | 在平台申请的app id信息                                    | string | "maxLength":50          | 是       |
| uid         | 请求用户服务返回的uid，用户及设备级别个性化功能依赖此参数 | string | "maxLength":50          | 否       |
| did         | 请求方确保唯一的设备标志，设备级别个性化功能依赖此参数    | string | "maxLength":50          | 否       |
| imei        | 设备imei信息                                              | string | "maxLength":50          | 否       |
| imsi        | 设备imsi信息                                              | string | "maxLength":50          | 否       |
| mac         | 设备mac信息                                               | string | "maxLength":50          | 否       |
| net\_type   | 网络类型，可选值为wifi、2G、3G、4G、5G                    | string | wifi、2G、3G、4G、5G    | 否       |
| net\_isp    | 运营商信息，可选值为CMCC、CUCC、CTCC、other               | string | CMCC、CUCC、CTCC、other | 否       |
| request\_id | 客户端请求的会话唯一标识                                  | string | "maxLength":64          | 否       |
| **res\_id** | 个性化资源ID（**使用声音复刻TTS，vcn=x5_clone时必传**）   | string | "maxLength":1024        | 否*      |
| status      | 请求状态，可选值为：0:开始, 1:开始, 2:结束                | int    | 0,1,2                   | 是       |

**功能参数 oral**

| 功能标识     | 功能描述                 | 数据类型 | 取值范围                | 必填 | 默认值 |
| ------------ | ------------------------ | -------- | ----------------------- | ---- | ------ |
| oral_level   | 口语化等级               | string   | 高:high, 中:mid, 低:low | 否   | mid    |
| spark_assist | 是否通过大模型进行口语化 | int      | 开启:1, 关闭:0          | 否   | 1      |
| stop_split   | 关闭服务端拆句           | int      | 0:不关闭, 1:关闭        | 否   | 0      |
| scenarized   | 是否开启场景化合成       | int      | 开启:1, 关闭:0          | 否   | 0      |
> **note: 开启场景化合成后，如匹配到适配场景，用户传入的$.parameter.tts.vcn参数失效**

**功能参数 tts**

| 功能标识        | 功能描述                                              | 数据类型 | 取值范围                                                                                                                                                                                                                      | 必填 | 默认值 |
| :-------------- | :---------------------------------------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--- | :----- |
| vcn             | 发音人                                                | string   | 详见 "发言人vcn列表"                                                                                                                                                                                                          | 是   |        |
| speed           | 语速：0对应默认语速的1/2，100对应默认语速的2倍        | int      | 最小值:0, 最大值:100                                                                                                                                                                                                          | 否   | 50     |
| volume          | 音量：0是静音，1对应默认音量1/2，100对应默认音量的2倍 | int      | 最小值:0, 最大值:100                                                                                                                                                                                                          | 否   | 50     |
| pitch           | 语调：0对应默认语速的1/2，100对应默认语速的2倍        | int      | 最小值:0, 最大值:100                                                                                                                                                                                                          | 否   | 50     |
| bgs             | 背景音                                                | int      | 0:无背景音, 1:内置背景音1, 2:内置背景音2                                                                                                                                                                                      | 否   | 0      |
| reg             | 英文发音方式                                          | int      | 0:自动判断处理，如果不确定将按照英文词语拼写处理（缺省）, 1:所有英文按字母发音, 2:自动判断处理，如果不确定将按照字母朗读                                                                                                      | 否   | 0      |
| rdn             | 合成音频数字发音方式                                  | int      | 0:自动判断, 1:完全数值, 2:完全字符串, 3:字符串优先                                                                                                                                                                            | 否   | 0      |
| rhy             | 是否返回拼音标注                                      | int      | 0:不返回拼音, 1:返回拼音（纯文本格式，utf8编码）                                                                                                                                                                              | 否   | 0      |
| scn             | 场景                                                  | int      | 0:无, 1:散文阅读, 2:小说阅读, 3:新闻, 4:广告, 5:交互                                                                                                                                                                          | 否   | 0      |
| version         | 引擎初始化，是否返回版本信息+时间戳信息               | int      | 0:不返回, 1:返回版本信息+时间戳信息。如XXX.18928127 XXX表示版本号，后接秒为单位的时间戳                                                                                                                                       | 否   | 0      |
| L5SilLen        | 控制L5静音时长，取值范围为0~10000ms                   | int      | 最小值:0, 最大值:10000                                                                                                                                                                                                        | 否   |        |
| ParagraphSilLen | 段落静音时长，取值范围为0~10000ms                     | int      | 最小值:0, 最大值:10000                                                                                                                                                                                                        | 否   |        |
| emotion         | 情感参数类别，不支持和emt参数一起使用                 | int      | 0:中立, 1:调皮, 2:安慰, 3:可爱, 4:鼓励, 5:高兴, 6:抱歉, 7:撒娇, 8:宠溺, 9:严肃, 10:困惑, 11:害怕, 12:悲伤, 13:生气                                                                                                            | 否   | 0      |
| emotion_scale   | 情感强度调节系数                                      | int      | 最小值:-20, 最大值:20                                                                                                                                                                                                         | 否   | 0      |
| emt             | 字符串传入情感类别，不支持和emotion参数一起使用       | string   | neutral:中立, naughty:调皮, conciliative:安慰, adorable:可爱, encouraged:鼓励, cheerful:高兴, apologetic:抱歉, affectionate:撒娇, beloved:宠溺, serious:严肃, puzzled:困惑, fearful:害怕, sad:悲伤, angry:生气, auto:自动预测 | 否   |        |
| extend          | emotioninfo输出扩展信息功能是否生效                   | int      | 0:输出扩展信息功能不生效, 1:输出扩展信息功能生效                                                                                                                                                                              | 否   | 0      |
| emotioninfo     | 输出情感扩展信息                                      | int      | 0:不输出任何扩展信息, 1:输出扩展信息仅包含EmotionApplied字段, 2:输出扩展信息包含EmotionApplied字段和EmotionDetail字段, 3:输出扩展信息包含PseudaEnd字段                                                                        | 否   | 0      |
| synthmode       | 是否支持断点续播                                      | int      | 0:不支持, 7:支持断点续播                                                                                                                                                                                                      | 否   | 0      |

> Note: 支持`extend`, `emotioninfo`, `synthmode`的发言人vcn仅有x4_lingxiaoxuan_oral、x4_lingfeizhe_oral、x4_lingyuzhao_oral、x4_lingxiaoqi_oral、x4_lingyuyan_oral、x4_oppo_female_oral、x4_lingfeiyi_oral、x4_lingxiaoyue_oral、x4_lingyouyou_oral、x4_lingxiaoli_oral。

- **(正式)发言人vcn列表**

| vcn                     | Name         | Gender | Languages        | Emotions Supported           |
| ----------------------- | ------------ | ------ | ---------------- | ---------------------------- |
| x4_lingyouyou_oral      | 聆佑佑       | Female | 中文、通用、通用 | --                           |
| x4_lingxiaoli_oral      | 聆小璃       | Female | 中文、通用、通用 | --                           |
| x4_lingxiaoxuan_oral    | 聆小璇       | Female | 中文、通用、通用 | --                           |
| x4_lingfeizhe_oral      | 聆飞哲       | Male   | 中文、通用、通用 | --                           |
| x4_lingyuzhao_oral      | 聆玉昭       | Female | 中文、通用、通用 | --                           |
| x4_lingxiaoqi_oral      | 聆小琪       | Female | 中文、通用、通用 | --                           |
| x4_lingyuyan_oral       | 聆芋圆       | Female | 中文、通用、通用 | --                           |
| x4_lingfeiyi_oral       | 聆飞逸       | Male   | 中文、通用、通用 | --                           |
| x4_lingxiaoyue_oral     | 聆小玥       | Female | 中文、通用、通用 | --                           |
| x4_zijin_oral           | 子津         | Male   | 天津话           | --                           |
| x4_ziyang_oral          | 子阳         | Male   | 东北话           | --                           |
| x4_lingfeiyi_oral_emo   | 聆飞逸多情感 | Male   | 中文、通用、通用 | 中立、高兴、困惑、安慰、抱歉 |
| x4_lingxiaoyue_oral_emo | 聆小玥多情感 | Female | 中文、通用、通用 | 中立、高兴、困惑、安慰、抱歉 |
| x5_clone                | 新版声音复刻 | --     | 中文、通用、通用 | --                           |
| x5_lingfeiyi_oral       | 聆飞逸5.0    | Male   | 中文、通用、通用 | --                           |
| x5_lingxiaoyue_oral     | 聆小玥5.0    | Female | 中文、通用、通用 | --                           |
| x4_EnUs_Lila_emo        | lila         | Female | 英文通用美式口音 | 平和/高兴/抱歉               |
| x4_EnUs_Grant_emo       | grant        | Male   | 英文通用美式口音 | 平和/高兴/抱歉               |

**期望输出参数**

audio 段的参数（必填）

| 字段        | 含义     | 数据类型 | 取值范围                                       | 默认值   | 说明               | 必填 |
| :---------- | :------- | :------- | :--------------------------------------------- | :------- | :----------------- | :--- |
| encoding    | 音频编码 | string   | lame, speex, opus, opus-wb, opus-swb, speex-wb | speex-wb | 取值范围可枚举     | 否   |
| sample_rate | 采样率   | int      | 16000, 8000, 24000                             | 24000    | 音频采样率，可枚举 | 否   |
| channels    | 声道数   | int      | 1, 2                                           | 1        | 声道数，可枚举     | 否   |
| bit_depth   | 位深     | int      | 16, 8                                          | 16       | 单位bit，可枚举    | 否   |
| frame_size  | 帧大小   | int      | 最小值:0, 最大值:1024                          | 0        | 帧大小，默认0      | 否   |
> 推荐使用 `lame`, `opus`系列编解码格式。

pybuf 段的参数, 当 rhy = 1 时，返回。

| 字段     | 含义         | 数据类型 | 取值范围    | 默认值 | 说明           | 必填 |
| :------- | :----------- | :------- | :---------- | :----- | :------------- | :--- |
| encoding | 文本编码     | string   | utf8        | utf8   | 取值范围可枚举 | 否   |
| compress | 文本压缩格式 | string   | raw         | raw    | 取值范围可枚举 | 否   |
| format   | 文本格式     | string   | plain, json | plain  | 取值范围可枚举 | 否   |

extendbuf 段的参数, 当 extend = 1 时，返回。

| 字段     | 含义         | 数据类型 | 取值范围    | 默认值 | 说明           | 必填 |
| :------- | :----------- | :------- | :---------- | :----- | :------------- | :--- |
| encoding | 文本编码     | string   | utf8        | utf8   | 取值范围可枚举 | 否   |
| compress | 文本压缩格式 | string   | raw         | raw    | 取值范围可枚举 | 否   |
| format   | 文本格式     | string   | plain, json | plain  | 取值范围可枚举 | 否   |

**请求数据**

text（默认请求）

| 字段     | 含义         | 数据类型 | 取值范围                         | 默认值 | 说明                                                                 | 必填 |
| -------- | ------------ | -------- | -------------------------------- | ------ | -------------------------------------------------------------------- | ---- |
| encoding | 文本编码     | string   | utf8                             | utf8   | 必须是 utf8                                                          | 是   |
| compress | 文本压缩格式 | string   | raw                              | raw    | 取值范围可枚举                                                       | 是   |
| format   | 文本格式     | string   | plain, json                      | plain  | 取值范围可枚举                                                       | 是   |
| status   | 数据状态     | int      | **0:开始, 1:开始, 2:结束**       |        | **0,1,2 流式传输**                                                   | 是   |
| seq      | 数据序号     | int      | 最小值:0, 最大值:9999999         |        | 数据序号，比如1,2,3,4...                                             | 是   |
| text     | 文本数据     | string   | 最小尺寸1字节，最大尺寸:8000字节 |        | 文本内容，不超过2000个字符，采用base64编码，编码后最大不超过8000字节 | 是   |

user_text 可选请求数据段，开启场景化合成必须在首帧一次性上传

| 字段     | 含义         | 数据类型 | 取值范围                    | 默认值 | 说明                                                                 | 必填 |
| -------- | ------------ | -------- | --------------------------- | ------ | -------------------------------------------------------------------- | ---- |
| encoding | 文本编码     | string   | utf8                        | utf8   | 必须是 utf8                                                          | 否   |
| compress | 文本压缩格式 | string   | raw                         | raw    | 取值范围可枚举                                                       | 否   |
| format   | 文本格式     | string   | plain, json                 | plain  | 取值范围可枚举                                                       | 否   |
| status   | 数据状态     | int      | **2:一次性传输**            |        | **2 一次性传输**                                                     | 是   |
| seq      | 数据序号     | int      | 最小值:0, 最大值:9999999    |        | 数据序号 ，比如1,2,3,4...                                            | 是   |
| text     | 文本数据     | string   | 最小尺寸:1B, 最大尺寸:8000B |        | 文本内容，不超过2000个字符，采用base64编码，编码后最大不超过8000字节 | 是   |

### 2. 场景化合成举例
场景化合成会对用户输入的`user_text`数据(去除标点后)进行文本匹配，如果包含设置好的场景化文本，则会替换为场景vcn来进行合成。

- 示例输入
```json
{
    "header": {
        "app_id": "123456",
        "res_id": "xxxxx",
        "status": 2,
    },
    "parameter": {
        "oral": {
            "oral_level":"mid",
            "scenarized":1
        },
        "tts": {
            "vcn": "x4_lingfeiyi_oral",
            "speed": 50,
            "volume": 50,
            "pitch": 50,
            "bgs": 0,
            "reg": 0,
            "rdn": 0,
            "rhy": 0,
            "scn": 0,
            "version": 0,
            "L5SilLen": 0,
            "ParagraphSilLen": 0,
            "audio": {
                "encoding": "lame",
                "sample_rate": 16000,
                "channels": 1,
                "bit_depth": 16,
                "frame_size": 0
            },
            "pybuf": {
                "encoding": "utf8",
                "compress": "raw",
                "format": "plain"
            }
        }
    },
    "payload": {
        "text": {
            "encoding": "utf8",
            "compress": "raw",
            "format": "plain",
            "status": 2,
            "seq": 0,
            "text": "xxxxxxx"
        },
        "user_text": {
            "encoding": "utf8",
            "compress": "raw",
            "format": "plain",
            "status": 2,
            "seq": 0,
            "text": "xxxxxxx"
        }
    }
}
```
> Note:   
> 1. user_text 数据段，需要在首帧一次性发送完(status = 2)  
> 2. 需要主动开启场景化，scenarized = 1  
> 3. 场景文本任选1条即可。

- 当前支持的场景

| 场景   | 发言人(vcn)            | 场景文本                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ------ | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 东北话 | x4_lingfeiyi_db        | 沈阳人爱吃的冻梨;沈阳人吃的冻梨;会不会说东北话;可以用东北话介绍下哈尔滨的特色吗;你能教我几句地道的东北话吗;能用东北话介绍一些家乡美食吗;东北话太上头了能用东北话说一段绕口令吗;请用东北话给大家拜个年;请用东北话介绍一下东北的风土人情;你可以用东北话和我语音对话吗;语音切换成东北话;我想用东北话和你语音聊天;可以用东北话和大家唠嗑吗;请用东北话介绍一下东北;请用东北话形容一下你现在的心情;会说东北话吗;请用东北话介绍一下今天的天气;请用东北话和我聊天;请用东北话介绍一下自己;会不会讲东北话;请用东北话和我语音对话;请用东北话和我聊天;用东北话给我解释一下;用东北话解释一下什么是;用东北话说个笑话;用东北话导航到附近的加油站;用东北话播报新闻头条;用东北话解释解题思路;用东北话帮我打开设备;用东北话介绍一款理财产品;用东北话给一些就医建议;用东北话给一些饮食建议;用东北话朗读待办事项;用东北话说一下;用东北话交流;用东北话交谈;用东北话对话;用东北话聊天;用东北话怎么说;用东北话描述;用东北话讲述;用东北话打电话;用东北话语音;用东北话回复;用东北话回答;用东北话答复;用东北话播报;用东北话介绍;使用东北话给;用东北话来说;使用东北话来;讲个东北话;说个东北话 |
| 朗读   | x4_lingfeiyi_audiobook | 朗读给我听听;帮我朗读一首诗;帮我朗读一个故事;帮我朗读一篇小说;帮我朗读一篇文章;请用朗读的风格介绍;请朗读一下;请朗读一篇小说;请写一篇散文并有感情的朗读;请写一篇关于年俗的介绍并朗读;请语音朗读一下;帮我语音朗读一下;你能帮我朗读吗;你能帮我语音朗读吗;能不能语音朗读一下;我想听你朗读一下;请用语音朗读;你可以朗读吗;我想听你语音朗读;语音朗读听听;请朗读这句话;请朗读这段话;请朗读这首;朗读出这句话;朗读出这段话;朗读出这首;朗读下这句话;朗读下这段话;朗读下这首;朗读一下这句话;朗读一下这段话;朗读一下这首;可以朗读吗;你会朗读吗;再朗读一次;重新朗读;朗读听一下;朗读听下;听一下朗读;听下朗读;朗读听听看;为我朗读;为大家朗读;听你朗读;请朗读这段;请朗读这个;请朗读这篇;请朗读这首;请朗读这副;听你朗读一下                                                                                                                                                                                                                                                                                                                                                          |

### 3. 响应示例
- 响应体
```json
{
    "header": {
        "code": 0,
        "message": "success",
        "sid": "aso000ede92@dx18caf514baab832882",
        "status": 1
    },
    "payload": {
        "audio": {
            "encoding": "lame",
            "sample_rate": 16000,
            "channels": 1,
            "bit_depth": 16,
            "status": 0,
            "seq": 0,
            "frame_size": 0,
            "audio": "xxxxx",
        },
        "pybuf": {
            "encoding": "utf8",
            "compress": "raw",
            "format": "plain",
            "status": 0,
            "seq": 0,
            "text": "xxxxx"
        }
    }
}
```

**协议结构说明**

| 字段      | 含义       | 类型   | 说明                             |
| --------- | ---------- | ------ | -------------------------------- |
| header    | 协议头部   | Object | 协议头部，用于描述平台特性的参数 |
| payload   | 响应数据块 | Object | 数据段，携带响应的数据。         |
| audio     | 响应数据块 | Object | 输出数据                         |
| pybuf     | 响应数据块 | Object | 输出数据                         |
| extendbuf | 响应数据块 | Object | 输出数据                         |

**平台参数**

| 字段    | 含义                            | 类型   | 是否必选 |
| ------- | ------------------------------- | ------ | -------- |
| code    | 返回码，0表示成功，其它表示异常 | int    | 是       |
| message | 错误描述                        | string | 是       |
| sid     | 本次会话的id                    | string | 是       |

**响应数据参数**

audio（默认返回）

| 字段        | 含义                   | 数据类型 | 取值范围                                       | 默认值   | 说明               | 必填 |
| :---------- | :--------------------- | :------- | :--------------------------------------------- | :------- | :----------------- | :--- |
| encoding    | 音频编码               | string   | lame, speex, opus, opus-wb, opus-swb, speex-wb | speex-wb | 取值范围可枚举     | 否   |
| sample_rate | 采样率                 | int      | 16000, 8000, 24000                             | 24000    | 音频采样率，可枚举 | 否   |
| channels    | 声道数                 | int      | 1, 2                                           | 1        | 声道数，可枚举     | 否   |
| bit_depth   | 位深                   | int      | 16, 8                                          | 16       | 单位bit，可枚举    | 否   |
| status      | 数据状态               | int      | 0:开始, 1:开始, 2:结束                         |          | 流式传输           | 是   |
| seq         | 数据序号               | int      | 最小值:0, 最大值:9999999                       | 0        | 标明数据为第几块   | 否   |
| audio       | 音频数据               | string   | 最小尺寸:0B, 最大尺寸:10485760B                |          | 音频大小：0-10M    | 是   |
| frame_size  | 帧大小                 | int      | 最小值:0, 最大值:1024                          | 0        | 帧大小，默认0      | 否   |
| ced         | 合成音频对应的文本进度 | string   | xxx                                            |          | ced的单位是字节    | 否   |

pybuf, 当 rhy = 1 时，返回。

| 字段     | 含义         | 数据类型 | 取值范围                       | 默认值 | 说明           | 必填 |
| :------- | :----------- | :------- | :----------------------------- | :----- | :------------- | :--- |
| encoding | 文本编码     | string   | utf8                           | utf8   | 取值范围可枚举 | 否   |
| compress | 文本压缩格式 | string   | raw                            | raw    | 取值范围可枚举 | 否   |
| format   | 文本格式     | string   | plain, json                    | plain  | 取值范围可枚举 | 否   |
| status   | 数据状态     | int      | 0:开始, 1:开始, 2:结束         |        | 流式传输       | 是   |
| seq      | 数据序号     | int      | 最小值:0, 最大值:9999999       |        | 数据序号       | 是   |
| text     | 文本数据     | string   | 最小尺寸:0B, 最大尺寸:1048576B |        | 文本大小：0-1M | 是   |

extendbuf, 当 extend = 1 时，返回。

| 字段     | 含义         | 数据类型 | 取值范围                       | 默认值 | 说明           | 必填 |
| :------- | :----------- | :------- | :----------------------------- | :----- | :------------- | :--- |
| encoding | 文本编码     | string   | utf8                           | utf8   | 取值范围可枚举 | 否   |
| compress | 文本压缩格式 | string   | raw                            | raw    | 取值范围可枚举 | 否   |
| format   | 文本格式     | string   | plain, json                    | plain  | 取值范围可枚举 | 否   |
| status   | 数据状态     | int      | 0:开始, 1:开始, 2:结束         |        | 流式传输       | 是   |
| seq      | 数据序号     | int      | 最小值:0, 最大值:9999999       |        | 数据序号       | 是   |
| text     | 文本数据     | string   | 最小尺寸:0B, 最大尺寸:1048576B |        | 文本大小：0-1M | 是   |

## 三、错误码列表

- 错误码示例：

```json
{
    "code":10003, // 平台通用错误码，详细信息请参照 5.1 平台通用错误码
    "message":"WrapperInitErr;errno=101", // errno 为引擎错误码，详细信息请参照 5.2 引擎错误码
    "sid":"ocr00088c7d@dx170194697e9a11d902"
}
```
- 平台错误码，详见"[首页-查问题](../utils/查问题.md)"
- 超拟人v3组件错误码
> Note: 请留意具体错误信息

| Code  | Description                                   |
| ----- | --------------------------------------------- |
| 0     | 处理成功                                      |
| -1    | 处理失败                                      |
| 20001 | 消息类型无效                                  |
| 20002 | 业务协议异常，序列化/反序列化失败             |
| 20003 | 路由信息空                                    |
| 21001 | header 为空                                   |
| 21002 | service_id 为空                               |
| 21003 | sid 为空                                      |
| 22001 | up call 空                                    |
| 22002 | up call param 空                              |
| 22003 | up call datalist 空                           |
| 22004 | up call data 空                               |
| 22005 | up call meta 空                               |
| 22006 | up call meta desc 空                          |
| 22007 | up call payload status 空                     |
| 23001 | down call 空                                  |
| 23002 | downcall 请求异常                             |
| 24001 | RPC请求异常                                   |
| 24002 | rpc call 的 res data 是 空的                  |
| 25001 | 任务已经结束                                  |
| 25002 | 上行数据乱序了                                |
| 25003 | 上行数据没有tts参数                           |
| 26001 | 用户请求不符合规范                            |
| 26002 | 拿到子句失败                                  |
| 26003 | 获取音频失败，根据message信息判断确切失败原因 |
| 26004 | 网络问题，返回信息失败                        |
| 26005 | 上行数据超时，保活失败                        |
| 26006 | 下行数据超时，保活失败                        |
| 26007 | 子任务超时                                    |
| 26008 | 子任务被取消                                  |
| 26009 | 子任务调用失败                                |
| 26010 | 子任务结果为空                                |
| 26011 | 从数据缓存区读取数据失败                      |
| 26012 | 初始化发送者失败                              |