API reference

Updated at:

Long text-to-speech asynchronously converts text containing thousands or tens of thousands of characters into audio files. After submitting a synthesis task, poll its status or receive a callback, and download the audio from the returned URL.

Billing and concurrency limits

  • Long text-to-speech is available only in the commercial edition and does not offer a free trial. For edition details, see Billing overview. For activation instructions and billing methods, see Billing methods.

  • For concurrency limits, see Concurrency control.

Features

  • Supports PCM, WAV, and MP3 audio. You can configure the speech rate, pitch, and volume, and select male or female voices for uses such as audiobook narration, news broadcasts, and video dubbing.

  • Results are available only asynchronously. Synthesis completes within 3 hours after a task is submitted. Synthesizing 50,000 characters can take as little as 10 minutes.

  • A request can contain up to 100,000 characters. Each Chinese character, English letter, punctuation mark, or space within a sentence counts as one character. Input text must be UTF-8 encoded.

  • Audio files are stored on the server for 7 days. Applications can also cache and reuse the files.

  • The RESTful API supports sentence-level timestamps for synchronizing audio and text. For details, see Timestamps.

  • Supports emotional speech synthesis. For available voices and emotions, see Emotional voices. For the <emotion> tag, see Speech Synthesis Markup Language. SSML tags do not count toward the character limit.

Important

To use long text-to-speech through an SDK, update the SDK to the latest version.

Interaction process

  1. The client sends a POST request containing the text and synthesis parameters.

  2. The server returns a JSON response. If submission succeeds, data.task_id contains the synthesis task ID.

  3. The client polls the task status with GET requests or waits for a callback to the specified URL.

  4. After synthesis completes, download or play the audio from data.audio_address in the result.

Note

A successful submission means that the task was accepted, not that synthesis is complete. The API returns JSON, not an audio stream. Check the task result to determine whether synthesis succeeded.

image

Endpoints

Access type

URL

Description

Internet

https://nls-gateway-cn-shanghai.aliyuncs.com/rest/v1/tts/async

Accessible from all servers over the Internet. SDKs use this endpoint by default, with no additional configuration required.

VPC

http://nls-gateway-cn-shanghai-internal.aliyuncs.com/rest/v1/tts/async

Available to ECS instances in the China (Shanghai) region through a virtual private cloud (VPC). The classic network is not supported. Internal access does not incur public outbound traffic fees for the ECS instance.

The HTTP Host values are nls-gateway-cn-shanghai.aliyuncs.com and nls-gateway-cn-shanghai-internal.aliyuncs.com, respectively.

Request description

Submit a task with the POST method and set the Content-Type request header to application/json. In the JSON request body, place authentication information in header, synthesis parameters in payload.tts_request, and callback settings in payload.

Sample request

Replace yourAppkey and yourToken with your project Appkey and a valid NLS token.

{
  "header": {
    "appkey": "yourAppkey",
    "token": "yourToken"
  },
  "payload": {
    "tts_request": {
      "voice": "abby",
      "sample_rate": 16000,
      "format": "wav",
      "text": "The weather is nice today. Let us go for a walk.",
      "enable_subtitle": true
    },
    "enable_notify": false
  },
  "context": {
    "device_id": "my_device_id"
  }
}

header

Parameter

Type

Required

Description

appkey

String

Yes

The project Appkey. For instructions on obtaining it, see Manage projects.

token

String

Yes

The NLS token used for authentication.

payload

Parameter

Type

Required

Description

tts_request

Object

Yes

The synthesis parameters. See the following table for its fields.

enable_notify

Boolean

No

Specifies whether to enable callbacks. Default: false.

notify_url

String

Conditional

Required when enable_notify is true. The callback URL must use HTTP or HTTPS. Its host cannot be an IP address.

payload.tts_request

Parameter

Type

Required

Description

text

String

Yes

The UTF-8 encoded text to synthesize, up to 100,000 characters.

format

String

No

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

sample_rate

Integer

No

The audio sample rate in Hz. Default: 16000. Supported rates depend on the voice and include 8000, 16000, and, for some voices, 24000 and 48000. See Voice list.

voice

String

No

The voice to use. Default: xiaoyun. For available values, see Voice list.

volume

Integer

No

The volume, from 0 to 100. Default: 50.

speech_rate

Integer

No

The speech rate, from -500 to 500. Default: 0.

pitch_rate

Integer

No

The pitch, from -500 to 500. Default: 0.

enable_subtitle

Boolean

No

Specifies whether to enable sentence-level timestamps. Default: false. When enabled, data.sentences contains sentence text and start and end times.

