API开放接口权限设置

API接口默认设置为关闭状态,若需要使用API接口,请前往 API接口设置 开启API接口权限。

接口功能与调用顺序:
1、登录获取token
2、获取账户信息(非必须,不需要可不调用)
3、获取手机号码
4、使用手机号码(将在本平台获取到的手机号码填写到你要完成验证的网站或APP),对方提示该号码不可用则拉黑重新获取
5、接收(发送)短信(通常是接收对方发送的验证短信,若是需要先对方发送指定内容则调用发送接口)
6、接收(发送)成功,释放号码,失败则拉黑号码。
特别提示:
1、接口调用成功则会返回“success”或以“success|”开头的返回值,如果失败则返回相应的【错误代码】;
2、获取号码在10分钟内没有被用户释放,系统会强制释放;
3、号码使用后,请及时释放或拉黑,否则号码占用达到上限将无法继续取号;
4、拉黑号码后,无需单独调用释放接口,系统自动释放号码;
接口通信规则:
1、通信方式:本平台采用HTTP协议(GET)方式通信
2、API接口地址:http://api.fxhyd.cn/UserInterface.aspx
3、调用方式(Method):GET
4、编码格式:UTF-8
5、接口地址和参数不区分大小写;

凭账号、密码获取通信令牌token。除登录外的其他接口调用都需要该参数。Token也可 登录 后获取并直接使用,即不需要调用该接口获取。

必须 类型 字段名 名称 说明
字符串 action 接口类型 固定值:login
字符串 username 用户名 客户在本平台的账号
字符串 password 密码 客户在本平台的密码

接口范例:

http://api.fxhyd.cn/UserInterface.aspx?action=login&username=你的账号&password=你的密码

返回值:

登录成功:success|token,例如:success|03016801366c9614a524c3722922b79hj04422y51d01

