易码 - 短信验证码接收平台 - API开放接口

API接口文档 #007612

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

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

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

接口范例:

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

返回值:

登录成功:success|token
登录失败:错误代码,请根据不同错误代码进行不同的处理。

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

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

接口范例:

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

返回值:

请求参数format!=1:success|用户名|账户状态|账户等级|账户余额|冻结金额|账户折扣|获取号码最大数量,“|”是分隔符(默认返回数据格式)
请求参数format=1:success|JSON格式数据
请求失败:错误代码,请根据不同错误代码进行不同的处理。

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

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

接口范例:

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

返回值:

获取成功:success|手机号码
请求失败:错误代码,请根据不同错误代码进行不同的处理。暂停5秒再获取

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

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

接口范例:

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

返回值:

收到短信:success|短信内容
短信尚未到达:3001,应继续调用取短信接口,直到超时为止。
请求失败:错误代码,请根据不同错误代码进行不同的处理。

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

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

接口范例:

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

返回值:

提交成功:success,该处返回success只表示成功提交发送任务,不代表短信已经成功发送,获取发送结果请调用“获取短信发送结果”接口。
请求失败:错误代码,请根据不同错误代码进行不同的处理。

获取短信发送的状态,因短信发送有一定的延迟,建议每5秒调用一次,调用120秒。

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

接口范例:

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

返回值:

发送成功:success
等待发送:3002,表示短信正在等待发送
正在发送:3003,表示短信正在发送
发送失败:3004,表示短信发送失败,建议拉黑号码重新获取
请求失败:错误代码,请根据不同错误代码进行不同的处理。

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

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

接口范例:

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

返回值:

释放成功:success
请求失败:错误代码,请根据不同错误代码进行不同的处理。

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

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

接口范例:

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

返回值:

释放成功:success
请求失败:错误代码,请根据不同错误代码进行不同的处理。

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

1001:参数token不能为空
1002:参数action不能为空
1003:参数action错误
1004:token失效
1005:用户名或密码错误
1006:用户名不能为空
1007:密码不能为空
1008:账户余额不足
1009:账户被禁用
1010:参数错误
1011:账户待审核
1012:登录数达到上限
2001:参数itemid不能为空
2002:项目不存在
2003:项目未启用
2004:暂时没有可用的号码
2005:获取号码数量已达到上限
2006:参数mobile不能为空
2007:号码已被释放
2008:号码已离线
2009:发送内容不能为空
2010:号码正在使用中
3001:尚未收到短信
3002:等待发送
3003:正在发送
3004:发送失败
3005:订单不存在
3006:专属通道不存在
3007:专属通道未启用
3008:专属通道密码与项目不匹配
9001:系统错误
9002:系统异常
9003:系统繁忙

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