API开发文档说明.docVIP

  • 42
  • 0
  • 约3.03千字
  • 约 6页
  • 2016-08-31 发布于天津
  • 举报
API开发文档说明.doc

API开发文档说明 技术QQ:305828666 系统可提供自动化API供开发者开发自动化程序,API同时支持GET和POST操作! 下面是系统API的说明:统一参数调用方法,下面是API的基地址 基地址: :8008/ActionApi 编码:UTF-8 post数据:参数名1=值1参数2=值2.... 如登录调用方法: posturl: :8008/ActionApi/loginIn post数据:uid=用户名pwd=密码 如获取号码调用方法: posturl: :8008/ActionApi/getMobilenum post数据:uid=用户登陆返回的pid=项目IDtoken=登陆返回的令牌 调用什么方法就在基地址后面加方法名,登陆成功后返回用户UID,后面调用方法请使用这个数字UID,而不是用户名,Cookie需要附带 所有API统一返回值含意 true:正常 no_data:没有匹配短信或者没收到短信 UserMax:已经达到了可以获取手机号的最大数量,不要随便调用cancelSMSRecvAll释放,否则之前获取的所有号码将会失效。 此处应当考虑到户用积分不足的情况,如果调用了cancelSMSRecvAll程序会进入死循环,会一直重复获取号码然后遇到UserMax然后cancelSMSRecvAll然后再重复以上过程。 API相关接口说明 [?方法?] loginIn?登录 接收参数: uid:用户名,参数必填 pwd:密码 参数拼接示例:uid=用户名pwd=密码 { Uid:当前登录用户的Uid,下面所有方法都要用到Uid InCome:100.00, Token:令牌字符串 } 接口备注: 返回值是JSON格式,注意提取Token令牌正确 接收参数: uid:登陆成功返回的Uid,数字编号,参数必填 pid:项目的ID,参数必填 token:登陆成功返回的Token令牌,参数必填 type:运营商类型(1:移动,2:联通,3:电信-不传默认随机,需要请附带),参数可空 province:地区(归属地默认随机,需要请附加,地区注意要url中文编码,比如传入广东就是province=%e5%b9%bf%e4%b8%9c,可百度中文url编码),如果没有运营商和归属地需求请不要传入,筛选条件越多可用号码资源就越少 平台归属地是动态的,换到哪里的号码就可用哪些地区的,获取可用地区的API是GetProvince(参数uid和token),返回当前平台所有可用号码的地区,参数可空 参数拼接示例:uid=用户编号pid=项目IDtoken=令牌type=可空province=可空 手机号 接口备注: No_Data表示暂无号码,或提示余额不足 [?方法?] getVcodeAndHoldMobilenum?获取验证码并继续使用这个手机号 接收参数: mobile:手机号码,参数必填 uid:登陆成功返回的Uid,数字编号,参数必填 pid:当前获取验证码项目的ID,参数必填 token:登陆成功返回的Token令牌,参数必填 next_pid:下一个接收项目的ID,参数必填 author_uid:开发者用户名,参数可空 拼接示例:mobile=手机号uid=用户编号token=令牌next_pid=下个要接收的项目IDauthor_uid=开发者用户名pid=项目ID 状态|验证码 接口备注: 返回值返回状态和验证码,Yes_Can表明号码可用,No_Exist表明号码可能被移除,不能继续使用 ? [?方法?] getVcodeAndReleaseMobile?获取验证码并不再使用这个手机号 接收参数: mobile:手机号码,参数必填 uid:登陆成功返回的Uid,数字编号,参数必填 pid:当前获取验证码项目的ID,参数必填 token:登陆成功返回的Token令牌,参数必填 author_uid:开发者用户名,参数可空 拼接示例:mobile=手机号uid=用户编号token=令牌author_uid=开发者用户名pid=项目ID 发送号码|验证码 接口备注: 收短信返回值以|号分隔,发短信项目返回状态信息(sending:发送中,ok:发送成功,fail:发送失败) ? [?方法?]?sendSms?发送短信 接收参数: phone:手机号码,参数必填 uid:登陆成功返回的Uid,数字编号,参数必填 pid:当前获取验证码项目的ID,参数必填 token:登陆成功返回的Token令牌,参数必填 sms:发送短信内容,固定标准内容,不需要传入,平台会自动填充,需要用户自己输入的内容,请按照标准格式,参数可空 author_uid:

文档评论(0)

1亿VIP精品文档

相关文档