爱码手机验证码接收平台Http接口说明.docx
《爱码手机验证码接收平台Http接口说明.docx》由会员分享，可在线阅读，更多相关《爱码手机验证码接收平台Http接口说明.docx（13页珍藏版）》请在冰豆网上搜索。
爱码手机验证码接收平台Http接口说明
Http接口流程图
用户接入流程：
用户获取号码
注：
调用获取号码（httpUserGetMobileAction）接口时需要传入项目编号，可以调获取项目列表（httpGetProjectInfosAction）接口获得用户需要的项目编号。
接口地址：
http:
//httpUserGetMobileAction.do
调用方式：
GET、POST
调用实例：
获取两个项目调用示例：
成功返回：
111回车换行
获取号码1回车换行
获取号码2回车换行
获取号码3回车换行
…
获取号码N
非成功直接返回错误码
接口参数
参数
名称
描述
userID
用户ID
必选参数
password
密码
必选参数，密码为md5小写加密
size
获取数量
必选参数
projectID
项目编号
必选参数
状态码参数说明
111
获取号码成功
408
必选参数为空！
509
无法获取该项目。
600
获取号码提示：
操作过于频繁！
601
获取号码提示：
无可用号码！
602
获取号码提示：
项目不存在！
603
获取号码提示：
获取数大于系统限制,获取失败!
604
获取号码提示：
用户爱码币不足，无法获取号码!
请进行充值。
501
用户名确认失败。
611
获取号码提示：
获取后，获取号码数量大于限制获取数量，获取失败。
612
获取号码提示：
操作过于频繁!
已获取过多个项目，仅获取一次
430
同一个ip，在指定时间内只能调用一次。
调用频繁
获取项目
接口地址：
http:
///httpGetProjectInfosAction.do
调用方式：
GET、POST
调用实例：
/httpGetProjectInfosAction.do?
userID=userID&password=password
成功返回：
111回车换行
项目ID1;项目名称1;项目网址1;项目单价1回车换行
项目ID2;项目名称2;项目网址2;项目单价2回车换行
项目ID3;项目名称3;项目网址3;项目单价3回车换行
…
项目IDN;项目名称N;项目网址N;项目单价N
非成功直接返回错误码
注：
项目名称是经过编码转换的（URLEncoder.encode（fmt,"UTF-8"）），获取项目后请使用URLDecoder.decode（fmt,"UTF-8"）解码。
接口参数
参数
名称
描述
userID
用户ID
必选参数
password
密码
必选参数，密码为md5小写加密
状态码参数说明
111
获取项目成功!
408
必选参数为空！
501
用户名确认失败。
000
操作异常
接收验证码
接口地址：
httpGetCodeAction.do
调用方式：
GET、POST
调用实例：
成功返回：
111回车换行
手机号码1;对应验证码1回车换行
手机号码2;对应验证码2回车换行
手机号码3;对应验证码3回车换行
…
手机号码N;对应验证码N
非成功直接返回错误码
接口参数
参数
名称
描述
userID
用户ID
必选参数
password
密码
必选参数，密码为md5小写加密
projectID
项目ID
必选参数
mobile
手机号码
必选参数，多个号码以逗号隔开，最多不能超过235个
softWareID
软件厂商
可以为空，如果非软件指定传入为空值即可。
状态码参数说明
111
获取验证码成功
408
必选参数为空！
600
获取验证码失败，您的操作过于频繁
601
获取验证码失败，无可用号码供获取!
602
获取验证码失败，获取项目不存在!
603
获取验证码失败，获取号码数大于系统限制!
604
获取验证码失败，您的爱码币不足!
605
获取验证码失败，无验证码!
501
用户名确认失败。
000
操作异常
507
号码长度过多
430
同一个ip，在指定时间内只能调用一次。
调用频繁
查询已获取验证码号码
接口地址：
/httpGetCheckMobileAction.do
调用方式：
GET、POST
调用实例：
接口说明：
查询用户已获取验证码项目的号码。
成功返回：
111回车换行
获取号码1;项目编号1;获取时间1;项目名称1;项目单价1回车换行
获取号码2;项目编号1;获取时间1;项目名称1;项目单价1回车换行
获取号码3;项目编号1;获取时间1;项目名称1;项目单价1回车换行
…
获取号码N;项目编号N;获取时间N;项目名称N;项目单价N
非成功直接返回错误码
注：
项目名称是经过编码转换的（URLEncoder.encode（fmt,"UTF-8"）），获取号码后请使用URLDecoder.decode（fmt,"UTF-8"）解码。
接口参数
参数
名称
描述
userID
用户ID
必选参数
password
密码
必选参数，密码为md5小写加密
状态码参数说明
111
获取验证码号码成功
408
必选参数为空！
601
用户没有获取验证码号码
501
用户名确认失败。
000
操作异常
查询已获取发送指令号码
接口地址：
/httpGetOrderMobileAction.do
调用方式：
GET、POST
调用实例：
httpGetOrderMobileAction.do?
userID=userID&password=password
接口说明：
查询用户已获取发送指令项目的号码。
成功返回：
111回车换行
获取号码1;项目编号1;获取时间1;项目名称1;项目单价1回车换行
获取号码2;项目编号1;获取时间1;项目名称1;项目单价1回车换行
获取号码3;项目编号1;获取时间1;项目名称1;项目单价1回车换行
…
获取号码N;项目编号N;获取时间N;项目名称N;项目单价N
非成功直接返回错误码
注：
项目名称是经过编码转换的（URLEncoder.encode（fmt,"UTF-8"）），获取号码后请使用URLDecoder.decode（fmt,"UTF-8"）解码。
接口参数
参数
名称
描述
userID
用户ID
必选参数
password
密码
必选参数，密码为md5小写加密
状态码参数说明
111
获取发送短信号码成功
408
必选参数为空！
601
用户没有获取发送短信号码
501
用户名确认失败。
000
操作异常
用户查询爱码币
接口地址：
http:
//httpGetUserScoreAction.do
调用方式：
GET、POST
调用实例：
/httpGetUserScoreAction.do?
userID=userID&password=password
成功返回：
111回车换行
用户ID用户爱码币：
对应爱码币
非成功直接返回错误码
接口参数
参数
名称
描述
userID
用户ID
必选参数
password
密码
必选参数，密码为md5小写加密
状态码参数说明
111
获取用户爱码币成功
408
必选参数为空！
501
用户名确认失败。
000
操作异常
用户解锁获取号码
接口地址：
http:
//httpClearLockByUserAction.do
调用方式：
GET、POST
调用实例：
接口说明：
mobile号码为可选参数，如果为空值时：
解锁对应的项目id的所有获取的号码；如果mobile不为空值时：
则解锁对应项目上对应的号码，传入多个号码存在的将会解锁。
成功返回：
111
非成功直接返回错误码
接口参数
参数
名称
描述
userID
用户ID
必选参数
password
密码
必选参数，密码为md5小写加密
projectID
项目ID
必选参数
mobile
手机号码
可选参数，多个号码以逗号隔开，最多不能超过235个
状态码参数说明
111
解锁号码成功
408
必选参数为空！
501
用户名确认失败。
000
操作异常
222
没有相应的解锁号码
用户获取号码加黑
接口地址：
http:
//httpAddBlackMobileAction.do
调用方式：
GET、POST
调用实例：
接口说明：
加黑用户已获取的号码。
成功返回：
111
非成功直接返回错误码
接口参数
参数
名称
描述
userID
用户ID
必选参数
password
密码
必选参数，密码为md5小写加密
projectID
项目ID
必选参数
mobile
手机号码
必选参数，多个号码以逗号隔开，最多不能超过235个
状态码参数说明
111
加黑号码成功
408
必选参数为空！
501
用户名确认失败。
000
操作异常
222
没有相应的加黑号码
用户释放加黑号码
接口地址：
http:
//httpClearBlackMobileAction.do
调用方式：
GET、POST
调用实例：
接口说明：
mobile为可选参数，当传入为空值时：
将释放对应项目上所有的加黑号码；如果mobile不为空值时：
将释放存在项目上对应的号码。
成功返回：
111
非成功直接返回错误码
接口参数
参数
名称
描述
userID
用户ID
必选参数
password
密码
必选参数，密码为md5小写加密
projectID
项目ID
必选参数
mobile
手机号码
可选参数，多个号码以逗号隔开，最多不能超过235个
状态码参数说明
111
释放加黑号码成功
408
必选参数为空！
501
用户名确认失败。
000
操作异常
222
没有相应的释放加黑号码
用户发送指令短信
接口地址：
http:
//httpUserSendNoteAction.do
调用方式：
GET、POST
调用实例：
接口说明：
用户根据获取发送指令的项目，发送短信。
成功返回：
111
非成功直接返回错误码
接口参数
参数
名称
描述
userID
用户ID
必选参数
password
密码
必选参数，密码为md5小写加密
mobile
手机号码
必选参数
content
短信内容
必选参数，不能超过70位长度
projectID
项目ID
必选参数
状态码参数说明
111
发送短信成功
501
用户名确认失败。
000
操作异常
507
短信内容过长
508
用户爱码币不足，无法发送
509
没有获取发送短信的号码
510
项目接受短信为空，无法发送
511
号码已过期
升级会员 