Note

For emotional voices, specify the emotion with the SSML <emotion> tag in text. For details, see Speech Synthesis Markup Language. Only voices that support emotions can use this tag. Otherwise, the service returns Illegal ssml text.

Retrieve synthesis results

After submitting a task, retrieve the result by using one of the following methods.

Polling

Send a GET request to the same endpoint. Include appkey, token, and the task_id returned by the submission request in the query parameters.

GET /rest/v1/tts/async?appkey=yourAppkey&token=yourToken&task_id=yourTaskId
Host: nls-gateway-cn-shanghai.aliyuncs.com

When error_code is 20000000, use error_message to determine the task status:

error_message

Meaning

QUEUEING

The task is queued. Continue polling.

RUNNING

Synthesis is in progress. Continue polling.

SUCCESS

Synthesis is complete. Retrieve the audio from data.audio_address.

If error_code is not 20000000, use error_message to handle the error. An HTTP 200 response alone does not indicate successful synthesis.

Callback

When submitting the task, set enable_notify to true in payload and specify a callback URL in notify_url. After synthesis completes, the server sends the result to this URL. The audio URL is in data.audio_address.

The callback URL must use HTTP or HTTPS. Its host cannot be an IP address.

Response description

Use the following fields to process JSON responses to submission and query requests.

Field

Type

Description

status

Integer

The response status. Normally 200 for submission and query responses. You must also check error_code and the task status.

error_code

Integer

The service status code. 20000000 indicates that the current request was processed successfully.

error_message

String

The status or error message. A successful query returns QUEUEING, RUNNING, or SUCCESS.

request_id

String

The request ID, which can be used for troubleshooting.

data.task_id

String

The synthesis task ID, used to query the task.

data.audio_address

String

The download URL of the synthesized audio. Can be null before synthesis completes.

data.sentences

Array

Sentence-level timestamps returned when enable_subtitle is enabled. Can be null if synthesis is incomplete or timestamps are disabled.

sentences fields

Field

Type

Description

text

String

The sentence text.

begin_time

String

The start time of the sentence in the audio, in milliseconds.

end_time

String

The end time of the sentence in the audio, in milliseconds.

The following example shows a query response after synthesis completes. The audio URL is represented by a placeholder.

{
  "status": 200,
  "data": {
    "sentences": [
      {
        "text": "The weather is nice today. Let us go for a walk.",
        "begin_time": "0",
        "end_time": "3449"
      }
    ],
    "task_id": "b80571bb9bd045bd8ecb3a3ae5b09768",
    "audio_address": "<audio_address>",
    "notify_custom": null
  },
  "error_code": 20000000,
  "error_message": "SUCCESS",
  "request_id": "0bee91da7bd3424299d9b0068cbed270"
}

Voice list

Select a voice based on the language, use case, and sample rate. Timestamp support in this table refers to sentence-level timestamps for this API.

Name

voice parameter value

Type

Scenario

Supported languages

Supported sample rates (Hz)

Sentence-level timestamps

Supports r-sound

Voice quality

Abin

abin

Guangdong 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

8 kHz/16 kHz

Yes

Yes

Standard Edition

Zhishuo

zhishuo

Mandarin male voice

Customer service digital human

Supports Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Standard Edition

Aixia

aixia

Mandarin female voice

Customer service digital human

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz

Yes

Yes

Standard Edition

Cally

cally

American English female voice

Spoken English conversational digital human

Supports only English scenarios

8K or 16K

Yes

Yes

Standard Edition

Zhifeng_emo

zhifeng_emo

Multi-emotion male voice

General

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

Yes

Standard Edition

Zhibing_emo

zhibing_emo

Multi-emotion male voice

General

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

Yes

Yes

Standard Edition

Zhimiao_emo

zhimiao_emo

Multi-emotion female voice

Chinese-English scenarios

Chinese and English scenarios

8K/16K

Yes

Yes

Standard Edition

Zhimi_emo

zhimi_emo

Multi-emotion female voice

General

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

No

Standard Edition

Zhiyan_emo

zhiyan_emo

Multi-emotion female voice

General

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Zhibei_emo

zhibei_emo

Multi-emotion child voice

General

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Zhitian_emo

zhitian_emo

Multi-emotion female voice

General

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Xiaoyun

xiaoyun

Standard female voice

General

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Lite Edition

Xiaogang

xiaogang

Standard male voice

General

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Lite Edition

Ruoxi

ruoxi

Gentle female voice

General

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

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

Yes

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

8 K/16 K

Yes

No

Standard Edition

Ninger

ninger

Standard female voice

