API reference

Updated at:

Real-time long-text speech synthesis converts long text into binary audio data and streams the audio over WebSocket. It can be used for novel narration, news broadcasts, and video voice-overs.

Features and limits

  • Supports audio output in PCM, WAV, and MP3 formats.

  • Supports speech rate, pitch, and volume settings, with male and female voices for different use cases.

  • Each input must contain fewer than 10,000 characters. Each Chinese character, English letter, punctuation mark, or space within a sentence counts as one character. SSML tags do not count toward the limit. Use UTF-8 encoding and retain spaces between English words.

  • Supports multi-emotional voices. For the emotions supported by each voice, see Support for multi-emotional voices in this topic.

Important

Update the SDK to the latest version before using real-time long-text speech synthesis. For installation instructions and complete examples, see Java SDK and C++ SDK.

Billing and concurrency limits

Real-time long-text speech synthesis is available only in the Commercial Edition and does not offer a free trial. Activate the Commercial Edition before use. For service editions and billable items, see Billable items. For activation instructions and billing methods, see Billing methods. For concurrency limits, see Concurrency and QPS limits.

Service endpoints

Public endpoints are available to all servers. SDKs use the public endpoint in the China (Shanghai) region by default. To use another endpoint, specify it when creating the client.

Access type

Requirements

Endpoint

Public access

Available to all servers.

  • China (Shanghai): wss://nls-gateway-cn-shanghai.aliyuncs.com/ws/v1

  • China (Beijing): wss://nls-gateway-cn-beijing.aliyuncs.com/ws/v1

  • China (Shenzhen): wss://nls-gateway-cn-shenzhen.aliyuncs.com/ws/v1

ECS private network access

Use an ECS instance in China (Shanghai), China (Beijing), or China (Shenzhen) to access the endpoint over a VPC in the same region. The classic network does not support private network access to the speech service.

  • China (Shanghai): ws://nls-gateway-cn-shanghai-internal.aliyuncs.com:80/ws/v1

  • China (Beijing): ws://nls-gateway-cn-beijing-internal.aliyuncs.com:80/ws/v1

  • China (Shenzhen): ws://nls-gateway-cn-shenzhen-internal.aliyuncs.com:80/ws/v1

Private network access does not incur public data transfer fees for the ECS instance.

Intelligent access to the nearest region

End users are advised to use wss://nls-gateway.aliyuncs.com/ws/v1 for intelligent access to the nearest region. The system resolves the domain name to a server in the nearest region based on the client's geographical location. For example, a request from China (Beijing) is routed to a server in China (Beijing), with the same effect as specifying the Beijing regional domain name.

Interaction flow

image

The following flow applies to real-time long-text speech synthesis over WebSocket. For asynchronous long-text speech synthesis, see RESTful API.

1. Authenticate

The client uses an NLS token for authentication when establishing a WebSocket connection. For instructions, see Obtain a token. For the project Appkey, see Manage projects. The Appkey and token must belong to the same account.

2. Start synthesis

The client sends a StartSynthesis request with the SpeechLongSynthesizer namespace. In the Java SDK, call SpeechSynthesizer.setLongText() to set the long text and setAppKey() to set the Appkey. Set other parameters by using the corresponding setter methods or addCustomedParam().

Parameter

Type

Required

Description

appkey

String

Yes

The project Appkey, included in the request header.

text

String

Yes

The text to synthesize, included in payload. It must meet the preceding text length and encoding requirements.

Note

For a multi-emotional voice, set the emotion by using an <emotion> tag in text. The selected voice must support the specified emotion category. For tag usage, see Introduction to SSML.

voice

String

No

The voice. Default: xiaoyun. For supported voices, languages, and sample rates, see the Voice list in this topic.

format

String

No

The output audio format. Valid values: pcm, wav, and mp3. Default: pcm.

sample_rate

Integer

No

The audio sample rate, in Hz. Default: 16000. The available values depend on the selected voice.

volume

Integer

No

