APISpace 验证码短信API接口案例代码

1.验证码短信API产品介绍

image.png

APISpace 的 验证码短信API，支持三大运营商，虚拟运营商短信发送，电信级运维保障，独享专用通道，3秒可达，99.99％到达率，支持大容量高并发。可批量发送多个号码。

2.验证码短信API详解

2.1 接口请求

• 请求方式：POST
• 请求地址：https://eolink.o.apispace.com/sms-code/verifycode
• 请求头：

标签	必填	说明
X-APISpace-Token	是	鉴权私钥，登陆 APISpace 后在管理后台的[访问控制]页面查看
Content-Type	是	application/json

• 请求参数：

参数名	类型	必填	说明
msg	[string]	是	短信内容。长度不能超过536个字符，签名需要加在内容里	【Eolinker】您的验证码是：{$var}，5分钟内有效。如非本人操作，请忽略。
params	[string]	是	手机号码和变量参数，多组参数使用英文分号;区分	132xxxxxxxx,123456;173xxxxxxxx,234567

2.2 接入示例（JAVA）

OkHttpClient client = new OkHttpClient().newBuilder().build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{"msg":"","params":""}");
Request request = new Request.Builder()
  .url("https://eolink.o.apispace.com/sms-code/verifycode")
  .method("POST",body)
  .addHeader("X-APISpace-Token","API密钥，登录APISpace即可获得")
  .addHeader("Content-Type","application/json")
  .build();

Response response = client.newCall(request).execute();
System.out.println(response.body().string());

3.短信验证码API 应用场景

• 注册登录

短信验证码直接登录和注册，无需输入密码，简化流程，提升注册转化率。

image.png

• 找回密码

用户用短信验证码进行密码找回，免除复杂的安全问题以及认证环节，安全快速。

image.png

• 支付认证

重要账户、大额支付短信验证，做好安全风控，为您的资金财产保驾护航。

image.png

• 更改信息

用户更改注册管理重要信息的时候，通过填入手机验证码，一键操作，安全提供便捷。

image.png

查询短信发送报告

如果想知道短信的发送情况，可以通过以下API来进行短信发送报告的获取。

数据拉取成功后服务器会删除当前拉取成功的数据，不再保存！请妥善处理接口返回的数据。此状态报告保存时间为72小时，上限存储100万条。

请求地址：

GET  https://cb.o.apispace.com/api/sms/report

请求参数：

字段	参数位置	说明
X-APISpace-Token	Header	apispace的token私钥
Authorization-Type	Header	鉴权类型，值为：apikey
count	Query	单次调用接口得到的报告数量，默认为10

返回参数：

返回参数	类型	描述	示例
code	string	请求状态。0代表成功，其他代表失败	“ret”:0
data	array	状态明细结果，没结果则返回空数组	“data”:[{ XXXXXX }]
uid	string	用户在提交该短信时提交的uid参数，未提交则无该参数	“uid”:”154789574”
statusDesc	string	运营商返回的状态说明	“statusDesc”:””
notifyTime	string	平台收到运营商回复状态报告的时间，格式为yyMMddHHmmss	“notifyTime”:”180522104730”
mobile	string	接收短信的手机号码	“mobile”:”15744444444”
msgId	string	消息id	“msgId”:”18052210472127924”
reportTime	string	状态更新时间，格式为yyMMddHHmm，其中yy=年份的最后两位(00-99)	“reportTime”:”1805221047”
status	string	运营商返回的状态	“status”:”DELIVRD”
length	string	下发短信计费条数	“length”:”1