/ 接口详情
语音合成
把输入文字内容转换成语音
接口信息
GET / POST
api-v2.317ak.com/api/yljk/yuyhc/api.php
请求参数
| 参数名 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| key | string | 是 | 接口调用密钥 | |
| msg | string | 否 | 转换语音的文本 | 你好 |
| jue | string | 否 | 角色名称或ID，默认：云希，不写参数则输出角色列表 | 云希 |
| type | string | 否 | 输出类型，可选：json/text/mp3，默认：json | json |
[
{
"name": "key",
"type": "string",
"required": true,
"description": "接口调用密钥",
"example": ""
},
{
"name": "msg",
"type": "string",
"required": false,
"description": "转换语音的文本",
"example": "你好"
},
{
"name": "jue",
"type": "string",
"required": false,
"description": "角色名称或ID，默认：云希，不写参数则输出角色列表",
"example": "云希"
},
{
"name": "type",
"type": "string",
"required": false,
"description": "输出类型，可选：json/text/mp3，默认：json",
"example": "json"
}
]
{
"openapi": "3.1.1",
"info": {
"title": "语音合成",
"description": "把输入文字内容转换成语音",
"version": "1.0.0"
},
"paths": {
"/api/yljk/yuyhc/api.php": {
"get": {
"summary": "语音合成",
"description": "把输入文字内容转换成语音",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "接口调用密钥"
},
{
"name": "msg",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "你好"
},
"description": "转换语音的文本"
},
{
"name": "jue",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "云希"
},
"description": "角色名称或ID，默认：云希，不写参数则输出角色列表"
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "json"
},
"description": "输出类型，可选：json/text/mp3，默认：json"
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"post": {
"summary": "语音合成",
"description": "把输入文字内容转换成语音",
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "接口调用密钥"
},
{
"name": "msg",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "你好"
},
"description": "转换语音的文本"
},
{
"name": "jue",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "云希"
},
"description": "角色名称或ID，默认：云希，不写参数则输出角色列表"
},
{
"name": "type",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "json"
},
"description": "输出类型，可选：json/text/mp3，默认：json"
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
}
},
"servers": [
{
"url": "https://api-v2.317ak.com",
"description": "当前访问入口（https）"
}
]
}
返回示例
{
"result": true,
"message": "成功",
"url": "https://texvoz.s3.us-central-1.wasabisys.com/nKt2XGaAo9bd8a3bba9bc8ee378605462be34b464SyjeWRLEw.mp3",
"role": "云希"
}
详细文档
语音合成
接口说明
将输入的文字内容转换为语音，适用于需要语音生成能力的应用场景。
娱乐接口，用户可通过接口快速获取文字对应的语音结果。
调用地址
https://api-v2.317ak.com/api/yljk/yuyhc/api.php
请求方式
GET, POST
鉴权说明
接口调用需要密钥。
首选鉴权方式：Query
请求时添加参数：
key=接口调用密钥
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
key |
string | 是 | 接口调用密钥，需通过 Query 参数 key 传递。 |
msg |
string | 否 | 转换语音的文本，例如：你好。 |
jue |
string | 否 | 角色名称或 ID，默认角色为云希；不填写该参数时输出角色列表。 |
type |
string | 否 | 输出类型，可选值：json、text、mp3，默认值为 json。 |
成功响应示例
{
"result": true,
"message": "成功",
"url": "https://texvoz.s3.us-central-1.wasabisys.com/nKt2XGaAo9bd8a3bba9bc8ee378605462be34b464SyjeWRLEw.mp3",
"role": "云希"
}响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
result |
boolean | 请求处理结果，成功时返回 true |
message |
string | 返回提示信息 |
url |
string | 生成语音文件的访问地址 |
role |
string | 本次生成语音使用的角色名称 |
错误响应示例
接口发生错误时，将返回 JSON 格式错误信息，示例如下：
{"code":0,"msg":"未提供调用密钥","errcode":11001}业务错误码说明
| errcode | 含义 |
|---|---|
| 11001 | 未提供调用密钥 |
| 11002 | 密钥错误 |
| 11003 | 密钥已禁用 |
| 11004 | 积分余额不足 |
| 11005 | 请求过于频繁（QPM 限制） |
| 11006 | 接口维护中 |
| 11007 | 接口已禁用 |
| 11008 | 接口不可用 |
| 11009 | 密钥校验暂不可用 |
| 11010 | 积分系统暂不可用 |
| 11011 | 收费接口须提供有效密钥 |
| 11012 | 鉴权方式错误 |
| 11013 | 接口不存在 |
| 11014 | 地址无效 |
| 11015 | 地址不允许 |
| 11016 | 请求失败 |
| 11017 | 服务暂不可用 |
| 11018 | 请求方式不允许 |
| 11019 | 当前IP不在白名单内 |
| 11020 | 启用出口功能须提供有效密钥 |
| 11021 | 未配置可用出口服务 |
| 11022 | 出口服务不可用 |
| 11023 | 密钥已过期 |
| 11024 | 令牌分配积分不足 |
调用示例
终端 curl（bash）
curl -G "https://api-v2.317ak.com/api/yljk/yuyhc/api.php" \
--data-urlencode "key=你的接口密钥" \
--data-urlencode "msg=你好" \
--data-urlencode "jue=云希" \
--data-urlencode "type=json"PHP
// PHP
$url = "https://api-v2.317ak.com/api/yljk/yuyhc/api.php?key=你的接口密钥&msg=你好&jue=云希&type=json";
$response = file_get_contents($url);
echo $response;注意事项
- 调用接口时必须提供有效接口调用密钥，请妥善保管密钥信息，避免将密钥直接暴露在前端代码、公开仓库或可被他人获取的位置。
- 接口仅支持通过 Query 参数
key传递密钥，请按照要求完成鉴权后再发起请求。 - 建议使用 HTTPS 调用地址进行请求，确保请求过程中的数据传输安全。
msg参数用于提交需要转换的文本内容，未填写时接口将根据jue参数返回角色列表信息。jue参数用于指定语音角色名称或 ID，不填写时默认使用云希角色；使用自定义角色时请确保角色名称或 ID 有效。type参数用于指定返回格式，可选json、text、mp3，不填写时默认返回json格式。- 请求文本内容应控制在合理范围内，过长文本可能影响处理速度或返回结果体验。
- 请根据实际使用场景合理控制请求频率，避免短时间内大量重复调用影响接口稳定性。
- 返回成功后，可根据返回结果中的语音地址获取生成的音频内容，请注意妥善处理相关数据。
快速上手
curl -G "https://api-v2.317ak.com/api/yljk/yuyhc/api.php" \
--data-urlencode "key=YOUR_API_KEY" \
--data-urlencode "msg=你好" \
--data-urlencode "jue=云希" \
--data-urlencode "type=json"
data=$(curl -sG "https://api-v2.317ak.com/api/yljk/yuyhc/api.php" --data-urlencode "key=YOUR_API_KEY")
echo "$data"在线测试
请求地址
api-v2.317ak.com/api/yljk/yuyhc/api.php
Method
参数
Response
// 结果将在此处显示