General

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Ruilin

ruilin

Standard female voice

General

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

Yes

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 / 16K

Yes

No

Standard Edition

Aimei

aimei

Sweet female voice

Customer service

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

No

Standard Edition

Aiyu

aiyu

Natural female voice

Customer service

Chinese and Chinese-English mixed scenarios

8K / 16K

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

8 K / 16 K

Yes

No

Standard Edition

Xiaomei

xiaomei

Sweet female voice

Customer service

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Aina

aina

Zhejiang-accented Mandarin female voice

Customer service

Chinese-only scenarios

8 K or 16 K

Yes

No

Standard Edition

Yina

yina

Zhejiang-accented Mandarin female voice

Customer service

Chinese-only scenarios

8 kHz/16 kHz/24 kHz

Yes

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

Yes

No

Standard Edition

Xiaobei

xiaobei

Young Girl's 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 or 16K

Yes

No

Standard Edition

Aibao

aibao

Sweet Girlish Voice

Child voice scenarios

Chinese-only scenarios

8K or 16K

Yes

No

Standard Edition

Harry

harry

British English male voice

English scenarios

English scenarios

8K/16K

Yes

No

Standard Edition

Abby

abby

American English female voice

English scenarios

English scenarios

8K/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/16K

Yes

No

Standard Edition

Emily

emily

British English female voice

English scenarios

English scenarios

8 K or 16 K

Yes

No

Standard Edition

Luna

luna

British English female voice

English scenarios

English scenarios

8 K/16 K

Yes

No

Standard Edition

Luca

luca

British English male voice

English scenarios

English scenarios

8 K or 16 K

Yes

No

Standard Edition

Wendy

wendy

British English female voice

English scenarios

English scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

William

william

British English male voice

English scenarios

English scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Olivia

olivia

British English female voice

English scenarios

English scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Shanshan

shanshan

Cantonese female voice

Dialect scenarios

Standard Cantonese (Simplified) and Cantonese-English mixed scenarios

8 kHz/16 kHz/24 kHz

Yes

No

Standard Edition

Aiyuan

aiyuan

Warm, reassuring female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8 K/16 K

Yes

Yes

Premium Edition

Aiying

aiying

Cute child voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8 K/16 K

Yes

Yes

Premium Edition

Aixiang

aixiang

Magnetic male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Aimo

aimo

Emotional male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz

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-style female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Aifan

aifan

Emotional female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

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

Sichuanese female voice

Dialect scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Aishuo

aishuo

Natural male voice

Customer service

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Standard Edition

Qingqing

qingqing

Taiwanese Mandarin female voice

Dialect scenarios

Chinese-only scenarios

8 kHz/16 kHz

Yes

No

Standard Edition

Cuijie

cuijie

Northeastern Mandarin female voice

Dialect scenarios

Chinese-only scenarios

8K or 16K

Yes

Yes

Standard Edition

Xiaoze

xiaoze

Hunan-accented male voice

Dialect scenarios

Chinese-only scenarios

8K/16K

Yes

No

Standard Edition

Ainan

ainan

Advertisement-style male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8 K or 16 K

Yes

Yes

Premium Edition

Aihao

aihao

News-style 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/16K

Yes

Yes

Premium Edition

Aixiao

aixiao

News-style female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Aichu

aichu

Food documentary-style male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Premium Edition

Aiqian

aiqian

News-style female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Tomoka

tomoka

Japanese female voice

Multi-language scenarios

Japanese-only scenarios

8 K or 16 K

Yes

No

Standard Edition

Tomoya

tomoya

Japanese male voice

Multi-language scenarios

Japanese-only scenarios

8K or 16K

Yes

No

Standard Edition

Annie

annie

American English female voice

English scenarios

Supports only English scenarios

8K or 16K

Yes

No

Standard Edition

Aishu

aishu

News-style male voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Airu

airu

Newscast female voice

Literary scenarios

Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Premium Edition

Jiajia

jiajia

Cantonese female voice

Dialect scenarios

Standard Cantonese (Simplified) and Cantonese-English mixed scenarios

8K / 16K

Yes

No

Standard Edition

Indah

indah

Indonesian female voice

Multi-language scenarios

Indonesian-only scenarios

8 K/16 K

Yes

No

Standard Edition

Taozi

taozi

Cantonese female voice

Dialect scenarios

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

8K or 16K

Yes

No

Standard Edition

Guijie

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 or 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

Multi-language scenarios

Supports only Malay scenarios

8 K/16 K

Yes

No

Standard Edition

Mashu

mashu

Children's drama male voice

General

General

8K/16K

Yes

No

Standard Edition

Zhiqi

zhiqi

Gentle female voice

UHD scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhichu

zhichu

Food documentary-style male voice

UHD 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 only Chinese scenarios

8K or 16K

Yes

No

Standard Edition

Maoxiaomei

maoxiaomei

Energetic female voice

Livestreaming scenarios

Supports Chinese and Chinese-English mixed scenarios

8 K/16 K

Yes

Yes

Standard Edition

Zhixiang

zhixiang

Magnetic male voice

UHD 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

UHD scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhinan

zhinan

Advertisement-style male voice

UHD scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhiqian

zhiqian

News-style female voice

UHD scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhiru

zhiru

Newscast female voice

UHD scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhide

zhide

Newscast male voice

UHD scenarios

Supports Chinese and Chinese-English mixed scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Zhifei

zhifei

Passionate narrator voice

UHD scenarios

Supports Chinese and Chinese-English mixed scenarios

8K/16K

Yes

No

Premium Edition

Aifei

aifei

Passionate narrator voice

Livestreaming scenarios

Supports Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

Yes

Standard Edition

Yaqun

yaqun

Store broadcast voice

Livestreaming scenarios

Supports Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Standard Edition

Qiaowei

qiaowei

Store broadcast voice

Livestreaming scenarios

Supports Chinese and Chinese-English mixed scenarios

8K/16K

Yes

Yes

Standard Edition

Dahu

dahu

Northeastern Mandarin male voice

Dialect scenarios

Supports Chinese and Chinese-English mixed scenarios

8 K / 16 K

Yes

Yes

Standard Edition

ava

ava

American English female voice

English scenarios

Supports only English scenarios

8 K/16 K

Yes

No

Standard Edition

Zhilun

zhilun

Suspense narrator voice

UHD scenarios

Supports Chinese and Chinese-English mixed scenarios

8K or 16K

Yes

No

Premium Edition

Ailun

ailun

Suspense narrator voice

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 only Chinese scenarios

8K / 16K

Yes

Yes

Standard Edition

Zhiwei

zhiwei

Childlike Female Voice

UHD scenarios

Supports only Chinese scenarios

8 kHz/16 kHz/24 kHz/48 kHz

Yes

No

Premium Edition

Laotie

laotie

Northeastern Buddy

Livestreaming scenarios

Supports only Chinese scenarios

8K/16K

Yes

Yes

Standard Edition

Laomei

laomei

Hawking female voice

Livestreaming scenarios

Supports only Chinese scenarios

8 K/16 K

Yes

Yes

Standard Edition

Aikan

aikan

Tianjin-accented male voice

Dialect scenarios

Supports only Chinese scenarios

8 K/16 K

Yes

Yes

Standard Edition

Tala

tala

Filipino female voice

Multi-language scenarios

Supports only Filipino scenarios

8K or 16K

No

No

Standard Edition

Zhitian

zhitian

Sweet female voice

General

Supports Chinese and Chinese-English mixed scenarios

8 K/16 K

Yes

No

Premium Edition

Zhiqing

zhiqing

Taiwanese Mandarin female voice

Dialect scenarios

Supports only Chinese scenarios

8K / 16K

Yes

No

Premium Edition

Tien

tien

Vietnamese female voice

Multi-language scenarios

Supports only Vietnamese scenarios

8 K/16 K

No

No

Standard Edition

Becca

becca

American English customer service female voice

American English

Supports only English 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

Zhisha

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

Ultra-high-definition voices

Some voices support a sample rate of 48 kHz. For details, see Voice list. Listen to the following audio samples:

Emotional voices

Only emotional voices support emotion selection. Available emotions vary by voice and include neutral, happy, angry, sad, fear, hate, surprise, arousal, serious, disgust, jealousy, embarrassed, frustrated, affectionate, gentle, newscast, customer-service, story, and living. The following table lists the values for each voice.

Voice name

voice value

Emotion category

Zhifeng (emotional)

zhifeng_emo

angry, fear, happy, neutral, sad, surprise

Zhibing (emotional)

zhibing_emo

angry, fear, happy, neutral, sad, surprise

Zhimiao (emotional)

zhimiao_emo

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

Zhimi (emotional)

zhimi_emo

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

Zhiyan (emotional)

zhiyan_emo

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

Zhibei (emotional)

zhibei_emo

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

Zhitian (emotional)

zhitian_emo

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

Error codes

If a call fails, troubleshoot the issue based on error_code and error_message in the response. For error codes and solutions, see Error codes.

References

For complete code examples, see RESTful API.