淘码验证码平台接口文档说明.docx

淘码平台接口文档V1.0淘码验证码平台接口文档说明一、统一说明接口地址：:8888/http.do?action=接口统一编码：UTF-8接口调用方式：HTTP，支持GET和POST两种方式。GET调用方法：:8888/http.do?action=方法名&参数1=值&参数2=值（具体方法名及参数请参考接口方法）二、接口方法1. 获取手机号码1) 方法名：getMobiles2) 传入参数 userID：String 用户名（长度不超过16位英文及数字组成的名字） password：String密码（32位固定长度的MD5加密后的格式） projectID：int 项目ID（在官网查询获取需要的项目ID值） size：int 获取号码数量（0号码数=50,且小于帐号最大获取号码数）3) 方法调用返回值 成功返回：state:true,size:1,mobiles:,”1310001234”,message: 失败返回：state:false,size:0,mobiles:,message:失败原因失败原因包括：余额不足/操作频繁/参数错误/暂时没有可用号码，稍候获取/4) 调用说明 调用失败时，请根据返回的失败原因进行不同的操作，比如操作频繁或者无可用号码时，可以继续循环的取号；提示余额不足时，把取号程序暂停。参数错误时，请仔细检查参数及用户密码、或者是项目ID是否正确等。 取号成功的号码，将会得到独占权限，所以获取到的号码必须在5分钟内得到正确的运用，如果号码可以用，那就申请下发验证码然后调用getMessages获取短信验证码；如果号码不能用或者是一直获取不到短信验证码，那就调用addBlackMobiles将该号码加黑；2. 获取短信验证码并释放号码1) 方法名：getMessages2) 传入参数 userID：String 用户名（长度不超过16位英文及数字组成的名字） password：String密码（32位固定长度的MD5加密后的格式） mobiles：String 通过getMobiles获取来的手机号（支持多个号码同时获取，多个号码用半角逗号,隔开；0号码数=50） softAuthor: String 软件开发者用户名(可选, 若选可得10%消费分成) 。3) 方法调用返回值 成功返回：state:true,size:2, data: “mobile”:”,”msg”:”验证码短信”,“mobile”:”,”msg”:”验证码短信” , message: 失败返回：state:true,size:0, data: ,message:失败原因失败原因包括：余额不足/操作频繁/参数错误/暂时没收到短信/4) 调用说明 调用本方法成功获取号码之后，系统会自动释放独占号码数，不需要再次调用addBlackMobiles加黑方法。 建议在下发短信之后10秒开始调用本方法，如果提示暂时没有收到本短信，休眠10秒之后再取，连续取10次，如果还是没有收到，那就可以调用addBlackMobiles方法将该号码加入黑名单。3. 获取验证码并继续使用本号1) 方法名：getMessageAndHoldMobile2) 传入参数 userID：String 用户名（长度不超过16位，由英文及数字组成） password：String密码（32位固定长度的MD5加密后的格式） mobile：String 号码（通过getMobiles获取来的手机号，仅支持单个） nextProjectID=下个要接收的项目ID（可以填取号时候的项目ID，也可以是其他的项目ID） softAuthor: String 软件开发者用户名(可选, 若选可得10%消费分成) 。3) 方法调用返回值 成功返回：state:true, “mobile”:”,”msg”:”验证码短信”, message: 失败返回：state:false, “mobile”:”,”msg”:”, message:失败原因失败原因包括：余额不足/操作频繁/参数错误/暂时没收到短信/号码已经离线4) 调用说明 利用本方法可循环一直独占号码，适合需要一个号码获取多条短信的业务。 调用本方法不会释放号码，可以在获取最后一条短信的时候调用getMessages获取验证码并释放，或者调用本方法获取最后一条短信验证码再调用addBlackMobiles加黑释放。4. 添加号码黑名单1) 方法名：addBlackMobiles2) 传入参数 userID：String 用户名（长度不超过16位英文及数字组成的名字） password：String密码（32位固定长度的MD5加密后的格式） projectID：int 项目ID（跟调用getMobiles取号时的项目ID一致） mobiles：String 通过getMobiles获取来的手机号（支持多个号码同时获取，多个号码用半角逗号,隔开, 0号码数=50）3) 方法调用返回值 成功返回：state:true, “size”:1, message:成功加黑的号码，多个号码用逗号,隔开 失败返回：state:false, “size”:0, message:失败原因失败原因：操作频繁/参数错误/号码已经离线4) 调用说明 所有不可用号码及取不到短信验证码的号码都应调用本方法释放独占号码。 被成功加黑的号码会自动释放独占号码数，也不会再次被本帐号重新获取。 如果加黑失败，提示操作频繁，请在程序中重试加黑，要不然会一直独占。5. 获取帐号信息1) 方法名：getUserInfo2) 传入参数 userID：String 用户名（长度不超过16位英文及数字组成的名字） password：String密码（32位固定长度的MD5加密后的格式）3) 方法调用返回值 成功返回：state:true, account:,balance:1, maxMobileSize:100,message: 失败返回：state:false, accou