国际语音平台接入流程指南
互亿无线国际语音平台开发接入指南
本文档用于指导开发者快速接入 互亿无线国际语音平台,支持以国际语音方式向全球用户发送验证码、通知、提示等内容。接口支持 POST 与 GET,字符编码统一为 UTF-8,可 24 小时稳定调用。
1、接口描述
互亿无线国际语音平台提供标准化 API,支持 POST 与 GET 两种请求方式,字符编码为 UTF-8。接口稳定、响应快速,可全天 24 小时发送国际语音验证码或通知内容。
2、请求地址
接口调用地址如下:
https://api.ihuyi.com/ivm/Submit.json
3、请求头说明
所有请求需携带以下请求头:
Content-Type: application/x-www-form-urlencoded(固定值,必填)
4、请求参数说明
调用接口需要传入以下参数:
- account: APIID(登录用户中心 → 国际语音 → 国际语音验证码 → 产品总览查看),必填。
- password: APIKEY 或动态密码(动态密码生成方式见文末说明),必填。
- mobile: 接收号码,格式为 “国家号+空格+手机号”,例如:
1 978234523,必填。 - content: 国际语音内容,例如
Your verification code is 6637,选填(如使用模板 ID,可不填)。 - time: Unix 时间戳(10 位整型),使用动态密码方式时为必填。
5、响应参数
接口返回 JSON,字段说明如下:
- code: 状态码,为 2 表示提交成功。
- msg: 提交结果描述,如“提交成功”、“提交失败”。
- voiceid: 流水号,仅成功提交时返回,失败为 0 或空。
6、响应状态码说明
以下为常见返回状态码与对应描述:
- 0:提交失败
- 2:提交成功
- 400:非法 IP 访问
- 401:帐号不能为空
- 402:密码不能为空
- 403:手机号码不能为空
- 4030:号码存在黑名单
- 404:语音内容不能为空
- 405:用户名或密码不正确
- 4050:账号被冻结
- 40505:未签订合同
- 4051:条数不足
- 4052:访问 IP 与备案 IP 不符
- 406:手机格式不正确
- 407:内容含敏感字符
- 4071:无备案模板
- 4072:内容与模板不匹配
- 40722:变量内容长度超限
- 4077:发送内容未报备
- 408:账户疑似被恶意利用,已冻结
- 4080:同一号码同 1 秒只能提交 1 次
- 4081:同一号码 1 分钟超过 3 条
- 4082:同一号码 1 天超过 10 条
- 4086:提交失败
7、GET 请求示例
以下为 GET 请求示例,可直接在浏览器或终端用于调试:
https://api.ihuyi.com/ivm/Submit.json?account=xxxxxxxx&password=xxxxxxxxx&mobile=1 978234523&content=Your verification code is 6637&templateid=1361&time=1623643787
8、接入流程说明
(1)注册账号,获得免费测试额度
访问互亿无线国际语音平台注册新账号,完成身份验证后即可获得免费测试额度,用于调试国际语音发送。
(2)获取 APIID 与 APIKEY
登录用户中心 → 国际语音 → 国际语音验证码 → 产品总览,即可查看 APIID 及 APIKEY,用于接口身份认证。
(3)根据接口文档调试
按照上述参数规则进行代码对接,可选择 POST 或 GET 调用方式。若使用动态密码方式,确保附带 time 字段。
(4)充值并购买套餐,正式上线使用
调试成功后,可根据业务量购买国际语音套餐,充值到账后即可稳定用于全球场景的验证码与通知发送。