The volume. Valid values: 0 to 100. Default: 50.

speech_rate

Integer

No

The speech rate. Valid values: -500 to 500. Default: 0. For the relationship to the speed multiplier, see below.

speech_rate values of -500, 0, and 500 correspond to speed multipliers of 0.5, 1.0, and 2.0, respectively. A multiplier of 1.0 uses the model's default speech rate, which varies slightly by voice and is approximately four Chinese characters per second.

  • For a multiplier below 1.0, calculate (1 - 1 / multiplier) / 0.002. For example, a multiplier of 0.8 gives (1 - 1 / 0.8) / 0.002 = -125.

  • For a multiplier above 1.0, calculate (1 - 1 / multiplier) / 0.001. For example, a multiplier of 1.2 gives approximately 166.

Use an approximate integer value for the result.

pitch_rate

Integer

No

The pitch. Valid values: -500 to 500. Default: 0.

enable_subtitle

Boolean

No

Enables word-level and sentence-level timestamps. The selected voice must support this feature. For usage details, see Timestamps.

3. Receive synthesized data

The service returns audio in binary WebSocket frames, which the SDK receives and processes. For real-time playback, audio data can be played as it arrives to reduce waiting time.

When timestamps are enabled and supported by the voice, the service returns subtitle information in MetaInfo messages. Except for binary audio data, response messages include header.task_id to identify the synthesis task.

4. Complete synthesis

After synthesis completes, the service returns SynthesisCompleted. Example:

{
    "header":{
        "namespace":"SpeechLongSynthesizer",
        "name":"SynthesisCompleted",
        "status":20000000,
        "message_id":"396c80b3abf84082a48cb9e5c424****",
        "task_id":"f5805be640364cdcafc8da63e512****",
        "status_text":"Gateway:SUCCESS:Success."
    }
}

5. Handle synthesis failures

If synthesis fails because of parameters or other causes, the service returns TaskFailed and closes the underlying connection. The following example indicates a synthesis failure:

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

Troubleshoot the error by using header.status and header.status_text in the message. For details, see Error handling below.

Voice list

The following table lists the voices available for real-time long-text speech synthesis and their supported features.

Name

voice parameter value

Type

Scenarios

Supported languages

Supported sample rates (Hz)

Supports word/sentence-level timestamps

Supports r-sound

Voice quality

Abin

abin

Cantonese-accented Mandarin

Conversational digital human

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

No

No

Standard Edition

Zhixiaobai

zhixiaobai

Mandarin female voice

Conversational digital human

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

No

Yes

Standard Edition

Zhixiaoxia

zhixiaoxia

Mandarin female voice

Conversational digital human

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

No

Yes

Standard Edition

Zhixiaomei

zhixiaomei

Mandarin female voice

Livestreaming digital human

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

Yes

Standard Edition

Zhigui

zhigui

Mandarin female voice

Livestreaming digital human

Supports Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Standard Edition

Zhishuo

zhishuo

Mandarin male voice

Customer service digital human

Supports Chinese and Chinese-English mixed scenarios

8 K/16 K

Yes

Yes

Standard Edition

Aixia

aixia

Mandarin female voice

Customer service digital human

Supports Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Standard Edition

Cally

cally

American English female voice

Spoken English conversational digital human

Supports English-only scenarios

8K or 16K

Yes

Yes

Standard Edition

Zhifeng_Multi-emotional

zhifeng_emo

Multi-emotional male voice

General

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

Yes

Standard Edition

Zhibing_Multi-emotional

zhibing_emo

Multi-emotional male voice

General

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

Yes

Yes

Standard Edition

Zhimiao_Multi-emotional

zhimiao_emo

Multi-emotional female voice

Chinese-English scenarios

Chinese and English scenarios

8K/16K

Yes

Yes

Standard Edition

Zhimi_Multi-emotional

zhimi_emo

Multi-emotional female voice

General

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

No

Standard Edition

Zhiyan_Multi-emotional

zhiyan_emo