错误码 错误描述 处理方式
1002 参数action不能为空 请输出请求的URL,检查是否参数拼接错误,API地址后面是否缺少“?”。
1003 参数action错误 请输出请求的URL,检查是否action参数配置错误,或者URL拼接错误。
1013 接口功能未开启 你尚未开启API接口。(前往设置
1014 接口登录未开启 你尚未开启API接口的登录功能。(前往设置
1005 用户名或密码错误 请输出请求的URL,检查是否参数拼接错误。请检查账号、密码是否正确。
1006 用户名不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查参数username的值是否正确。
1007 密码不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查参数password的值是否正确。
1011 账户待审核 你的账号处于待审核状态,请联系客服处理。
1012 账户暂停使用 你的账号已被暂停业务功能,登录网站 用户中心 自行解封。
1009 账户被禁用 你的账号处于禁用状态,请联系客服处理。
其他 其他相关错误码 各接口都可能出现的其他错误码,详情请参见 《系统返回代码对照表

获取当前用户的账户信息。

必须 类型 字段名 名称 说明
字符串 action 接口类型 固定值:getaccountinfo
字符串 token 令牌 登录接口获取的token值
× 整数 format 返回格式 该值为1时,系统返回JSON格式数据,否则系统返回格式为“|”分割的字符串。

接口范例:

http://api.fxhyd.cn/UserInterface.aspx?action=getaccountinfo&token=TOKEN

返回值:

请求参数format!=1:success|用户名|账户状态|账户等级|账户余额|账户积分|账户折扣|取号上限,“|”是分隔符(默认返回数据格式)
请求参数format=1:success|JSON格式数据

错误码 错误描述 处理方式
1002 参数action不能为空 请输出请求的URL,检查是否参数拼接错误,API地址后面是否缺少“?”。
1003 参数action错误 请输出请求的URL,检查是否action参数配置错误,或者URL拼接错误。
1013 接口功能未开启 你尚未开启API接口,请前往设置。
1004 token失效 1.请输出请求的URL,检查是否参数拼接错误。并检查Token参数是否配置正确
2.修改账户密码后,之前的TOKEN就会失效,请重新获取TOKEN。
1011 账户待审核 你的账号处于待审核状态,请联系客服处理。
1012 账户暂停使用 你的账号已被暂停业务功能,登录网站 用户中心 自行解封。
1009 账户被禁用 你的账号处于禁用状态,请联系客服处理。
其他 其他相关错误码 各接口都可能出现的其他错误码,详情请参见 《系统返回代码对照表

指定号码筛选规则,获取手机号码。

必须 类型 字段名 名称 说明
字符串 action 接口类型 固定值:getmobile
字符串 token 令牌 登录接口获取的token值
整数 itemid 项目编号 项目对应的数字编号
× 整数 isp 运营商代码 号码所属运营商代码。1:移动,2:联通,3:电信
× 整数 province 省代码 号码归属地的省份代码,省市代码表
× 整数 city 市代码 号码归属地的市代码,省市代码表
× 整数 mobile 指定号码 要指定获取的号码,该号码必须是本平台的号码。
× 字符串 excludeno 排除号段 不获取170、171和188号段的号码,则该参数为170.171.180,每个号段必须是前三位,用小数点分隔。
× 字符串 timestamp 时间戳 当前时间,如果:20180325180816。该参数也可以换成其他随机值,主要作用是避免缓存。

接口范例:

http://api.fxhyd.cn/UserInterface.aspx?action=getmobile&token=TOKEN&itemid=项目编号&excludeno=排除号段&timestamp=TIMESTAMP

返回值:

获取成功:success|手机号码,例如:success|13888888888

错误码 错误描述 处理方式
1008 账户余额不足 请检查你当前API接口所使用的账户是否有足够的余额。
1010 参数错误 1.请输出请求的URL,检查是否参数拼接错误。
2.如果有带mobile参数获取指定号码,请确保该参数是有效的手机号码。
2001 参数itemid不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查项目编号参数itemid的值是否正确。
2002 项目不存在 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查项目编号参数itemid的值是否正确。
2003 项目未启用 项目已被平台停用,若有疑问请联系平台客服。
2004 暂时没有可用的号码 1.如果你取号限制条件较多,有可能会出现没有相应的号码可用。
2.该项目可用号码不足。
3.取号请求过于频繁。遇到2004错误码,请务必暂停5秒再获取
2005 获取号码数量已达到上限 1.号码使用后要及时释放,否正系统需要10分钟后才会自动释放。
2.每个账号可同时使用的号码数量初始值是20个,累计充值越多上限值越大。
2008 号码已离线 号码已离线,仅指定号码获取可能会返回该值。
2010 号码正在使用中 当指定获取的号码已在同一个项目被获取且尚未释放。请检查是否之前已经获取过该号码且尚未释放。
其他 其他相关错误码 各接口都可能出现的其他错误码,详情请参见 《系统返回代码对照表

在你使用获取到的电话号码后,调用该接口获取短信。因短信可能延迟,建议每5秒调用一次,调用60秒以上(可增加获取成功率)。

必须 类型 字段名 名称 说明
字符串 action 接口类型 固定值:getsms
字符串 token 令牌 登录接口获取的token值
整数 itemid 项目编号 项目对应的数字编号
整数 mobile 手机号码 要获取短信的手机号码。
× 整数 release 自动释放号码标识符 若该参数值为1时,获取到短信的同时系统将自己释放该手机号码。
若要继续使用该号码,请勿带入该参数。
× 整数 getsendno 是否返回发送号码 若该参数值为1时,则将短信发送号码附加在短信最后用#分隔。
× 字符串 timestamp 时间戳 当前时间,如果:20180325180816。该参数也可以换成其他随机值,主要作用是避免缓存。

接口范例:

http://api.fxhyd.cn/UserInterface.aspx?action=getsms&token=TOKEN&itemid=项目编号&mobile=手机号码&release=1&timestamp=TIMESTAMP

返回值:

收到短信:success|短信内容。短信内容为UTF-8编码,如果收到的短信是乱码,请自行转换编码。
短信尚未到达:3001,应继续调用取短信接口,直到超时为止。

错误码 错误描述 处理方式
2006 参数mobile不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查mobile参数值是否正确。
2001 参数itemid不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查项目编号参数itemid的值是否正确。
2002 项目不存在 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查项目编号参数itemid的值是否正确。
2003 项目未启用 项目已被平台停用,若有疑问请联系平台客服。
1008 账户余额不足 请检查你当前API接口所使用的账户是否有足够的余额。
2007 号码已被释放 1.请检查取短信的项目编号参数itemid是否和取号码的itemid参数一致。
2.获取号码10分钟后,系统会自动释放号码。
3.取到短信后,注意根据你的短信格式提取验证码
否则可能因为验证码提取失败继续循环取短信,但是取短信携带了参数release=1,短信获取到的时候号码已被自动释放。
3001 尚未收到短信 1.取短信应该每隔5秒,多次尝试获取,直到超时为止。
2.若一直无法收到短信,请联系客服提供号码和项目名称进行核实。
2008 号码已离线 号码已离线,请重新取号。
其他 其他相关错误码 各接口都可能出现的其他错误码,详情请参见 《系统返回代码对照表

向该项目对应的号码发送短信,接收号码是项目里面固定设置的,不能随意指定接收号码。

必须 类型 字段名 名称 说明
字符串 action 接口类型 固定值:sendsms
字符串 token 令牌 登录接口获取的token值
整数 itemid 项目编号 项目对应的数字编号
整数 mobile 手机号码 要获取短信的手机号码。
字符串 sms 发送内容 要发送的短信内容,建议对发送内容进行URL编码(UTF-8),避免因中文字符编码问题导致参数错误。
× 字符串 number 接收号码 仅限需要回复短信的项目使用,普通发短信项目不需要该参数,具体请联系平台技术。

接口范例:

http://api.fxhyd.cn/UserInterface.aspx?action=sendsms&token=TOKEN&itemid=项目编号&mobile=手机号码&sms=发送内容

返回值:

提交成功:success,该处返回success只表示成功提交发送任务,不代表短信已经成功发送,获取发送结果请调用“获取短信发送结果”接口。

错误码 错误描述 处理方式
2006 参数mobile不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查mobile参数值是否正确。
2001 参数itemid不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查项目编号参数itemid的值是否正确。
1010 参数错误 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查发送内容、接收号码、项目编号等参数是否正确。
2003 项目未启用 项目已被平台停用,若有疑问请联系平台客服。
1008 账户余额不足 请检查你当前API接口所使用的账户是否有足够的余额。
2007 号码已被释放 1.请检查取短信的项目编号参数itemid是否和取号码的itemid参数一致。
2.请检查手机号码参数mobile值是否正确。
3.获取号码10分钟后,系统会自动释放号码。
2008 号码已离线 号码已离线,请重新取号。
2009 发送内容不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查发送内容参数sms及其值是否正确。
其他 其他相关错误码 各接口都可能出现的其他错误码,详情请参见 《系统返回代码对照表

获取短信发送的状态,因短信发送有一定的延迟,建议每5秒调用一次,调用120秒。(该功能对应的是“发送短信接口”,普通的收短信项目无需该接口)

必须 类型 字段名 名称 说明
字符串 action 接口类型 固定值:getsendsmsstate
字符串 token 令牌 登录接口获取的token值
整数 itemid 项目编号 项目对应的数字编号
整数 mobile 手机号码 是指你用来发送短信的手机号码。
× 字符串 timestamp 时间戳 当前时间,如果:20180325180816。该参数也可以换成其他随机值,主要作用是避免缓存。

接口范例:

http://api.fxhyd.cn/UserInterface.aspx?action=getsendsmsstate&token=TOKEN&itemid=项目编号&mobile=手机号码&timestamp=TIMESTAMP

返回值:

发送成功:success

错误码 错误描述 处理方式
2006 参数mobile不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查mobile参数值是否正确。
2001 参数itemid不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查项目编号参数itemid的值是否正确。
3002 等待发送 系统准备发送短信,请等待发送结果。
3003 正在发送 系统正在发送短信,请等待发送结果。
3004 发送失败 表示短信发送失败,建议拉黑号码重新获取新的号码。
3005 订单不存在 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查参数itemid、mobile等参数是否正确。
其他 其他相关错误码 各接口都可能出现的其他错误码,详情请参见 《系统返回代码对照表

释放指定的电话号码。如果号码不再使用请及时释放,否则你未释放的号码达到获取号码上限后将不能获取到新的号码。

必须 类型 字段名 名称 说明
字符串 action 接口类型 固定值:release
字符串 token 令牌 登录接口获取的token值
整数 itemid 项目编号 项目对应的数字编号
整数 mobile 手机号码 要获取短信的手机号码。

接口范例:

http://api.fxhyd.cn/UserInterface.aspx?action=release&token=TOKEN&itemid=项目编号&mobile=手机号码

返回值:

释放成功:success

错误码 错误描述 处理方式
2006 参数mobile不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查mobile参数值是否正确。
2001 参数itemid不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查项目编号参数itemid的值是否正确。
1010 参数错误 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查mobile参数是否是有效的手机号码。
2007 号码已被释放 该号码已经释放,请无重复释放。
其他 其他相关错误码 各接口都可能出现的其他错误码,详情请参见 《系统返回代码对照表

如果该号码无法使用,请将该号码放入黑名单,以后将不会再获取到该号码。

必须 类型 字段名 名称 说明
字符串 action 接口类型 固定值:addignore
字符串 token 令牌 登录接口获取的token值
整数 itemid 项目编号 项目对应的数字编号
整数 mobile 手机号码 要获取短信的手机号码。

接口范例:

http://api.fxhyd.cn/UserInterface.aspx?action=addignore&token=TOKEN&itemid=项目编号&mobile=手机号码

返回值:

拉黑成功:success

错误码 错误描述 处理方式
2001 参数itemid不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查项目编号参数itemid的值是否正确。
2006 参数mobile不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查mobile参数值是否正确。
1010 参数错误 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查mobile参数是否是有效的手机号码。
2007 号码已被释放 该号码已经释放,请无重复释放。
其他 其他相关错误码 各接口都可能出现的其他错误码,详情请参见 《系统返回代码对照表

系统在某些情况下会返回数字的代码,请按下表对应查询其含义。

错误码 错误描述 处理方式
1001 参数token不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查参数token的值是否正确。
1002 参数action不能为空 请输出请求的URL,检查是否参数拼接错误,API地址后面是否缺少“?”。
1003 参数action错误 请输出请求的URL,检查是否action参数配置错误,或者URL拼接错误。
1004 token失效 1.请输出请求的URL,检查是否参数拼接错误。并检查Token参数是否配置正确。
2.修改账户密码后,之前的TOKEN就会失效,请重新获取TOKEN。
1005 用户名或密码错误 请输出请求的URL,检查是否参数拼接错误。请检查账号、密码是否正确。
1006 用户名不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查参数username的值是否正确。
1007 密码不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查参数password的值是否正确。
1008 账户余额不足 请检查你当前API接口所使用的账户是否有足够的余额。
1009 账户被禁用 你的账号处于禁用状态,请联系客服处理。
1010 参数错误 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查相关接口各参数值是否正确。
1011 账户待审核 你的账号处于待审核状态,请联系客服处理。
1012 账户暂停使用 你的账号已被暂停业务功能,登录网站 用户中心 自行解封。
1013 接口功能未开启 你尚未开启API接口。(前往设置
1014 接口登录未开启 你尚未开启API接口的登录功能。(前往设置
2001 参数itemid不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查项目编号参数itemid的值是否正确。
2002 项目不存在 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查项目编号参数itemid的值是否正确。
2003 项目未启用 项目已被平台停用,若有疑问请联系平台客服。
2004 暂时没有可用的号码 1.如果你取号限制条件较多,有可能会出现没有相应的号码可用。
2.该项目可用号码不足。
3.取号请求过于频繁。遇到2004错误码,请务必暂停5秒再获取
2005 获取号码数量已达到上限 1.号码使用后要及时释放,否正系统需要10分钟后才会自动释放。
2.每个账号可同时使用的号码数量初始值是20个,累计充值越多上限值越大。
2006 参数mobile不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查mobile参数值是否正确。
2007 号码已被释放 1.请检查取短信的项目编号参数itemid是否和取号码的itemid参数一致。
2.请检查手机号码参数mobile值是否正确。
3.获取号码10分钟后,系统会自动释放号码。
2008 号码已离线 号码已离线,请重新取号。
2009 发送内容不能为空 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查发送内容参数sms及其值是否正确。
2010 号码正在使用中 当指定获取的号码已在同一个项目被获取且尚未释放。请检查是否之前已经获取过该号码且尚未释放。
3001 尚未收到短信 1.取短信应该每隔5秒,多次尝试获取,直到超时为止。
2.若一直无法收到短信,请联系客服提供号码和项目名称进行核实。
3002 等待发送 系统准备发送短信,请等待发送结果。
3003 正在发送 系统正在发送短信,请等待发送结果。
3004 发送失败 表示短信发送失败,建议拉黑号码重新获取新的号码。
3005 订单不存在 1.请输出请求的URL,检查是否参数拼接错误。
2.请检查参数itemid、mobile等参数是否正确。
9001 系统错误 系统错误,请重试。若多次尝试仍然返回该错误,请联系客服。
9002 系统异常 系统异常,请重试。若多次尝试仍然返回该错误,请联系客服。

如果你需要获取指定地区的手机号码,请按地区查询对应的省市编码。

客服QQ: