短信验证买家版

取消一个正在进行的订单

基本信息

Path： /api/ppv/buyer/order/cancel

Method： GET

接口描述：
不能取消已经收到验证码的订单。

请求参数

Query

参数名称	是否必须	示例	备注
id	是		订单ID
key	是		用户API接口Key

返回数据

名称	类型	是否必须	默认值	备注	其他信息
message	string	非必须		信息
success	boolean	非必须		结果

完成一个正在进行的订单

基本信息

Path： /api/ppv/buyer/order/done

Method： GET

接口描述：
隐藏一个已经收到验证码的订单

请求参数

Query

参数名称	是否必须	示例	备注
id	是		订单ID
key	是		用户API接口Key

返回数据

名称	类型	是否必须	默认值	备注	其他信息
message	string	非必须		信息
success	boolean	非必须		结果

更换API Key

基本信息

Path： /api/ppv/buyer/getkeychange

Method： GET

接口描述：
使用帐号邮箱和密码更换API Key。有效期限：12小时。

请求参数

Query

参数名称	是否必须	示例	备注
email	是		帐号邮箱
password	是		帐号密码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须		CODE	format: int32
key	string	非必须		用户API接口Key
message	string	非必须		信息

查询一个正在进行的订单详情

基本信息

Path： /api/ppv/buyer/order/getone

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是		订单ID
key	是		用户API接口Key

返回数据

名称	类型	是否必须	默认值	备注	其他信息
message	string	非必须		信息
orderList	object []	非必须			item 类型: object
├─ app	string	非必须		项目名称
├─ areaCode	string	非必须		区号
├─ country	string	非必须		地区
├─ id	string	非必须		订单ID
├─ number	string	非必须		手机号码
├─ price	number	非必须		本次价格	format: double
├─ vcode	string	非必须		验证码
success	boolean	非必须		结果

查询所有正在进行的订单详情

基本信息

Path： /api/ppv/buyer/order/getlist

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
key	是		用户API接口Key

返回数据

名称	类型	是否必须	默认值	备注	其他信息
message	string	非必须		信息
orderList	object []	非必须			item 类型: object
├─ app	string	非必须		项目名称
├─ areaCode	string	非必须		区号
├─ country	string	非必须		地区
├─ id	string	非必须		订单ID
├─ number	string	非必须		手机号码
├─ price	number	非必须		本次价格	format: double
├─ vcode	string	非必须		验证码
success	boolean	非必须		结果

短信验证号码库查询

基本信息

Path： /api/ppv/buyer/searching

Method： GET

接口描述：
PS:当项目名称为【all】时，可以查询某个国家下的所有项目。当国家名称为【all】时，可以查询某个项目下的所有国家。

请求参数

Query

参数名称	是否必须	示例	备注
appName	是		项目名称
countryName	是		国家名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
	object []	非必须			item 类型: object
├─ country	string	非必须		地区
├─ id	string	非必须		ID
├─ name	string	非必须		名称
├─ price	number	非必须		价格	format: double
├─ score	integer	非必须		评分	format: int32
├─ stock	integer	非必须		库存	format: int32

获取API Key

基本信息

Path： /api/ppv/buyer/getkey

Method： GET

接口描述：
使用帐号邮箱和密码获取API Key。有效期限：12小时。

请求参数

Query

参数名称	是否必须	示例	备注
email	是		帐号邮箱
password	是		帐号密码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须		CODE	format: int32
key	string	非必须		用户API接口Key
message	string	非必须		信息

获取所有地区名称

基本信息

Path： /api/ppv/buyer/phone/countries

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
	object []	非必须			item 类型: object
├─ code	string	非必须		电话区号
├─ id	integer	非必须		ID	format: int64
├─ name	string	非必须		地区

获取所有短信验证项目

基本信息

Path： /api/ppv/buyer/ppv/apps

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
	object []	非必须			item 类型: object
├─ displayName	string	非必须
├─ groupName	string	非必须
├─ id	integer	非必须			format: int64
├─ keywords	string	非必须
├─ price	number	非必须

获取手机号码

基本信息

Path： /api/ppv/buyer/getnumber

Method： GET

接口描述：
注意：
1. 取到号码后，可以占线十分钟，后台系统自动开始接收短信。
2. 十分钟内多次接码，不额外扣费。
3. 未收到验证码之前可以取消订单，收到验证码之后无法取消。
4. 大部分项目会在30秒内收到验证码，但也存在1～5分钟才收到验证码的情况。（如果一分钟内没有收到验证码，建议取消订单。）

请求参数

Query

参数名称	是否必须	示例	备注
id	是		号码库ID
key	是		用户API接口Key

返回数据

名称	类型	是否必须	默认值	备注	其他信息
areaCode	string	非必须		区号
message	string	非必须		信息
number	string	非必须		手机号码
orderId	string	非必须		订单ID
price	number	非必须		本次价格	format: double
success	boolean	非必须		取号结果

短信验证系统常用

更换API Key

基本信息

Path： /api/sys/getkeychange

Method： GET

接口描述：
使用帐号邮箱和密码更换API Key。有效期限：12小时。

请求参数

Query

参数名称	是否必须	示例	备注
email	是		帐号邮箱
password	是		帐号密码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须		CODE	format: int32
key	string	非必须		用户API接口Key
message	string	非必须		信息

获取API Key

基本信息

Path： /api/sys/getkey

Method： GET

接口描述：
使用帐号邮箱和密码获取API Key。有效期限：12小时。

请求参数

Query

参数名称	是否必须	示例	备注
email	是		帐号邮箱
password	是		帐号密码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须		CODE	format: int32
key	string	非必须		用户API接口Key
message	string	非必须		信息