Multi-emotional female voice

General

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Zhibei_Multi-emotional

zhibei_emo

Multi-emotional child voice

General

Chinese and Chinese-English mixed scenarios

8 K/16 K

Yes

No

Standard Edition

Zhitian_Multi-emotional

zhitian_emo

Multi-emotional female voice

General

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

No

Standard Edition

Xiaoyun

xiaoyun

Standard female voice

General

Chinese and Chinese-English mixed scenarios

8K/16K

No

No

Lite Edition

Xiaogang

xiaogang

Standard male voice

General

Chinese and Chinese-English mixed scenarios

8K or 16K

No

No

Lite Edition

Ruoxi

ruoxi

Gentle female voice

General

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

No

No

Standard Edition

Siqi

siqi

Gentle female voice

General

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Sijia

sijia

Standard female voice

General

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

No

No

Standard Edition

Sicheng

sicheng

Standard male voice

General

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Aiqi

aiqi

Gentle female voice

General

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Aijia

aijia

Standard female voice

General

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

No

Standard Edition

Aicheng

aicheng

Standard male voice

General

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Aida

aida

Standard male voice

General

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Ninger

ninger

Standard female voice

General

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

No

No

Standard Edition

Ruilin

ruilin

Standard female voice

General

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

No

No

Standard Edition

Siyue

siyue

Gentle female voice

Customer service

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Aiya

aiya

Stern female voice

Customer service

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Aimei

aimei

Sweet female voice

Customer service

Chinese and Chinese-English mixed scenarios

8 K/16 K

Yes

No

Standard Edition

Aiyu

aiyu

Natural female voice

Customer service

Chinese and Chinese-English mixed scenarios

8 K or 16 K

Yes

No

Standard Edition

Aiyue

aiyue

Gentle female voice

Customer service

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

No

Standard Edition

Aijing

aijing

Stern female voice

Customer service

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Xiaomei

xiaomei

Sweet female voice

Customer service

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

No

No

Standard Edition

Aina

aina

Zhejiang-accented Mandarin female voice

Customer service

Chinese-only scenarios

8K or 16K

Yes

No

Standard Edition

Yina

yina

Zhejiang-accented Mandarin female voice

Customer service

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

No

No

Standard Edition

Sijing

sijing

Stern female voice

Customer service

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Sitong

sitong

Child voice

Child voice scenarios

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

No

No

Standard Edition

Xiaobei

xiaobei

Lolita female voice

Child voice scenarios

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Aitong

aitong

Child voice

Child voice scenarios

Chinese-only scenarios

8K or 16K

Yes

No

Standard Edition

Aiwei

aiwei

Lolita female voice

Child voice scenarios

Chinese-only scenarios

8K/16K

Yes

No

Standard Edition

Aibao

aibao

Lolita female voice

Child voice scenarios

Chinese-only scenarios

8K/16K

Yes

No

Standard Edition

Harry

harry

British English male voice

English scenarios

English scenarios

8K or 16K

No

No

Standard Edition

Abby

abby

American English female voice

English scenarios

English scenarios

8K or 16K

Yes

No

Standard Edition

Andy

andy

American English male voice

English scenarios

English scenarios

8K or 16K

Yes

No

Standard Edition

Eric

eric

British English male voice

English scenarios

English scenarios

8K or 16K

Yes

No

Standard Edition

Emily

emily

British English female voice

English scenarios

English scenarios

8K or 16K

Yes

No

Standard Edition

Luna

luna

British English female voice

English scenarios

English scenarios

8K/16K

Yes

No

Standard Edition

Luca

luca

British English male voice

English scenarios

English scenarios

8K/16K

Yes

No

Standard Edition

Wendy

wendy

British English female voice

English scenarios

English scenarios

8 K, 16 K, or 24 K

No

No

Standard Edition

William

william

British English male voice

English scenarios

English scenarios

8 kHz/16 kHz/24 kHz

No

No

Standard Edition

Olivia

olivia

British English female voice

