国际语音通知接口API开发文档
1、接口描述
请求支持 POST 和 GET 两种方法,字符编码为 utf-8。
支持全天24小时发送
2、请求地址
https://api.ihuyi.com/ivmn/Submit.json
3、请求头说明
| 参数名称 |
参数值描述 |
示例 |
类型 |
必填 |
| Content-Type |
内容类型,固定值 |
application/x-www-form-urlencoded |
string |
是 |
4、请求参数说明
| 参数名称 |
参数值描述 |
示例 |
类型 |
必填 |
| account |
APIID(用户中心【国际语音】-【国际语音通知】-【产品总览】查看) |
xxxxxxxx |
string |
是 |
| password |
1、APIKEY(用户中心【国际语音】-【国际语音通知】-【产品总览】查看) 2、动态密码(生成动态密码方式请看该文档末尾的说明) |
xxxxxxxxx |
string |
是 |
| mobile |
接收手机号码, 只能提交一个号码。(格式为:国家号+空格+手机号) |
1 978234523 |
string |
是 |
| content |
国际语音通知内容 |
Hello, your international parcel is now in transit. Please check the latest tracking details in your account. Thank you for shopping with us. |
string |
否 |
| time |
Unix时间戳(10位整型数字,当使用动态密码方式时为必填) |
1623643787 |
string |
否 |
5、响应参数
| 参数名称 |
参数值描述 |
示例 |
类型 |
必返 |
| code |
返回值为2时,表示提交成功 |
2|1 |
int |
是 |
| msg |
提交结果描述 |
提交成功|提交失败 |
string |
是 |
| voiceid |
当提交成功后,此字段为流水号,否则为0或空 |
16236437872836|0 |
string |
否 |
6、响应状态码说明
| code |
msg |
| 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条 |
| 4081 |
同一手机号一分钟之内发送超过3条 |
| 4082 |
超出同一手机号一天之内10条短信限制 |
| 4086 |
提交失败 |
7、GET传参示例
https://api.ihuyi.com/ivmn/Submit.json?account=xxxxxxxx&password=xxxxxxxxx&mobile=136xxxxxxxx&content=Hello, your international parcel is now in transit. Please check the latest tracking details in your account. Thank you for shopping with us.&templateid=1361&time=1623643787