互亿无线企业应用平台文档中心

营销短信API接口文档下载:  点击下载

1. GET短信提交接口示例

http://api.yx.ihuyi.com/webservice/sms.php?method=Submit&account=用户名&password=APIKEY&mobile=手机号码&content=短信内容【签名】

注:1. 请填写有实际意义的短信内容,避免用"短信测试、aaaaa"等字样。

       2.【签名】请用您的公司名、品牌名等。

例:尊敬的会员,您好,夏季新品已上市,请关注。退订回TD【互亿无线】

2. POST短信提交接口

http://api.yx.ihuyi.com/webservice/sms.php?method=Submit

接口说明
参数名称 参数值描述 是否必填
account 账户名(例如:cf_demo123)
password 1、APIKEY(32位字符串,可以登录用户中心查看)
2、动态密码(生成动态密码方式请看该文档末尾的说明)
mobile 接收手机号码, 多个号码请用英文逗号隔开
content 短信内容(编码格式为UTF-8,支持300个字的长短信,长短信按多条计费)
注:1、请填写有实际意义的短信内容,避免用"短信测试、aaaaa"等字样。
       2、【签名】请用您的公司名、品牌名等。
例:尊敬的会员,您好,夏季新品已上市,请关注。退订回TD【互亿无线】
time Unix时间戳(10位整型数字,当使用动态密码方式时为必填)
stime 指定短信下发时间(格式:2016-11-30 15:30:00)
format 返回格式(可选值为:xml或json,系统默认为xml)

用户通过http提交发送短信请求到服务器后,服务器会返回一串xml格式的字符串,结构说明如下:

SubmitResult结构说明:
参数名称 类型 描述
code int 返回值为2时,表示提交成功
smsid string 当提交成功后,此字段为流水号,否则为0
msg string 提交结果描述
示例(成功)
<?xml version="1.0" encoding="utf-8"?>
<SubmitResult xmlns="api.yx.ihuyi.com">
<code>2</code>
<msg>提交成功</msg>
<smsid>16113080595654</smsid>
</SubmitResult>
示例(失败)
<?xml version="1.0" encoding="utf-8"?>
<SubmitResult xmlns="api.yx.ihuyi.com">
<code>405</code>
<msg>用户名或密码不正确</msg>
<smsid>0</smsid>
</SubmitResult>
Code(返回代码)值说明
code msg
0 提交失败
2 提交成功
400 非法ip访问
401 帐号不能为空
402 密码不能为空
403 手机号码不能为空
4030 手机号码已被列入黑名单
404 短信内容不能为空
405 用户名或密码不正确
4050 账号被冻结
4051 剩余条数不足
4052 访问ip与备案ip不符
4053 未配置短信通道
406 手机格式不正确
407 短信内容含有敏感字符
4070 签名错误
4071 没有提交备案模板
4073 短信内容超出长度限制
408 定时发送的时间已经过期

注意:因运营商规则变化,如有返回值在上述表格中找不到,请咨询您的专属客服

3. GET帐户余额查询示例:

http://api.yx.ihuyi.com/webservice/sms.php?method=GetNum&account=用户名&password=APIKEY

4. POST帐户余额查询

http://api.yx.ihuyi.com/webservice/sms.php?method=GetNum

接口说明
参数名称 参数值描述 是否必填
account 账户名(例如:cf_demo123)
password 1、APIKEY(32位字符串,可以登录用户中心查看)
2、动态密码(生成动态密码方式请看该文档末尾的说明)
time Unix时间戳(10位整型数字,当使用动态密码方式时为必填)
format 返回格式(可选值为:xml或json,系统默认为xml)

用户通过http提交帐户余额查询请求到服务器后,服务器会返回一串xml格式的字符串,结构说明如下:

GetNumResult 结构说明:
参数名称 类型 描述
code int 状态返回值
msg string 查询结果描述
num string 剩余数量
示例(成功)
<?xml version="1.0" encoding="utf-8"?>
<GetNumResult xmlns="api.yx.ihuyi.com">
<code>2</code>
<msg>查询成功</msg>
<smsid>856</smsid>
</GetNumResult>
示例(失败)
<?xml version="1.0" encoding="utf-8"?>
<GetNumResult xmlns="api.yx.ihuyi.com">
<code>405</code>
<msg>用户名或密码不正确</msg>
<smsid>0</smsid>
</GetNumResult>
Code(返回代码)值说明
code msg
2 查询成功
400 非法ip访问
401 帐号不能为空
402 密码不能为空
405 用户名或密码不正确
4050 账号被冻结

5. GET获取用户上行示例

http://api.yx.ihuyi.com/webservice/sms.php?method=GetReply&account=用户名&password=APIKEY

6. POST获取用户上行

http://api.yx.ihuyi.com/webservice/sms.php?method=GetReply

接口说明
参数名称 参数值描述 是否必填
account 账户名(例如:cf_demo123)
password 1、APIKEY(32位字符串,可以登录用户中心查看)
2、动态密码(生成动态密码方式请看该文档末尾的说明)
time Unix时间戳(10位整型数字,当使用动态密码方式时为必填)
format 返回格式(可选值为:xml或json,系统默认为xml)

用户通过http提交获取用户上行请求到服务器后,服务器会返回一串xml格式的字符串,结构说明如下:

GetReplyResult 结构说明:
参数名称 类型 描述
code int 状态返回值(返回值为2时,表示查询成功)
msg string 用户回复内容,内容结构如下:
手机号,回复内容,回复时间,smsid |@|手机号,回复内容,回复时间,smsid
注意:|@|为信息分隔符
示例(成功)
<?xml version="1.0" encoding="utf-8"?>
<GetReplyResult xmlns="api.yx.ihuyi.com">
<code>2</code>
<msg>18930631111,测试用户上行,2016-11-06 22:45:39,491077105|@|15845431111,上行收到,2016-11-15 18:01:17,498496615</msg>
</GetReplyResult>
示例(失败)
<?xml version="1.0" encoding="utf-8"?>
<GetReplyResult xmlns="api.yx.ihuyi.com">
<code>405</code>
<msg>用户名或密码不正确</msg>
</GetReplyResult>
Code(返回代码)值说明
code msg
2 查询成功
400 非法ip访问
401 帐号不能为空
402 密码不能为空
405 用户名或密码不正确
4050 账号被冻结

注意:用户上行的内容只能获取一次,请自行在本地保存。

附件:生成签名方式

这里以PHP为例:
提交短信的生成方式:

$time=time();
$password=md5($account.$apikey.$mobile.$content.$time);

例如:

帐号:cf_test
APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d
手机号:138xxxxxxxx
内容:尊敬的会员,您好,夏季新品已上市,请关注。退订回TD【互亿无线】
time:1451544941
结果:$password=md5('cf_test1q784322ba1d9bb88d50cf5cdfd89k7d138xxxxxxxx尊敬的会员,您好,夏季新品已上市,请关注。退订回TD【互亿无线】1451544941');

查询剩余条数的生成方式:

$time=time();
$password=md5($account.$apikey.$time);

例如:

帐号:cf_test
APIKEY:1q784322ba1d9bb88d50cf5cdfd89k7d
手机号:138xxxxxxxx
time:1451544941
结果:$password=md5('cf_test1q784322ba1d9bb88d50cf5cdfd89k7d1451544941');

Unix时间戳参考地址:http://tool.chinaz.com/Tools/unixtime.aspx