API: Voice/Template - 语音模板管理

概览

voice/template 是 SUBMAIL 的语音模板 API。
使用 voice/template 可以获取、创建、编辑或删除您的语音模板。


语音模板支持两种类型：

• 文本模板
• 音频模板

URL

https://api-v4.mysubmail.com/voice/template

支持格式

HTTP 请求方式

是否需要授权

是


sign_type为md5、sha1、sha256时，请将appid、sign_type、timestamp按首字母正序排列，然后把key=value以&富豪连接，并在两侧拼接appid和appid，然后以对应的加密方法处理
示例：appid+appkey+appid=12345&sign_type=md5×tamp=1701234567+appid+appkey (加号为拼接符号，实际不包含)

GET 方法（获取模板列表）

请求参数

代码示例

curl -s "https://api-v4.mysubmail.com/voice/template.json?appid=your_appid&signature=your_appkey&page=1&rows=10"

返回示例

{
    "status": "success",
    "templates": [
        {
            "template_id": "uMnmq2",
            "title": "验证码模板",
            "message": "您的验证码是：123456",
            "voice_type": 0,
            "create_at ": 1654470015,
            "edited_at ": 1654470015,
            "template_status": 2,
            "template_status_description": "审核通过",
            "voice_type": 0,
        }
    ],
    "rows": 1,
    "page": 1
}

获取单个模板

curl -s "https://api-v4.mysubmail.com/voice/template.json?appid=your_appid&signature=your_appkey&template_id=uMnmq2"

{
    "status": "success",
    "template": {
        "template_id": "uMnmq2",
        "title": "验证码模板",
        "message": "您的验证码是：123456",
        "voice_type": 0,
        "create_at ": 1654470015,
        "edited_at ": 1654470015,
        "template_status": 2,
        "template_status_description": "审核通过"
    }
}

POST 方法（创建模板）

请求参数

创建文本模板

curl -d "appid=your_appid&signature=your_appkey&voice_type=0&title=验证码模板&message=您的验证码是：@var(code)" https://api-v4.mysubmail.com/voice/template.json

{
    "status": "success",
    "template_id": "FsoAF3"
}

创建音频模板

curl -F "appid=your_appid" \

 -F "signature=your_appkey" \
 -F "voice_type=1" \
 -F "title=通知模板" \
 -F "message=备注信息" \
 -F "file=@/path/to/audio.wav" \
 https://api-v4.mysubmail.com/voice/template.json

{
    "status": "success",
    "template_id": "XyZkL9"
}

PUT 方法（更新模板）

请求参数

更新文本模板

curl --data "appid=your_appid&signature=your_appkey&template_id=FsoAF3&title=新标题&message=新内容" -X PUT https://api-v4.mysubmail.com/voice/template.json

{
    "status": "success"
}

DELETE 方法（删除模板）

请求参数

代码示例

curl --data "appid=your_appid&signature=your_appkey&template_id=FsoAF3" -X DELETE https://api-v4.mysubmail.com/voice/template.json

{
    "status": "success"
}

返回值说明

模板状态码

参阅 API 错误代码