国际短信API文档当前位置:首页 国际短信API文档
 

 一、接口说明

约定

  • 接口根地址: http:// m.isms360.com:8085/mt/MT3.ashx
  • 接口地址为:接口根地址 + 接口请求地址(见下面说明)
  • CP:用户方
  • SP:服务方(我方)
  • 下行短信(MT):CP方通过SP方发送短信到目的手机
  • 上行短信(MO):手机用户向一个特服号发送短信,短信经过SP转发给CP
  • DLR:短信报告

 二、下行短信接口(MT)

下行短信提交接口说明

请求地址 MT3.ashx
接口地址 http://m.isms360.com:8085/mt/MT3.ashx
说明: 下行短信接口
请求方式 POST
参数 必须 类型 说明
src string 用户登陆名
pwd string 用户登录密码
servicesid string 开通的业务,如SEND,可不填
dest string 目标手机号, 手机号码之间必须用英文逗号分割,最后一个手机号后不加逗号, 群发时一次最多可以同时提交100个号码
codec short 短信编码,0或8
8是中韩日俄等双字节文字(UNICODE编码) ,0是英文(ASII编码)
msg string unicode编码的短信长度最长为70个字(比如中日韩文)
ASII编码的短信长度最长为160个字符(英文)
time string 定时时间(约定时间发送)
sender string 可以为空,特服号或者短信显示号码,纯数字字符串,长度<14
返回结果 [msgid|errocod], [msgid|errocod], [msgid|errocod],
说明:[msgid|errocod] 每个号码对应一个,成功为msgid, 失败为 errocode
errcode 值 见附录

示例(短信内容编码后,需要转换成16进制HEX字符串):

1. 发送ASII(英文)短信(示例内容: test++test!),内容需做编码,然后转成HEX字符串: http://m.isms360.com:8085/mt/MT3.ashx?src=username&pwd=123456&ServiceID=SEND&dest=8613701234567&sender=1065777777 &msg=746573742B2B7465737421&codec=0

2. 发送UNICODE(中日韩文等)短信(示例内容:测试++!),内容需做编码,然后转成HEX字符串:: http://m.isms360.com:8085/mt/MT3.ashx?src=username&pwd=123456&ServiceID=SEND&dest=86137012345678&sender=106577777&msg=6D4B8BD5002B002BFF01&codec=8

注意:以上例子是 GET 方法提交,如果用POST 请将参数放入包体提交

 三、短信状态报告

CP主动获取方式

请求地址 GetXMLDr.ashx
接口地址 http://m.isms360.com:8085/GetXMLDr.ashx
说明 CP主动从SP获取短信报告,每次请求返回最多 300 个,采用HTTP协议
请求方式 GET 或 POST
参数 必须 类型 说明
User string 用户登陆名
Pwd string 用户登录密码
返回结果

<DR>
<MSG mobile="" status="" msgid="" submit_date="" done_date="" />
<MSG mobile="" status="" msgid="" submit_date="" done_date="" />
<MSG mobile="" status="" msgid="" submit_date="" done_date="" />
<MSG mobile="" status="" msgid="" submit_date="" done_date="" />
</DR>

说明/td>

MSG 元素属性说明:
mobile 接收者手机号, string
status 短信状态,string
msgid 短信唯一ID, 用户在短信提交时返回给用户的一个数字串msgid, string
submit_date 短信提交时间, string
done_date 完成时间, string

如果有其他错误,如:用户名密码错误,直接返回错误码

示例

<DR>
<MSG mobile="8613801380000" status="DELIVRD" msgid="120118363391006" submit_date="1412011836" done_date="1412011836" />
<MSG mobile="85264504258" status="DELIVRD" msgid="122312053680058" submit_date="1412231205" done_date="1412231205" />
<MSG mobile="6591505211" status="DELIVRD" msgid="021811594176937" submit_date="1502180459" done_date="1502180459" />
<MSG mobile="6593954319" status="DELIVRD" msgid="030415474870641" submit_date="1503040847" done_date="1503040939" />
</DR>

 四、上行短信(MO)

4.1 接收上行短信方法一:SP主动推送(HTTP GET)

请求地址 由CP(用户)方提供上行短信地址,格式为http URL地址,例如http://www.abc.com/mo.asp CP方需要把这个URL给SP(我方)进行配置。
说明 此方法为上行短信接口,采用标准HTTP GET协议,由CP方提供上行接口地址(URL),SP(我方)主动推送上行短信给CP,并将上行短信参数传给CP方的服务器,递交方式为HTTP GET。
请求方式 GET
参数 必须 类型 说明
mobile string 用户手机号码
spnumber string 特服号,接收用户上行短信的特服号,可能为空
message string 消息内容, 用户上行的消息内容
gw string 网关标识, 可置为空
cell string 小号, 用户接收短信的特服号的尾号, 可置为空
service string 业务代码, 可置为空
linkid string MO消息标识,可置为空
finger string 效验码,用于CP验证SP身份,把mobile+spnumber+message做MD5散列(如果不验证,可以不理会此参数)
返回结果 无要求,但必须有内容

