Embed Size (px)
Citation preview
OnlineSim SMSHUB api v12020-06-03 14:55:00
A rewrite of the document that describes the API from smshub, you can use it, but the connection andconfiguration individually and you need to contact technical support to discuss some things with a connectionto the API
General description
OnlineSim API provides you with the possibility to use our service in the automatic mode. For that purpose,you need to register on our site - onlinesim.ru and have to get an API key in the User Profile tab and toimplement approximately the following operating procedure in the software:
1. Implement 2 methods and webhook. The method GET_SERVICES gives room for a certainnumber, after receiving SMS checks whether the purchased service and sends an SMS towebhook.
2. write to us by e-mail or telegram.
In order to use the API, you have to perform a POST or GET request via the HTTP protocol to the specifiedURL.
Common returned responses
The RESPONSE parameter values are common for all methods.
json {status: STATUS, …, … }
GET_SERVICES - get all numbers
URL - http://smshub/This request get a list of online numbers.
Example
return { countryList: [ { country: "russia", operatorMap: { any: {vk: 10, ok: 25, wa: 52}, beeline: { vk: 10, ok: 15, wa: 20}, megafon: { vk: 0, ok: 10, wa: 32} } }, { country: "ukraine", operatorMap: { life: { vk: 0, ok: 10, wa: 32}, any: { vk: 10, ok: 5, wa: 30}, } } ], status: "SUCCESS"};
Parameters
Name ofparameter
Parameter Type of data Description
action required STRUNG actionkey required STRUNG apikey
list format
Name ofparameter
Parameter Type of data Description/Value
status required STRUNG request status SUCCESS or ERRORcountryList required ARRAY Numbers list
countryList
Name ofparameter
Parameter Type of data Description
country required STRING country name.See country list
operatorMap required OBJECT
Numbers list Associative array of services: key - short name of the service
value - the number of numbers for the service (type-int).
operatorMap
operator: {service: count, …}
Name ofparameter
Parameter Type of data Description
operator required STRING operator name.See operator list
service required STRING service name.See service list
count required INT service count
GET_NUMBER - request for number
This request get new operationcreate operation for 15 minutes
Example
// or Axios axios.post( 'http://smshub', {action: "GET_NUMBER", country: "russia",operator: "any",service: "vk", sum: 40, key: "APIKEY"}, {headers: {'Content-Type': 'application/json; charset=utf-8'}})
Parameters
Name ofparameter
Parameter Type of data Description/Value
action required STRING GET_NUMBERkey required STRING apikey
country required STRING country name.See country list
service required STRING service name.See service list
operator required STRING operator name.See operator list
sum required INT price for service
Result
After the successful completion, you will get a response in the JSON format, in the following form:
json {"number": 79281234567, "activationId": 355, "status": "SUCCESS"}orjson {"status": "NO_NUMBERS"}
Result Description/Valuestatus request status SUCCESS or ERROR
number numberactivationId operation id
ERRORS
Result DescriptionNO_NUMBERS no numbers for this params
FINISH_ACTIVATION - add new message
close active operation. send after used
Example
// or Axios axios.post( 'http://smshube', {action: "FINISH_ACTIVATION", activationId: 355, status: 2, key: "APIKEY"}, {headers: {'Content-Type': 'application/json; charset=utf-8'}})
Parameters
Name ofparameter
Parameter Type of data Description/Value
action required TEXT FINISH_ACTIVATIONactivationId required INT operation id
status required TEXT status for close operationkey required TEXT APIKEY
STATUSES
Status Description/Value1 Do not get this number for this service3 Successfully sold4 Canceled, message has not been received5 Returned, In case of errors and problems with messages
Result
After the successful completion, you will get a response in the JSON format, in the following form:
json {status: "SUCCESS"}
Result Description/Valuestatus SUCCESS or ERROR
PUSH_SMS webhook - send sms to onlinesim
This webhook for messages OnlineSim server.
Example
// jQuery ajax// or Axios axios.post( 'http://onlinesim.ru/api/push_sms_webhook', {action: "PUSH_SMS",phoneFrom: 'vk', smsId: 355, phone: 79281234567, text: "VK: 33708", status: 2, key: "APIKEY"}, {headers: {'Content-Type': 'application/json; charset=utf-8'}})
Parameters
Name ofparameter
Parameter Type of data Description
smsId required INT operationIdphoneFrom required STRING service name or number
phone required INT phone numbertext required STRING message text
action required STRING PUSH_SMSkey required STRING APIKEY
Response:
{"status": "SUCCESS"}
If you get a response with status SUCCESS, in my database mark SMS successfully delivered and do notsend. If returned status is different from SUCCESS, then after 10 seconds send another SMS.
Attachments
#1 Country list
Country Description - Country Descriptionusa Usa - russia Russia
france France - romania Romania
austria Austria - united_kingdom United kingdom
sweden Sweden - poland Poland
germany Germany - mexico Mexico
philippines Philippines - kazakhstan Kazakhstan
vietnam Vietnam - china China
ivory Ivory - ghana Ghana
nigeria Nigeria - cyprus Cyprus
lithuania Lithuania - latvia Latvia
moldova Moldova - belorussia Belorussia
ukraine Ukraine - czech Czech
haiti Haiti - laos Laos
yemen Yemen - georgia Georgia
kirghizia Kirghizia - uzbekistan Uzbekistan
canada Canada - belgium Belgium
brasil Brasil - malaysia Malaysia
vietnam Vietnam -аlgeria
Аlgeria
gambia Gambia - kenya Kenya
tanzania Tanzania - croatia Croatia
hongkong Hongkong - iraq Iraq
Israeli Israeli - azerbaijan Azerbaijan
See other in PUSH_SMS
#2 Operators list
Operator Descriptionany any operator
megafon megafonbeeline beelinetele2 tele2mts mts
rostelecom rostelecomactiv activaltel altelaiva aivasber sberyota yota
simsim simsimlife life
kyivstar kyivstarorange orange
See other in PUSH_SMS
ta
li
hh
#3 Services list
Service Description - Service Description
fb 3223 - vk VKcom
ma MailRu - ok Odklru
go Google - ya Yandex
av Avito - ym Youla
vi Viber - wa WhatsApp
tg Telegram - we FastFriend
ig Instagram - wb WeChat
mt Steam - ub Uber
mm Microsoft - ss Seosprint
tw Twitter - gt Gett
sn OLX - uk MeetMe
meLineMessenger
- mb Yahoo
bd Rambler - kp TencentQQ
dt taxiMaxim - TanTan TanTan
oi Tinder - fd Mamba
zz DromRu - kt KakaoTalk
pm AOL - tn LinkedIn
ta Bolt - ab Airbnb
li lino_network - ls Livescore
Apple Apple - Blablacar Blablacar
iost iost - Azino777 Azino777
appbonus appbonus - gameflip gameflip
galaktika galaktika - akelni akelni
um electroneum - glovo glovo
ch1 Hey_plus - qq qq
oz ozon - DodoPizza DodoPizza
eBay eBay - PromUa PromUa
Pokermaster Pokermaster - HQTRIVIA HQTRIVIA
WRIGGLE WRIGGLE - Yalla Yalla
Quidol Quidol - Amazon Amazon
WhatsAround WhatsAround - alibaba alibaba
PlanetaKino PlanetaKino - Pikabu Pikabu
Sipnet Sipnet - ucoz ucoz
1xstavka 1xstavka - hh HeadHunter
OLIMP OLIMP - Imo Imo
bg
ca cmdk
jl
yd
zd dt
wo
po
OLIMP OLIMP - Imo Imo
DISCORD DISCORD - WOG_ua WOG_ua
Snapchat Snapchat - Adjarabet Adjarabet
G2A G2A - Proton Proton
monese monese - TamTam TamTam
Nike Nike - aliexpress aliexpress
ukr ukrnet - bg beget
ca careem - cm CityMobil
dk Dukascopy - hm HOMEAWAY
jl Jollychic - na naver
sg Signal - yd youdo
zd zadarma - dt WOG
GoJoy GoJoy - wo wolt
uklon uklon - badoo badoo
wanmei wanmei - baihe baihe
baidu baidu - jiayuan jiayuan
zhenai zhenai - douyu douyu
alipay alipay - bbs_gfan_com bbs_gfan_com
zhiji zhiji - MiLiao MiLiao
Shopee Shopee - Soul Soul
paopao paopao - paypal paypal
Lyft Lyft - douyin douyin
douyin tiktok - lianxin lianxin
plenty_of_fish plenty_of_fish - JustDating JustDating
Dent Dent - Netflix Netflix
Weibo Weibo - Skype Skype
Douban Douban - Gcash Gcash
Fetlife Fetlife - Seagm Seagm
PayGo PayGo - MoMo MoMo
Grab Grab - SuYue SuYue
MapleSEA MapleSEA - Fordeal Fordeal
Zalo Zalo - Wpay Wpay
kwai kwai - ppua ppUa
Kufar Kufar - Onliner Onliner
pyaterochka Pyaterochka - Delivery DeliveryClub
Hezzl Hezzl - mg Magnit
pf pof_com - kl kolesa_kz
po premium_one - ob Onlinerby
kb kufarby - mc Michat
ny
op
bl
bf
gd
fy
kb kufarby - mc Michat
wg Skout - rz EasyPay
vf Q12_Trivia - ny Pyr_Music
fe CliQQ - la ssoidnet
zh Zoho - gp Ticketmaster
ly Olacabs - op MIRATORG
fx PGbonus - qr MEGA
yk sportmaster - bl BIGO_LIVE
muMyMusicTaste
- bf Keybase
uu Wildberries - Inboxlv Inboxlv
zy Nttgame - gd Surveytime
fy Mylove - tl Truecaller
Globus Globus - pl Perekrestok
ip BurgerKing - zr Papara
ot Any other - - -
See other in PUSH_SMS
