一个 HTTP 接口，
把语音通知接入业务。

接口简介

通过 HTTPS 调用语音通知服务，支持 GET / POST，采用 UTF-8 编码。以下示例使用 POST 表单请求与 .json 接口地址。

涵盖发送、余额查询、模板管理和回执推送。

Content-Type: application/x-www-form-urlencoded

请求体使用 URL 编码的表单参数；JSON 是响应格式，不是请求体格式。

接入准备

1. 注册账户并按要求完成认证。
2. 在用户中心获取语音通知产品的 API ID / API KEY。
3. 报备实际通知模板，确认审核通过后，用授权测试号码联调发送与回执。

认证与动态密码

可直接使用 API KEY，也可使用动态密码。将以下字段按顺序直接拼接（不加分隔符），以 UTF-8 编码计算 MD5，结果作为 password，并同时提交 time。

发送时，参与签名的 content 必须与实际提交的完整内容或变量字符串一致。凭据仅保存在服务端，勿写入前端页面。

发送语音通知

POST https://api.ihuyi.com/vm/Submit.json

支持全天 24 小时提交。先确定完整内容或模板变量发送方式，再填写对应参数。

请求参数

完整内容方式

提交已审核模板对应的完整语音内容；固定文字、标点及变量须符合模板设置。

content=已审核模板对应的完整通知内容

模板变量方式

系统调试模板 1361：您的订单号是：【变量】。已由【变量】发出，请注意查收。

templateid=1361
content=9633|顺风快递

这里 content 填写两项变量值，按模板顺序以 | 分隔。POST 时仍需对表单参数进行 URL 编码。

多语言代码示例

在服务端设置账户环境变量，替换为授权测试号码和已审核模板对应的完整内容。以下代码只作展示，页面不会发起呼叫。

import os
import requests

url = "https://api.ihuyi.com/vm/Submit.json"
data = {
    "account": os.environ["DXT_API_ID"],
    "password": os.environ["DXT_API_KEY"],
    "mobile": "YOUR_TEST_MOBILE",
    "content": "已审核模板对应的通知内容",
}

response = requests.post(
    url,
    data=data, timeout=10
)
response.raise_for_status()
print(response.json())
# 提交成功不等于呼叫成功，结果请结合回执判断。

发送响应

{
  "code": 2,
  "msg": "提交成功",
  "voiceid": "16236437872836"
}

提交成功仅表示平台接受请求，不代表用户已接听。保存 voiceid，通过发送回执关联最终呼叫结果。

余额查询

POST https://api.ihuyi.com/vm/GetNum.json

{
  "code": 2,
  "msg": "提交成功",
  "num": 123456
}

模板管理

提交模板

POST https://api.ihuyi.com/vm/AddTemplate.json

响应包含 code、msg；添加成功（code=2）时还返回整数类型 templateid。添加成功后，仍需等待审核结果再发送。

删除模板

POST https://api.ihuyi.com/vm/DelTemplate.json

响应字段为 code、msg；code=2 表示删除成功。

发送回执推送

提供并绑定服务端接收 URL。平台向该地址 POST 表单数据，采用 UTF-8 编码。

Content-Type: application/x-www-form-urlencoded

接收端记录数据后应及时输出纯文本 success（不含引号），复杂业务异步处理。未确认接收时，每个回执最多推送 3 次，每次间隔叠加 60 秒；需处理重复推送。

呼叫状态码

模板审核状态推送

同样通过 POST 表单推送到绑定的接收 URL，UTF-8 编码。

成功接收后输出纯文本 success。未确认接收时最多推送 3 次，每次间隔叠加 60 秒。

接口状态与错误码

发送接口

余额与模板接口

以上为接口业务 code，应与 HTTP 状态码分别处理。完整定义见官方接口文档。