English scenarios

English scenarios

8 kHz/16 kHz/24 kHz

No

No

Standard Edition

Shanshan

shanshan

Cantonese female voice

Dialect scenarios

Standard Cantonese (Simplified Chinese) and Cantonese-English mixed scenarios

8 kHz/16 kHz/24 kHz

No

No

Standard Edition

Aiyuan

aiyuan

Warm, sisterly female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Premium Edition

Aiying

aiying

Cute child voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz

Yes

Yes

Premium Edition

Aixiang

aixiang

Magnetic male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8 K or 16 K

Yes

Yes

Premium Edition

Aimo

aimo

Emotional male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Aiye

aiye

Young male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Aiting

aiting

Radio female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Premium Edition

Aifan

aifan

Emotional female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8 K/16 K

Yes

Yes

Premium Edition

Lydia

lydia

Bilingual English-Chinese female voice

English scenarios

English and English-Chinese mixed scenarios

8 kHz/16 kHz

Yes

No

Standard Edition

Xiaoyue

chuangirl

Sichuan dialect female voice

Dialect scenarios

Chinese and Chinese-English mixed scenarios

8 K/16 K

No

No

Standard Edition

Aishuo

aishuo

Natural male voice

Customer service

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

No

Standard Edition

Qingqing

qingqing

Taiwanese Mandarin female voice

Dialect scenarios

Chinese-only scenarios

8 kHz/16 kHz

No

No

Standard Edition

Cuijie

cuijie

Northeastern dialect female voice

Dialect scenarios

Chinese-only scenarios

8 K/16 K

Yes

Yes

Standard Edition

Xiaoze

xiaoze

Hunanese heavy-accent male voice

Dialect scenarios

Chinese-only scenarios

8K or 16K

No

No

Standard Edition

Ainan

ainan

Advertisement male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Premium Edition

Aihao

aihao

News male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Aiming

aiming

Humorous male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Aixiao

aixiao

News female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Premium Edition

Aichu

aichu

Food documentary male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Premium Edition

Aiqian

aiqian

News female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8 K/16 K

Yes

Yes

Premium Edition

Tomoka

tomoka

Japanese female voice

Multilingual scenarios

Japanese-only scenarios

8K / 16K

Yes

No

Standard Edition

Tomoya

tomoya

Japanese male voice

Multilingual scenarios

Japanese-only scenarios

8K / 16K

Yes

No

Standard Edition

Annie

annie

American English female voice

English scenarios

English-only scenarios

8K or 16K

Yes

No

Standard Edition

Aishu

aishu

News male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Airu

airu

News female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Premium Edition

Jiajia

jiajia

Cantonese female voice

Dialect scenarios

Standard Cantonese (Simplified Chinese) and Cantonese-English mixed scenarios

8 K/16 K

Yes

No

Standard Edition

Indah

indah

Indonesian female voice

Multilingual scenarios

Indonesian-only scenarios

8K or 16K

No

No

Standard Edition

Peach

taozi

Cantonese female voice

Dialect scenarios

Supports Standard Cantonese (Simplified Chinese) and Cantonese-English mixed scenarios

8K/16K

Yes

No

Standard Edition

Sales associate

guijie

Friendly female voice

General

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz

Yes

Yes

Standard Edition

Stella

stella

Intellectual female voice

General

Supports Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Standard Edition

Stanley

stanley

Calm male voice

General

Supports Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Standard Edition

Kenny

kenny

Calm male voice

General

Supports Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Standard Edition

Rosa

rosa

Natural female voice

General

Supports Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Standard Edition

Farah

farah

Malay female voice

Multilingual scenarios

Supports Malay-only scenarios

8K/16K

No

No

Standard Edition

Mashu

mashu

Children's drama male voice

General

General

8K/16K

Yes

No

Standard Edition

Zhiqi

zhiqi

Gentle female voice

Ultra-high definition scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhichu

zhichu

Food documentary male voice

Ultra-high definition scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

Yes

