账户

您可以在这里获得API端口、API密钥以及查询账户余额接口.

端口描述

API是您的软件和我们的激活服务器之间的互动协议。为了使您的短信接收过程自动化需要API。要使用API，您必须使用您的API密钥，我们的软件与竞争对手的网站完全兼容。所有的请求必须进入http(s)://lubansms.com/v2/api/ GET请求。所有的请求中必须含有token参数形式的API密钥。

APIKEY

您的APIKEY：请先登录

查询余额

http(s)://lubansms.com/v2/api/getBalance?apikey=YOUR_APIKEY

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY

正确的结果:
{"code":0,"msg":"","balance":"96.72"}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

验证码接收

您可以在这里获得验证码接收相关的功能接口.

请求号码

 http(s)://lubansms.com/v2/api/getNumber?apikey=YOUR_APIKEY&service_id=service_id

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY
service_id	string	是的	通过获取服务列表接口获得;还可以进入控制台->验证码接收:搜索您需要的国家和服务查询服务编号.

正确的结果:
{"code":0,"msg":"","number":"79781901206","request_id":230698}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

获取短信

 http(s)://lubansms.com/v2/api/getSms?apikey=YOUR_APIKEY&request_id=request_id

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY
request_id	string	是的	通过请求号码接口得到的request_id

等待短信:
{"code":0,"msg":"wait","sms_msg":{"request_id":"244936588","application_id":133,"country_id":1,"number":"79587588703"}}

收到短信:
{"code":0,"msg":"success","sms_code":"380682"}

未收到短信超时:
{"code":400,"msg":"wrong_status"}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

更改请求状态

http(s)://lubansms.com/v2/api/setStatus?apikey=YOUR_APIKEY&request_id=request_id&status=reject

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY
request_id	string	是的	通过请求号码接口得到的request_id
status	string	是的	值:reject 释放号码

正确的结果:
{"code":0,"msg":"success"}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

获取国家列表

http(s)://lubansms.com/v2/api/countries?apikey=YOUR_APIKEY

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY

正确的结果:
{"code":0,"msg":[{"id":"1","name_en":"Russian Federation","name_cn":"俄罗斯","code":"RU"}]}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

获取服务列表

http(s)://lubansms.com/v2/api/List?apikey=YOUR_APIKEY&country=countryName&service=serviceName&language=en&page=1

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY
countryName	string	不是	国家名称,例如中文:美国 language参数对应zh 英文:USA language参数对应en
service	string	不是	服务名称,支持模糊搜索例如: whatsapp 、微信
language	string	是	支持语言,值:zh、en 分别对应：中文、英文
page	string	是	分页

正确的结果:
{"code":0,"msg":[{"service_id":"121949","country_name_zh":"越南","country_name_en":"Vietnam","service_name":"Tinder","provider":"maxsim","cost":0.27},{"service_id":"328373","country_name_zh":"越南","country_name_en":"Vietnam","service_name":"Tinder","provider":"linesms","cost":0.24}]}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

获取短信记录

http(s)://lubansms.com/v2/api/smsHistory?apikey=YOUR_APIKEY&language=en&page=1

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY
language	string	是	支持语言,值:zh、en 分别对应：中文、英文
page	string	是	分页

正确的结果:
{"code":0,"msg":[{"request_id":"3350937","country":"England","service":"Telegram","time":"2024-11-06 21:53:15","number":"447931101536","cost":"0.45","sms_code":"114859","provider":"selfsms","status":"2","country_code":"44"},{"request_id":"3350879","country":"England","service":"Google","time":"2024-11-06 21:48:01","number":"447300390960","cost":"0.45","sms_code":"116410","provider":"selfsms","status":"2","country_code":"44"}]}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

通用短信接收

您可以在这里获得通用短信接收相关的功能接口.

请求号码

http(s)://lubansms.com/v2/api/getKeywordNumber?apikey=YOUR_APIKEY&phone=phone&cardType=cardType

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY
phone	string	不是	指定的号码，留空随机获取号码;该参数通常用于再次使用相同号码时接收短信.
cardType(已弃用)	string	不是	选值范围：[实卡,虚卡,全部]

正确的结果:
{"code":0,"msg":"","phone":"18888888888"}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

获取短信

 http(s)://lubansms.com/v2/api/getKeywordSms?apikey=YOUR_APIKEY&phone=phone&keyword=keyword

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY
phone	string	是的	手机号码,通过请求号码接口获取.
keyword	string	是的	短信中包含的关键词;例如短信内容为:【百度】验证码xxxx,您正在进行登陆验证,北极企鹅.;关键词可填写为:百度或者北极企鹅 .

等待短信:
{"code":400,"msg":"尚未收到短信,请稍后重试"}

收到短信:
{"code":0,"msg":"【百度】验证码xxxx,您正在进行登陆验证."}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

释放号码

http(s)://lubansms.com/v2/api/delKeywordNumber?apikey=YOUR_APIKEY&phone=phone

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY
phone	string	是的	要释放的电话号码

正确的结果:
{"code":0,"msg":""}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

获取短信记录

https://lubansms.com/v2/api/keywordSmsHistory?apikey=YOUR_APIKEY&page=1

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY
page	string	是	分页

正确的结果:
{"code":0,"msg":[{"time":"2018-11-13 21:35:29","phone":"18888888888","message":"【百度】验证码xxxx,您正在进行登陆验证.","provider":"ousms"},{"time":"2018-11-13 21:35:29","phone":"19999999999","message":"【百度】验证码xxxx,您正在进行登陆验证.","provider":"ousms"}]}

可能的错误:
{"code":400,"msg":"不正确的apikey"}

发送短信

您可以在这里获得发送短信相关的功能接口.

发送短信

http(s)://lubansms.com/v2/api/bulksms?apikey=YOUR_APIKE&tel_list=8618888888888,8618999999999,8618777777777&type=0&text=Hello&from=Sender

参数	类型	必需的	描述
apikey	string	是的	您的APIKEY
tel_list	string	是的	短信接收方手机号码，以“,”分隔，每次提交最多可以发送 30 个号码，（国家代码前不要使用+或00，例如：8618888888888）.
type	string	是的	指示消息的类型.类型的值包括：0：纯文本（GSM 3.38 字符编码），1：Unicode（对于任何其他语言）
text	string	是的	要发送的消息,每 153 个字符计为一条消息，对于 Unicode，每 67 个字符计为一条消息
from	string	是的	消息将显示的发件人名称. 如果是数字，则最大长度为 18.如果是字母数字，则最大长度为 11.

正确的结果:
{code: 0, msg: ",814089827255:提交成功"}

可能的错误:
{"code":400,"msg":"不正确的apikey"}