重要申明：未收到短信的情况下，请主动调用释放接口，否则在后台强制释放前收到了短信照样计费

API接口协议文档

前言

  • 接口地址：http://www.firefox.fun/yhapi.ashx
  • 接口说明：汉字使用url编码
  • 请求方式：仅支持get请求

尽可能把每次调用接口返回值保存日志，需要技术协助时，必须提供接口返回日志

接口返回“1|*”表示接口请求成功，返回“0|*”表示接口请求失败。*表示信息内容

登录

  • 该接口尽量只调用1次，在启动脚本的时候调用，无需循环调用
  • Token在未修改账户密码前提下不变
  • 请求参数说明：
    • 参数名 参数值 必传 参数说明
    act login 是 固定值，不允许修改
    ApiName Api用户名 是 非注册用户名，正确格式：*#（*表示注册时用户名，#表示2个随机数字）[点击查看ApiName]登录后在：API对接--我的APIName模块
    PassWord 登陆密码 是 注册时的登陆密码
  • 请求示例：?act=login&ApiName=12348&PassWord=1231
  • 成功返回：1|token值
  • 失败返回：0|失败代号
  • 失败代号说明：
    • 失败代号 代号说明
    -1 用户账号不允许为空
    -2 用户账号长度必须在3-30之间
    -3 用户账号不能包含特殊符号“|”
    -4 用户账号不能包含汉字
    -5 用户密码不允许为空
    -6 用户密码长度必须在3-30之间
    -7 同IP情况下,上次请求失败,1分钟后重试【请确保Api用户名与登录密码正确再重试】
    -8 账号已被禁用
    -9 账号或密码错误

帐号信息

  • 请求参数说明：
    • 参数名 参数值 必传 参数说明
    act myInfo 是 固定值，不允许修改
    token 登录接口返回的token值 是 登录接口返回的token值
  • 请求示例：?act=myInfo&token=b7c94daad5e3dd71ffca9298976ec0d4_3
  • 成功返回：1|用户余额|用户等级|用户积分
  • 失败返回：0|失败代号
  • 失败代号说明：
    • 失败代号 代号说明
    -1 Token不存在
    -2 token失效,请重新调用登陆接口
    -3 请延时60秒后再请求，该接口调用频率60秒/次

获取手机号

  • 请求参数说明：
    • 参数名 参数值 必传 参数说明
    act getPhone 是 固定值，不允许修改
    token 登录接口返回的token值 是 登录接口返回的token值
    iid 项目ID 是 在项目表查看
    country 国家代码 在国家代码查看，不传则随机获取某个国家
    did 开发者ID 在开发者端查看
    dock 返回对接码 0/空 或 1；0/空 代表不返回对接码，1代表返回对接码
    maxPrice 最大单价 不输入或输入0，则不启用此功能，输入后将自动加入符合条件的专属对接
    mobile 指定号段或手机号 获取指定号段或手机号的号码
    pushUrl 推送链接 短信推送链接。点击查看详细说明
  • 请求示例：?act=getPhone&token=b7c94daad5e3dd71ffca9298976ec0d4_3&iid=1001&did=&country=&dock=&maxPrice=10&mobile=&pushUrl=
  • 成功返回：1|pkey|提取时间|国家代码|国家区号|归属地|端口号|手机号|对接码
  • 失败返回：0|失败代号
  • 失败代号说明：
    • 失败代号 代号说明
    -1 暂时无号
    -2 Token不存在
    -3 项目ID不存在
    -4 国家代码有误
    -5 项目未审核
    -6 项目已禁用
    -7 用户已禁用
    -8 余额不足,请充值
    -9 占号过多,请补充余额【未收到验证码强烈建议主动调用释放接口，否则在余额不多的情况下会提示占号过多】
    -10 项目不允许指定取号
    实现多次收码
  • 流程：获取手机号-->触发第一个短信-->获取验证码-->指定手机号获取-->触发第二个短信-->获取验证码-->依此类推

获取验证码

  • 请求参数说明：
    • 参数名 参数值 必传 参数说明
    act getPhoneCode 是 固定值，不允许修改
    token 登录接口返回的token值 是 登录接口返回的token值
    pkey 获取手机号返回的pkey值 是 获取手机号返回的pkey值
  • 请求示例：?act=getPhoneCode&token=b7c94daad5e3dd71ffca9298976ec0d4_3&pkey=0524EA1B2A4DC810E3E535BE036C2C170E914ECC4D46ED19
  • 成功返回：1|验证码数字|完整短信内容
  • 失败返回：0|失败代号
  • 失败代号说明：
    • 失败代号 代号说明
    -1 Token不存在
    -2 pkey无效
    -3 等待验证码,5秒后重新调用
    -4 已离线或强制释放【请做好此判断，可以避免多个手机同时获取到相同号码的错觉】
    -5 号码已强制加黑
    没有收到短信都是以失败返回

发送短信

  • 请求参数说明：
    • 参数名 参数值 必传 参数说明
    act sendCode 是 固定值，不允许修改
    token 登录接口返回的token值 是 登录接口返回的token值
    pkey 获取手机号返回的pkey值 是 获取手机号返回的pkey值
    receiver 接收方号码 是 接收短信的号码，如：10086
    smscontent 短信内容 是 请勿发送违法短信
  • 请求示例：?act=sendCode&token=b7c94daad5e3dd71ffca9298976ec0d4_3&pkey=0524EA1B2A4DC810E3E535BE036C2C170E914ECC4D46ED19&receiver=10086&smscontent=cxye
  • 成功返回：1|
  • 失败返回：0|失败代号
  • 失败代号说明：
    • 失败代号 代号说明
    -1 Token不存在
    -2 pkey无效
    -3 接收号码不能为空
    -4 提交短信不能为空
    -5 未知错误码
    -6 手机号不存在或已释放【请做好此判断，可以避免多个手机同时获取到相同号码的错觉】
    -7 手机号状态不可用，一般是手机号已经回码了
    -8 收码项目不允许发送短信
    -9 项目未设置关键字,请联系平台
    -10 发送内容不符合规则
    -11 发送内容重复提交

