测试账号联系博主
接口说明:客户接口部分提供http 和 WebService(目前只支持提交短信) 方式的接口,客户可以根据需求选择相应接口,接口编码方式默认采用UTF-8
注:国际短信与国内短信状态与上行获取地址一致,如果有国际与国内短信业务的需要,建议开多个账号,否则状态与上行会在同一个地址获取
第一章 短信发送接口
1.1 请求地址
请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是
https://dx.ipyy.net/I18NSms.aspx 对应国际短信的发送地址
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
1.2参数说明
参数名称 |
含义 |
说明 |
userid |
企业id |
企业ID(不验证) |
account |
发送用户帐号 |
用户帐号,由系统管理员 |
password |
发送接口密码 |
用md5加密方式,md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
mobile |
全部被叫号码 |
短信发送的目的号码.多个号码之间用半角逗号隔开 。 号码格式:国家区号+手机号码 例:8613800138000,86为国家区号,13800138000为手机号码 |
code |
编码方式 |
短信编码,0或8 ,默认为8,可选 8是中韩日俄等双字节文字(UNICODE编码) ,0是英文(ASII编码) 注: 1.UNICODE使用Big Endian 字节顺序, 2.目前仅支持8(UNICODE)编码 |
content |
短信内容 |
短信的内容,格式:内容+【签名】。 短信内容按照code编码后,需要转成16进制HEX字符串 短信计费条数:普通短信70字,长短信67字 |
sendTime |
定时发送时间 |
为空表示立即发送,定时发送格式2010-10-24 09:08:10 |
action |
发送任务命令 |
设置为固定的:send |
extno |
扩展子号 |
请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多5位数。 |
示例:
- 发送ascii(英文),短信内容:test message[HuaXin]
code 参数为0,内容ascii编码后转为16进制HEX字符串为:00740065007300740020006D006500730073006100670065005B00480075006100580069006E005D
http地址为:
https://dx.ipyy.net/I18Nsms.aspx?action=send&userid=&account=qq&password=123456&mobile=m1,m2&code=0&content=00740065007300740020006D006500730073006100670065005B00480075006100580069006E005D&sendTime=&extno=
- 发送UNICODE(中日韩文等),短信内容:测试【华信】
code 参数为8,内容unicode编码(使用Big Endian 字节顺序)后转为16进制HEX字符串为:
6D4B8BD53010534E4FE13011
http地址为: https://dx.ipyy.net/I18Nsms.aspx?action=send&userid=&account=qq&password=123456&mobile=m1,m2&code=8&content=6D4B8BD53010534E4FE13011&sendTime=&extno=
注:以上是Get方式提交,如果用POST 请将参数放入包体提交,建议使用post方式提交
1.3 国际短信返回值
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus> ---------- 返回状态值:成功返回Success 失败返回:Faild
<message>message</message> ---------- 相关的错误描述
<balance> balance</balance> ---------- 返回余额
<taskID>taskID</taskID> ----------- 返回本次任务的序列ID
<BillingAmount> BillingAmount </ BillingAmount > ---------- 返回本次扣费金额
<successCounts>successCounts</successCounts> --成功短信数:当成功后返回提交成功短信数
</returnsms>
第二章 余额查询接口
2.1 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
https://dx.ipyy.net/ I18NSms.aspx 国际短信余额查询地址
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
2.2 参数说明
参数名称 |
含义 |
说明 |
userid |
企业id |
企业ID |
account |
用户帐号 |
用户帐号,由系统管理员 |
password |
接口密码 |
用md5加密方式,md5彩用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03
|
action |
任务名称 |
设置为固定的:overage |
例如:
action=overage&userid=12&account=账号&password=密码
2.3 国际短信余额查询返回值
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus>-------返回状态值:成功返回Success 失败返回:Faild
<message>message</message>--------------返回信息提示:见下表
<payinfo>payinfo</payinfo>--------------返回支付方式 后付费,预付费
<balance>balance</balance>-------------返回余额
</returnsms>
返回信息提示 |
说明 |
操作成功 |
查询成功 将返回相应的支付方式、账户当前余额 |
用户名或密码不能为空 |
提交的用户名或密码为空 |
用户名或密码错误 |
表示用户名或密码错误 |