Premium Edition

Xiaoxian

xiaoxian

Friendly female voice

Livestreaming scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz

Yes

Yes

Standard Edition

Yuer

yuer

Children's drama female voice

General

Supports Chinese-only scenarios

8K or 16K

Yes

No

Standard Edition

Maoxiaomei

maoxiaomei

Energetic female voice

Livestreaming scenarios

Supports Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Standard Edition

Zhixiang

zhixiang

Magnetic male voice

Ultra-high definition scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhijia

zhijia

Standard female voice

Ultra-high definition scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhinan

zhinan

Advertisement male voice

Ultra-high definition scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhiqian

zhiqian

News female voice

Ultra-high definition scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhiru

zhiru

News female voice

Ultra-high definition scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhide

zhide

News male voice

Ultra-high definition scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhifei

zhifei

Passionate commentary

Ultra-high definition scenarios

Supports Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Premium Edition

Aifei

aifei

Passionate commentary

Livestreaming scenarios

Supports Chinese and Chinese-English mixed scenarios

8 K or 16 K

Yes

Yes

Standard Edition

Subgroup

yaqun

Store broadcast

Livestreaming scenarios

Supports Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Standard Edition

Qiaowei

qiaowei

Store broadcast

Livestreaming scenarios

Supports Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Standard Edition

Dahu

dahu

Northeastern dialect male voice

Dialect scenarios

Supports Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Standard Edition

ava

ava

American English female voice

English scenarios

Supports English-only scenarios

8 K/16 K

Yes

No

Standard Edition

Zhilun

zhilun

Suspense commentary

Ultra-high definition scenarios

Supports Chinese and Chinese-English mixed scenarios

8K/16K

Yes

No

Premium Edition

Ailun

ailun

Suspense commentary

Livestreaming scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz

Yes

Yes

Standard Edition

Jielidou

jielidou

Soothing child voice

Child voice scenarios

Supports Chinese-only scenarios

8K or 16K

Yes

Yes

Standard Edition

Zhiwei

zhiwei

Sweet Female Voice

Ultra-high definition scenarios

Supports Chinese-only scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Laotie

laotie

Northeastern buddy

Livestreaming scenarios

Supports Chinese-only scenarios

8K/16K

Yes

Yes

Standard Edition

Younger sister

laomei

Female Hawker

Livestreaming scenarios

Supports Chinese-only scenarios

8K or 16K

Yes

Yes

Standard Edition

Aikan

aikan

Tianjin dialect male voice

Dialect scenarios

Supports Chinese-only scenarios

8K/16K

Yes

Yes

Standard Edition

Tala

tala

Filipino female voice

Multilingual scenarios

Supports Filipino-only scenarios

8K or 16K

No

No

Standard Edition

Zhitian

zhitian

Sweet female voice

General

Supports Chinese and Chinese-English mixed scenarios

8K/16K

Yes

No

Premium Edition

Zhiqing

zhiqing

Taiwan (China) dialect female voice

Dialect scenarios

Supports Chinese-only scenarios

8K or 16K

Yes

No

Premium Edition

Tien

tien

Vietnamese female voice

Multilingual scenarios

Supports Vietnamese-only scenarios

8K/16K

No

No

Standard Edition

Becca

becca

American English customer service female voice

American English

Supports English-only scenarios

8K or 16K

No

No

Standard Edition

Kyong

Kyong

Korean female voice

Korean scenarios

Korean

8 kHz/16 kHz

No

No

Standard Edition

masha

masha

Russian female voice

Russian scenarios

Russian

8K/16K

No

No

Standard Edition

camila

camila

Spanish female voice

Spanish scenarios

Spanish

8 kHz/16 kHz

No

No

Standard Edition

perla

perla

Italian female voice

Italian scenarios

Italian

8 kHz/16 kHz

No

No

Standard Edition

Zhimao

zhimao

Mandarin female voice

Livestreaming

Chinese

8 kHz/16 kHz

Yes

No

