系统API的说明

http://api.ixinsms.com/api/do.php?action=

UTF-8

HTTP,支持GET和POST两种方式。

http://api.ixinsms.com/api/do.php?action=方法名&参数1=值&参数2=值(具体数据请参考接口方法)

所有API成功统一返回 1|其它信息|其它信息....,失败统一返回0|失败提示信息。

例如:登录时提交了正确的用户密码,那么返回为1| 113c08c7fb4495139a65edfed767795e(其中1表示是成功了,后面的113c08c7fb4495139a65edfed767795e是API返回的token),如果提交了错误的账号密码,那么返回的结果是0|登录失败,用户不存在或密码不正确(0表示失败了,“登录失败,用户不存在或密码不正确”是失败的原因)。

用户登录

loginIn


1. name:用户名
2. password:密码

http://api.ixinsms.com/api/do.php?action=loginIn&name=用户名&password=密码


1.成功返回:1|token(token是重要的返回参数,后面所有的请求都要传这个参数值)
2.失败返回:0|错误信息

获取用户个人信息

getSummary


1.token=登录时返回的令牌

http://api.ixinsms.com/api/do.php?action=getSummary&token=登录时返回的令牌


1.成功返回:1|余额|等级|批量取号数|用户类型
2.失败返回:0|错误信息

获取手机号码

getPhone


1.sid=项目ID
2.token=登录时返回的令牌

http://api.ixinsms.com/api/do.php?action=getPhone&sid=项目ID&token=登录时返回的令牌


1.成功返回:1|手机号码
2.失败返回:0|错误信息(系统暂时没有可用号码,请过3秒再重新取号|余额不足|其它错误信息)


1.size=要获取手机号数量。
2.phone=你要指定获取的号码,传入号码不正确的情况下,获取新号码.
3.phoneType=CMCC,CMCC是指移动,UNICOM是指联通,TELECOM是指电信
4.vno=0或1,0是指排除所有虚拟运营商号码,1是只获取虚拟运营商号码,如果没有需求,则不用传入此参数
5.locationMatching、locationLevel、location三个必须一起使用。用来指定获取某个地区的号码
5.1 locationMatching=include(包含区域) 或 locationMatching=exclude(排除区域)
5.2 locationLevel=p(省份) 或 locationLevel=c(城市)
5.3 location=(要包含或排除的省份或城市,该值对应locationLevel)
5.4 locationMatching、locationLevel、location三个必须一起使用。用来指定取某些区域的手机号或者不要某些区域的手机号.
locationMatching的参数值只能是include或者exclude中的一个。include指的是包含区域,exclude指的是不包含区域
locationLevel参数只能是p或者c中的一个。p指的是省(province),c指的是市(city)
location指的是具体地区,中文值。需要utf8编码一下

GET方式调用实例(指定地区调用):
http://api.ixinsms.com/api/do.php?action=getPhone&sid=项目ID&token=登录时返回的令牌 &locationMatching=include&locationLevel=p&location=广西

成功返回值:1|手机号
失败返回值:0|错误信息(系统暂时没有可用号码,请过3秒再重新取号|余额不足|其它错误信息)


第一条取出短信后,再调用获取手机号指定手机号调用实例:
http://api.ixinsms.com/api/do.php?action=getPhone&sid=项目id&phone=手机号&token=登录时返回的令牌

获取验证码

getMessage


1.使用该方法获得验证码后,系统自动加黑该号码
2. 因部分短信可能延迟,所以建议该方法每5秒调用一次,调用100秒(可增加获取成功率)


1. sid=项目ID
2. phone=取出来的手机号
3. token=登录时返回的令牌
4. author=开发者用户名(可选,这里是传作者注册时的用户名)

http://api.ixinsms.com/api/do.php?action=getMessage&sid=项目id&phone=取出来的手机号&token=登录时返回的令牌


1.成功返回:1|短信内容
2.失败返回:0|错误信息
• 备注:当返回0|还没有接收到短信,请过3秒再试,请软件主动3秒再重新取短信内容。一般项目的短信在30秒左右能取到,个别比较慢的也应该在3分钟左右能取到。所以重试间隔3秒的情况下一般循环获取20~60次之间即可。如果一超过60次取不到短信,可以加黑该手机号

加黑无用号码

addBlacklist


1.sid=项目ID
2.phone=取出来的手机号
3.token=登录时返回的令牌

http://api.ixinsms.com/api/do.php?action=addBlacklist&sid=项目id&phone=要加入黑名单的手机号&token=登录时返回的令牌


1.成功返回:1|操作成功
2.失败返回:0|错误信息
注意:如果该手机号是正常取到了短信,是不用操作加入黑名单和释放该手机号的

释放指定手机号

cancelRecv


1.sid=项目ID
2.phone=要释放的手机号(仅限单个号码)
3.token=登录时返回的令牌

http://api.ixinsms.com/api/do.php?action=cancelRecv&sid=项目id&phone=要释放的手机号&token=登录时返回的令牌


1.成功返回:1|操作成功
2.失败返回:0|错误信息

释放当前用户下所有手机号

cancelAllRecv


1.token=登录时返回的令牌

http://api.ixinsms.com/api/do.php?action=cancelAllRecv&token=登录时返回的令牌


1.成功返回:1|操作成功
2.失败返回:0|错误信息