获取发短信回执

  • 使用【获取验证码接口】来获取短信发送回执

释放手机号

    仅在没有收到短信时调用，如果收到了短信无需调用此接口,释放存在失败的情况
  • 请求参数说明：
    • 参数名 参数值 必传 参数说明
    act setRel 是 固定值，不允许修改
    token 登录接口返回的token值 是 登录接口返回的token值
    pkey 获取手机号返回的pkey值 是 获取手机号返回的pkey值
  • 请求示例：?act=setRel&token=b7c94daad5e3dd71ffca9298976ec0d4_3&pkey=0524EA1B2A4DC810E3E535BE036C2C170E914ECC4D46ED19
  • 成功返回：1|
  • 失败返回：0|失败代号
  • 失败代号说明：
    • 失败代号 代号说明
    x x为正整数，表示x秒后才允许被释放。例如：返回0|30，表示30秒后才允许被释放
    -1 Token不存在
    -2 pkey无效
    -3 手机号不存在或已释放【请做好此判断，可以避免多个手机同时获取到相同号码的错觉】
    -4 已回码,不允许释放
    -5 短信已提交发送,不允许释放
    -6 释放超过次数,自动加黑

加黑手机号

    仅在以后不想再用到这个号码时调用，其他非特殊情况无需调用此接口，加黑存在失败的情况
  • 请求参数说明：
    • 参数名 参数值 必传 参数说明
    act addBlack 是 固定值，不允许修改
    token 登录接口返回的token值 是 登录接口返回的token值
    pkey 获取手机号返回的pkey值 是 获取手机号返回的pkey值
    reason 加黑原因 是 汉字经过url编码
  • 请求示例：?act=addBlack&token=b7c94daad5e3dd71ffca9298976ec0d4_3&pkey=0524EA1B2A4DC810E3E535BE036C2C170E914ECC4D46ED19&reason=used
  • 成功返回：1|
  • 失败返回：0|失败代号
  • 失败代号说明：
    • 失败代号 代号说明
    -1 Token不存在
    -2 pkey无效
    -3 加黑原因不能为空
    -4 手机号不存在或已释放【请做好此判断，可以避免多个手机同时获取到相同号码的错觉】
    -5 未回码,请释放
    -6 帐号已被禁止加黑号码

状态反馈

    调用该接口需要配置权限，注册默认没有此接口权限，如需开通请联系平台,【专属对接可联系卡商开通】

    未分配权限者，请勿调用，避免账户余额减少

  • 请求参数说明：
    • 参数名 参数值 必传 参数说明
    act apiReturn 是 固定值，不允许修改
    token 登录接口返回的token值 是 登录接口返回的token值
    pkey 获取手机号返回的pkey值 是 获取手机号返回的pkey值
    remark 反馈信息 是 (固定值 0：成功，-1：失败，-2：验证码超时，-3：号码已注册)，其他信息请直接输入
  • 请求示例：?act=apiReturn&token=b7c94daad5e3dd71ffca9298976ec0d4_3&pkey=0524EA1B2A4DC810E3E535BE036C2C170E914ECC4D46ED19&remark=0
  • 成功返回：1|
  • 失败返回：0|失败代号
  • 失败代号说明：
    • 失败代号 代号说明
    -1 Token不存在
    -2 pkey无效
    -3 反馈说明不能为空
    -4 当前账号无法操作此号码
    -5 未开通Api反馈权限

再次使用

    当需要再次使用手机号时调用（非指定取号多次收码）
    收到验证码后调用

    再次使用会重新结算费用，非特殊项目，请勿调用，避免账户余额减少

  • 请求参数说明：
    • 参数名 参数值 必传 参数说明
    act setAgain 是 固定值，不允许修改
    token 登录接口返回的token值 是 登录接口返回的token值
    pkey 获取手机号返回的pkey值 是 获取手机号返回的pkey值
    min 多少分钟后再次使用 (值范围2-300分钟)，默认值是5，代表5分钟后再次使用
  • 请求示例：?act=setAgain&token=b7c94daad5e3dd71ffca9298976ec0d4_3&pkey=0524EA1B2A4DC810E3E535BE036C2C170E914ECC4D46ED19&min=5
  • 成功返回：1|
  • 失败返回：0|失败代号
  • 失败代号说明：
    • 失败代号 代号说明
    -1 Token不存在
    -2 pkey无效
    -3 min参数值错误，(值范围2-300)，默认值是5，代表5分钟后再次使用
    -4 手机号不存在或已释放【请做好此判断，可以避免多个手机同时获取到相同号码的错觉】
    -5 未回码,请释放

获取价目表

  • 请求参数说明：
    • 参数名 参数值 必传 参数说明
    act getItem 是 固定值，不允许修改
    key 关键字 项目名称关键字，不传则获取全部项目信息
  • 请求示例：?act=getItem&key=
  • 成功返回：价目信息json
  • 字段说明：
  • Item_ID：项目ID
  • Item_Name：项目名称
  • Item_UPrice：项目单价
  • Country_ID：国家代码
  • Country_Title：国家名称

项目表

    项目ID 项目名称

国家代码

    国家代码 国家区号 国家说明