Standard Edition

Zhiyuan

zhiyuan

Mandarin female voice

General

Chinese

8 kHz/16 kHz

Yes

No

Standard Edition

Zhiya

zhiya

Mandarin female voice

Customer service

Chinese

8 kHz/16 kHz

Yes

No

Standard Edition

Zhiyue

zhiyue

Mandarin female voice

General

Chinese

8 kHz/16 kHz

Yes

No

Standard Edition

Zhida

zhida

Mandarin male voice

General

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz

Yes

No

Standard Edition

Zhi Sha

zhistella

Mandarin female voice

General

Chinese

8 kHz/16 kHz

Yes

No

Standard Edition

Kelly

kelly

Hong Kong Cantonese female voice

Dialect scenarios

Hong Kong Cantonese

8 kHz/16 kHz

Yes

No

Standard Edition

clara

clara

French female voice

General

French

8 kHz/16 kHz

No

No

Standard Edition

hanna

hanna

German female voice

General

German

8 kHz/16 kHz

No

No

Standard Edition

waan

waan

Thai female voice

General

Thai

8 kHz/16 kHz

No

No

Standard Edition

betty

betty

American English female voice

General

American English

8 kHz/16 kHz

Yes

No

Standard Edition

beth

beth

American English female voice

General

American English

8 kHz/16 kHz

Yes

No

Standard Edition

cindy

cindy

American English female voice

General

American English

8 kHz/16 kHz

Yes

No

Standard Edition

donna

donna

American English female voice

General

American English

8 kHz/16 kHz

Yes

No

Standard Edition

eva

eva

American English female voice

General

American English

8 kHz/16 kHz

Yes

No

Standard Edition

brian

brian

American English male voice

General

American English

8 kHz/16 kHz

Yes

No

Standard Edition

david

david

American English male voice

General

American English

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

abby_ecmix

abby_ecmix

American English female voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

annie_ecmix

annie_ecmix

American English female voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

andy_ecmix

andy_ecmix

American English male voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

ava_ecmix

ava_ecmix

American English female voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

betty_ecmix

betty_ecmix

American English female voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

beth_ecmix

beth_ecmix

American English female voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

brian_ecmix

brian_ecmix

American English male voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

cindy_ecmix

cindy_ecmix

American English female voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

cally_ecmix

cally_ecmix

American English female voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

donna_ecmix

donna_ecmix

American English female voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

david_ecmix

david_ecmix

American English male voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

eva_ecmix

eva_ecmix

American English female voice

General

English and English-Chinese mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Support for multi-emotional voices

Only multi-emotional voices support emotion selection. The available emotion categories vary by voice. Categories include neutral, happy, angry, sad, fear, hate, surprise, arousal, serious, disgust, jealousy, embarrassed, frustrated, affectionate, gentle, newscast, customer-service, story, and living.

Voice name

voice parameter value

Emotion category

Zhifeng_Multi-emotional

zhifeng_emo

angry, fear, happy, neutral, sad, surprise

Zhibing_Multi-emotional

zhibing_emo

angry, fear, happy, neutral, sad, surprise

Zhimiao_Multi-emotional

zhimiao_emo

serious, sad, disgust, jealousy, embarrassed, happy, fear, surprise, neutral, frustrated, affectionate, gentle, angry, newscast, customer-service, story, living

Zhimi_Multi-emotional

zhimi_emo

angry, fear, happy, hate, neutral, sad, surprise

Zhiyan_Multi-emotional

zhiyan_emo

neutral, happy, angry, sad, fear, hate, surprise, arousal

Zhibei_Multi-emotional

zhibei_emo

neutral, happy, angry, sad, fear, hate, surprise

Zhitian_Multi-emotional

zhitian_emo

neutral, happy, angry, sad, fear, hate, surprise

Error handling

header.status is the service status code. 20000000 indicates success. If a call fails, use header.status and header.status_text to handle the error. For status codes and solutions, see Error codes.