You need to enable JavaScript to run this app.
文档中心
豆包语音

豆包语音

复制全文
下载 pdf
声音复刻
分页查询SpeakerID状态
复制全文
下载 pdf
分页查询SpeakerID状态
分页查询已购买的音色状态;支持使用token和声明页数两种分页方式;其中,​
  • 分页token在最后一页为空​
  • 分页token采用私有密钥进行加密​
  • 分页接口为新接口,不影响已有接口行为​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:BatchListMegaTTSTrainStatus​
要执行的操作,取值:BatchListMegaTTSTrainStatus。​
​
Version string 必选 示例值:2025-05-21​
API的版本,取值:2025-05-21。​
​
ProjectName string 必选 示例值:xxx​
火山项目名称​
​
SpeakerIDs string[] 可选 示例值:S_x123​
SpeakerID的列表,传空为返回指定ProjeceName下的全部SpeakerID​
​
State string 必选 示例值:Training​
音色状态,支持取值:Unknown、Training、Success、Active、Expired、Reclaimed​
详见附录:State状态枚举值​
​
OrderTimeStart long 可选 示例值:1752204841000​
下单时间检索上边界毫秒级时间戳,受实例交付速度影响,可能比支付完成的时间晚​
​
OrderTimeEnd long 可选 示例值:1752204841000​
下单时间检索下边界毫秒级时间戳,受实例交付速度影响,可能比支付完成的时间晚​
​
ExpireTimeStart long 可选 示例值:1752204841000​
实例到期时间的检索上边界毫秒级时间戳​
​
ExpireTimeEnd long 可选 示例值:1752204841000​
实例到期时间的检索下边界毫秒级时间戳​
​
PageNumber integer 可选 示例值:1​
页数, 需大于0, 默认为1​
​
PageSize integer 可选 示例值:10​
每页条数​
​
NextToken string 可选 示例值:abcdefghijklmn​
上次请求返回的字符串; 如果不为空的话, 将覆盖PageNumber及PageSize的值​
​
MaxResults integer 可选 示例值:10​
与NextToken相配合控制返回结果的最大数量​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
PageNumber integer 示例值:1​
页数​
​
PageSize integer 示例值:100​
每页条数​
​
TotalCount integer 示例值:1000​
列表总条数​
​
NextToken string 示例值:abcdefghijklmn​
下次分页的字符串,用于放在请求参数里的NextToken​
​
Statuses object[] 示例值:参考响应示例​
音色列表​
SpeakerID string 示例值:S_foobar​
音色ID​
​
InstanceNO string 示例值:Model_storage_mefoobar​
火山引擎实例Number​
​
IsActivable string 示例值:true​
是否可激活​
​
State string 示例值:Training​
音色状态,Unknown、Training、Success、Active、Expired、Reclaimed​
详见附录:State状态枚举值​
​
DemoAudio string 示例值:https://example.com​
试听url公网链接,只有success和active状态有​
​
Version string 示例值:v1​
SpeakerID已训练过的次数​
​
CreateTime long 示例值:1700727790000​
unix epoch格式的创建时间,单位ms​
​
ExpireTime long 示例值:1964793599000​
到期时间, 为空的时候表示永远生效​
​
OrderTime long 示例值:1701771990000​
下单时间​
​
Alias string 示例值:foobar​
模型别名,和控制台同步​
​
AvailableTrainingTimes integer 示例值:10​
剩余训练次数​
​
​
​
​
请求示例​
​
POST /?Action=BatchListMegaTTSTrainStatus&Version=2025-05-21 HTTP/1.1​
Host: https://open.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20250711T035336Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250711/cn-beijing/speech_saas_prod/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"ProjectName": "xxx",​
"SpeakerIDs": [​
"S_x123"​
],​
"State": "Training",​
"OrderTimeStart": 1752204841000,​
"OrderTimeEnd": 1752204841000,​
"ExpireTimeStart": 1752204841000,​
"ExpireTimeEnd": 1752204841000,​
"PageNumber": 1,​
"PageSize": 10,​
"NextToken": "abcdefghijklmn",​
"MaxResults": 10​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20250711115347211075189135E05683",​
"Action": "BatchListMegaTTSTrainStatus",​
"Version": "2025-05-21",​
"Service": "speech_saas_prod",​
"Region": "cn-beijing"​
},​
"Result": {​
"PageNumber": 1,​
"PageSize": 100,​
"TotalCount": 1000,​
"NextToken": "abcdefghijklmn",​
"Statuses": [​
{​
"SpeakerID": "S_foobar",​
"InstanceNO": "Model_storage_mefoobar",​
"IsActivable": "true",​
"State": "Training",​
"DemoAudio": "https://example.com",​
"Version": "v1",​
"CreateTime": 1700727790000,​
"ExpireTime": 1964793599000,​
"OrderTime": 1701771990000,​
"Alias": "foobar",​
"AvailableTrainingTimes": 10​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
The specified parameter %s is invalid.​
​
400​
OperationDenied.InvalidSpeakerID​
illegal status to update​
​
400​
OperationDenied.InvalidInstanceNO​
illegal instance number​
​
​
SDK​
下表提供了豆包语音支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包、查看指导文档。​
​
类别​
编程语言​
Github地址​
SpeechSaasProd​
Java​
​
Go​
​
Python​
​
PHP​
​
​
最近更新时间:2026.09.28 21:21:22
这个页面对您有帮助吗?
有用
有用
无用
无用