示例

假定CP方提供的上行短信接口URL为http://www.abc.com/mo.asp, 一个手机用户发短信到指定特服号码(SP提供) ,SP会将此上行短信转发给CP,CP接收上行短信的格式如下:
http://www.abc.com/mo.asp?mobile=13701234567&message=测试&spnumber= 00447507329586&cell= &finger=33DED3D600B71BAE133B30B9C739FF7F

finger参数说明(此参数可以忽略)
finger参数用于用于CP验证SP身份:
假如:
CP的密码为 password =fdsa   手机号mobile=13521352133  特服号spnumber =00110011 。
message (内容为“测试短信”转码为GB2312格式) =%B2%E2%CA%D4%B6%CC%D0%C5
这样就是对   fdsa1352135213300110011%B2%E2%CA%D4%B6%CC%D0%C5   做MD5散列 结果finger就是   8aecc4968e1fd61227cd43f8ec5216a3

4.2 接收上行短信方法二,CP主动获取方式

请求地址 http://m.isms360.com:8085/mo/mo.ashx
接口地址 http://m.isms360.com:8085/mo/mo.ashx
说明 由SP方提供上行短信接口地址(URL),CP主动从SP获取上行短信,采用标准HTTP GET或POST协议
请求方式 GET 或 POST
参数 必须 类型 说明
uid string 用户登陆名
psw string 用户登录密码
返回结果

<MO>
   <MSG mobile="" cc="" spnumber="" message="" id="" time="" codec="utf-8" />
   <MSG mobile="" cc="" spnumber="" message="" id="" time="" codec="utf-8" />
   <MSG mobile="" cc="" spnumber="" message="" id="" time="" codec="utf-8" />
   <MSG mobile="" cc="" spnumber="" message="" id="" time="" codec="utf-8" />
</MO>

说明

MSG 元素属性说明:
mobile 发送者号码
cc 国家代码
spnumber 特服号
message  短信内容, 使用 codec 编码的 UrlEncode
id 上行短信的id,唯一辨识
codec 默认 utf-8
time:时间,如:2016-06-16 14:18:45

如果其他错误,如:用户名密码错误,直接返回错误码

示例

<MO>
<MSG mobile="8613801380000" spnumber="6285574719971" cc="86" message="%e5%8f%af%e5%8f%a3%e5%8f%af%e4%b9%90" id="3773" codec="utf-8" />
<MSG mobile="6289606574683" spnumber="6285574719971"  cc="62" message="How+to+get+giveaway" time="2016-06-16 14:18:45"  id="3777" codec="utf-8" />
<MSG mobile="6289606574683" spnumber="6285574719971"  cc="62" message="Give+me+giveaway+now"  time="2016-06-16 14:18:45"  id="3778" codec="utf-8" />
</MO>

 五、余额查询

余额查询接口

请求地址 querybalance.ashx
接口地址 http://m.isms360.com:8085/querybalance.ashx
说明 查询账户余额
请求方式 POST
参数 必须 类型 说明
User string 用户登陆名
Pwd string 用户登录密码
返回结果

余额 foat

如果其他错误,如:用户名密码错误,直接返回错误码
 

 附录 错误码

定义 状态码 描述
SEND_SUC >0整数 发送成功 返回MSGID
SEND_ERROR services not in use -01 系统维护中,请联系客服
NOT_ENOUGHCREDITS -02 当前账号余额不足
ACCOUNT_BLOCKED -03 帐号停止
NETWORK_NOTCOVERED -04 目的号码运营商不在服务覆盖范围
DEST_NUMBER_EXCEED_MAX(30) -05 目的手机号码数量超长(30/次,超30个请自行做循环)
INVALID_USER_OR_PASS -06 用户或密码错误
MISSING_DESTINATION_ADDRESS -07 目的号码不能为空
MISSING_SMSTEXT -08 短信内容不能为空
MISSING_SENDERNAME -09 源号码不能为空
DEST_INVALIDFORMAT -10 DEST参数格式错误
MISSING_USERNAME -11 用户名空
MISSING_PASS -12 密码空
NETWORK_FAIL -13 网络错误
INTERAL_ERROR -14 内部错误
INVALID_DESTINATION_ADDRESS -15 非法手机号码,手机号码格式不对
INVALID_SMS_MAX_LENGTH -16 短信内容超长!(UNICODE最大70个字符,Alphabet编码(英文即以此方式传输)最大160字符)
BLACKWORD_IN_SMS -17 短信内容含有非法字符
DEST_IN_BLACKLIST -18 目的手机号码限制
INVALID_DCS -19 短信内容编码不对(比如发中文、韩文、日文而用Alphabet编码方式)
INVALID_IDS -50 非法的 IDS