DOC《平台接口文档》

平台接口文档 一.

平台协议说明 1. 接口通过HTTP形式访问,GET请求,调用参数注意大小写, 编码默认GB2312,(UTF8请在接口后台添加参数&code=utf8) 2. 所有接口访问地址和参数,都需区分大小写,一定需注意. 3. 所有接口如有错误,前端都会有一个False:后面则是错误信息,下面接口说明不在说明错误信息,其他为正确. 4. 当没有按照接口说明的参数去调用,参数没有携带完整,则系统会返回 False:信息不完整. 5.登录后,如果在10分钟没有再次用token访问其他接口信息,则登录token会被系统自动回收,如果再用以前的token去访问,则会返回:Session过期,这样需重新再次登陆,使用新的token. 6. 获取号码在20分钟内没有被用户释放,系统会强制进行释放. 7. 平台接口前缀:http://kapi.yika66.com:20153 二.接口说明 1. 获取区域 /User/getArea? 参数:无,注意?号需要加上 正确返回 重庆\n上海\n北京\n 请求地址:http://kapi.yika66.com:20153/User/getArea? 1. 获取项目 /User/getItems 参数: token: token [必须] tp: tp [固定值:ut] 请求地址:http://kapi.yika66.com:20153/User/getItems?token=token&tp=ut 正确返回 项目ID&项目名称&项目价格&项目类型\n项目ID&项目名称&项目价格&项目类型\n... 其中项目类型 1表示此项目用于接收验证码, 2表示此项目用户发送短信, 3表示此项目即可接收验证码,也可以发送短信 3. 登录 /User/login 参数: 账户名: uName [必须] 密码: pWord [必须] 开发者参数: Developer [可选,登陆平台查看] 请求地址:http://kapi.yika66.com:20153/User/login?uName=用户名&pWord=密码&Developer=开发者参数[注:请打开http://capi.yika66.com/Code.aspx?uName=用户名,获取开发者参数] 正确返回 登录token&账户余额&最大登录客户端个数&最多获取号码数&单个客户端最多获取号码数&折扣 4. 退出 /User/exit 参数: 账户名: token [必须] 无返回 5. 获取号码 /User/getPhone 参数: 项目代码:ItemId [必须] 登录token:token [必须] 指定号段:PhoneType=0 [必须] 指定运营商或指定号段 [不填为 0]

0 [随机]

1 [移动]

2 [联通]

3 [电信]

4 [国外号码] 130到189 是指定只获取11位数以内指定号段,如:PhoneType=136 是指定只获取分配136号段,PhoneType=135590 是指定只获取分配135590段的号码 指定获取号码:Phone [非必须] 如果要指定获取号码带上手机号 过滤指定获取号码:NPhone [非必须] 不要指定号段的号码,如:NPhone=170 是指定不要170号段,多个号段请用|分格如:NPhone=145|170|1712345 默认为空或0 获取数量:Count [非必须] 如不带,则默认为1 区域: Area [非必须] 指定卡商ID: devid [非必须] 指定卡商ID编号,如果不需要获取指定卡商的号码, 默认为空或0 专属对接KEY: Key [非必须] 私人专属对接Key,如果不是专属对接,该参数值为空,如果是专属对接可以填上对应专属Key 请求地址:http://kapi.yika66.com:20153/User/getPhone?ItemId=项目ID&token=登陆toke 正确返回: 13112345678;

13698763743;

13928370932;

注意:如果count数量为20,获取后,确只返回了10个号码,则证明系统已经没有那么多号码资源. 6. 获取消息队列 /User/getMessage?token=登陆token&ItemId=项目ID&Phone=获取的号码&code= 参数: token: token [必须] 号码: Phone [必须] 项目ID: ItemId [必须] 正确返回:【消息队列】 消息队列介绍: 1. 消息队列信息最后末尾为[End]结束 2. 消息队列信息划分都已 & 符号分割 3. 消息队列第一分割字符为命令类型 消息队列命令种类 第一次调用接口会获取网站的公告,第二次以后才是验证码,每获取完一次验证码都会返回用户状态信息 1. 用户状态信息: USER&余额&最大登录数&最大获取号码数&客户端最大获取号码数&折扣 短信内容: MSG&项目ID&号码&短信内容 发送状态: STATE&项目ID&号码&状态信息 号码释放通知 RES&项目ID&号码 多号号码返回的内容要根据手机号来分割获取验证码 7. 释放号码 /User/releasePhone 参数: token :token [必须] 号码列表:phoneList [必须] 号码列表格式: phone-itemId;