Receiving sms - API Documentation

Attention! We have moved to a new domain. If you worked with the API you need to change the domain from the old one to the new one "sms-activation-service.com"

Description of the API protocol
To check the balance

getBalance
Get all countries and operators available to them

getCountryAndOperators
Get current prices and number of numbers

getServicesAndCost
Get current prices and number of numbers with statistics

getServicesAndCostWithStatistics
Room booking

getNumber
To change the status

setStatus
To obtain the current status

getStatus
To obtain the current status

getCurrentActivationsList
Annex 1. List of countries
Annex 2. Service list
Possible error

API documentation

API is a Protocol of interaction between your SOFTWARE and our activation server.

The API is needed in order to automate the process of receiving SMS messages on your side All requests (supported by POST and GET) should go to

https://sms-activation-service.com/stubs/handler_api

Attention

All requests must have API key-parameter "api_key", localization for interaction with ruble / dollar (ru/en) balance-parameter "lang", method name-parameter "action". RPS limits - 8 requests per second.

Useful options for API clients.

Find out in which country the cheapest temporary numbers under X service? "See where the cheapest numbers are."
View the percentage of successful SMS received by other users. "Learn more about SMS deliverability statistics"
Set the maximum purchase price so as not to get a sharp price increase due to high demand "Learn more about how to limit the price of buying numbers."

API key You can get in the section:Profile.

getBalance

To check the balance

https://sms-activation-service.com/stubs/handler_api?api_key=APIKEY&action=getBalance&lang=LANG

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

action

string

Method name

lang

string

Localization ru or en

Server response:

Example answer:

463.02

getCountryAndOperators

Get all countries and operators available to them

https://sms-activation-service.com/stubs/handler_api?api_key=APIKEY&action=getCountryAndOperators&lang=LANG

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

lang

string

Localization ru or en

Server response:

Sample JSON response:

[{"id":0,"name":"Russia","operators":{"any":"any","tele2":"tele2","tinkoff":"tinkoff","ttk":"ttk","yota":"yota"}},{"id":1,"name":"Ukraine","operators":{"any":"any","kyivstar":"kyivstar","life":"life","lycamobile":"lycamobile","mts":"mts","utel":"utel","vodafone":"vodafone"}}]

Field

Example

Description

Country ID

name

Russia

Country name

operators

["operators":{"aiva":"aiva", "any":"any"}]

Array with operator IDs

getServicesAndCost

Get current prices and number of numbers

https://sms-activation-service.com/stubs/handler_api?api_key=APIKEY&action=getServicesAndCost&country=COUNTRY&operator=OPERATOR&lang=LANG

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

operator

string

The cellular operator whose number is to be obtained see. "Country List"

country

integer

The ID of the country whose number you want to get, see "Country List"

lang

string

Localization ru or en

Server response:

Sample JSON response:

[{"id":"vk","name":"Вконтакте","price":29.88,"quantity":"19"},{"id":"ok","name":"Ok.ru","price":1.34,"quantity":"2776"},{"id":"wa","name":"Whatsapp","price":0,"quantity":"0"}]

Field

Example

Description

Service ID

name

Вконтакте

Service name

price

29.88

Actual price

quantity

Number of numberss

getServicesAndCostWithStatistics

Get the current prices and number of numbers with statistics of sms delivery by service/sites and a list of minimum prices by country.

https://sms-activation-service.com/stubs/handler_api?api_key=APIKEY&action=getServicesAndCostWithStatistics&country=COUNTRY&operator=OPERATOR&lang=LANG

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

operator

string

The cellular operator whose number is to be obtained see. "Country List"

country

integer

The ID of the country whose number you want to get, see "Country List"

lang

string

Localization ru or en

Server response:

Sample JSON response:

[{"id":"wa","name":"WhatsApp","price":300,"quantity":10671,"deliverability":"38.84","cheap_prices_countries":[{"country_name":"Украина","country_flag":"flag-icon flag-icon-ua","price":"12.50"},{"country_name":"Колумбия","country_flag":"flag-icon flag-icon-co","price":"13.13"}]},{"id":"tg","name":"Telegram","price":112.5,"quantity":23341,"deliverability":"12.71","cheap_prices_countries":[{"country_name":"Англия (UK)","country_flag":"flag-icon flag-icon-gb","price":"4.75"},{"country_name":"США (виртуальные)","country_flag":"flag-icon flag-icon-us","price":"4.90"}]}]p>

Field

Example

Description

Service ID

name

Вконтакте

Service name

price

29.88

Actual price

quantity

Number of numberss

deliverability

12.71

Percentage of SMS deliverability by service/site

cheap_prices_countries

{"country_name":"Англия (UK)","country_flag":"flag-icon flag-icon-gb","price":"4.75"}

List of minimum prices by country

getNumber

Room booking

https://sms-activation-service.com/stubs/handler_api?api_key=APIKEY&action=getNumber&service=SERVICE&operator=OPERATOR&country=COUNTRY&lang=LANG

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

action

string

Method name

service

string

Service number for which you want to get see. "Services List"

operator

string

The cellular operator whose number is to be obtained see. "Country List"

country

integer

The ID of the country whose number you want to get, see "Country List"

lang

string

Localization ru or en

Server response:

Server response

Example

Description

NO_BALANCE

Not enough balance on the API account

NO_NUMBERS

No numbers with the given parameters, try later, or change operator, country.

ACCESS_NUMBER:ID:NUMBER

ACCESS_NUMBER:234242:79991728822

We have received number, activation ID - ID, number itself with country code - NUMBER

setStatus

To change the status

https://sms-activation-service.com/stubs/handler_api?api_key=APIKEY&action=setStatus&id=ID&status=STATUS&lang=LANG

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

action

string

Method name

integer

Activation ID received when requesting a number

status

integer

Status to be transferred to activation

lang

string

Localization ru or en

Available statuses:

3 - Request another sms

6 - Complete activation

8 - Cancel order

Server response:

Server response

Description

NO_BALANCE

Not enough balance on the API account

ACCESS_CANCEL

Activation canceled

ACCESS_RETRY_GET

Waiting for new SMS

ACCESS_ACTIVATION

Activation successfully completed

CANNOT_BEFORE_2_MIN

You can't cancel before 2 minutes after ordering a numbers

getStatus

To obtain the current status

https://sms-activation-service.com/stubs/handler_api?api_key=APIKEY&action=getStatus&id=ID&lang=LANG

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

action

string

Method name

integer

Activation ID received when requesting a number

lang

string

Localization ru or en

Server response:

Server response

Description

STATUS_WAIT_CODE

Waiting for SMS to arrive

STATUS_CANCEL

Activation canceled

STATUS_OK:CODE

Code received (where CODE is the activation code)

getCurrentActivationsList

To obtain the current status

https://sms-activation-service.com/stubs/handler_api?api_key=APIKEY&action=getCurrentActivationsList&status=STATUS&limit=LIMIT&order=ORDER&orderBy=ORDERBY&lang=LANG

Field

Type

Description

api_key

string

Your API key provides access to paid services. The API key should be kept secret

action

string

Method name

status

integer

Status number to filter (available - 0 (new, waiting for sms) | 1 (completed) | 2 (cancelled) | 3 (received sms) | 4 (waiting for additional sms))

order

string

By which field we sort (available - id/number/date)

orderBy

string

Sorting in ascending/descending order (ASC/DESC)

lang

string

Localization ru or en

Server response:

Sample JSON response:

[ { "numberid": 1539723, "number": "380916172774", "status": 1 }, { "numberid": 1081409, "number": "380916147785", "status": 1 } ]

Annex 1. List of countries

Name

Available operators

Russia

aiva, any, beeline, center2m, danycom, ezmobile, gazprombank_mobile, lycamobile, matrix, megafon, motiv, mts, mtt, mtt_virtual, rostelecom, sber, simsim, tele2, tinkoff, ttk, vtb_mobile, winmobile, yota

Ukraine

3mob, any, intertelecom, kyivstar, life, lycamobile, mts, utel, vodafone

Kazakhstan

activ, altel, any, beeline, forte_mobile, kcell, tele2

China

any, china_unicom, chinamobile, unicom

Philippines

any, globe_telecom, smart, tm

Myanmar

any, mpt, mytel, ooredoo, telenor

Indonesia

any, axis, indosat, smartfren, telkomsel, three

Malaysia

any, celcom, digi, hotlink, tune_talk, u_mobile, xox, yes

Kenya

airtel, any, econet, orange, safaricom, telkom

Tanzania

airtel, any, halotel, tigo, ttcl, vodacom

Viet Nam

any, itelecom, mobifone, vietnamobile, viettel, vinaphone

Kyrgyzstan

any, beeline, megacom, o!

USA (Virtual)

any, cellular, tmobile

Israel

019mobile, any, golan_telecom, home_cellular, hot_mobile, jawwal, ooredoo, orange, pelephone, rami_levy

Hong Kong (China)

any, chinamobile, csl_mobile, imc, smartone, three, unicom

Poland

aero2, any, e_telko, klucz, lycamobile, netia, nju, orange, play, plus, tmobile

England (UK)

any, cmlink, ee, ezmobile, giffgaff, lebara, lycamobile, o2, orange, talk_telecom, teleena, three, tmobile, vectone, vodafone

Madagascar

any

Dem. Congo

africel, airtel, any, orange, vodacom

Nigeria

airtel, any, etisalat, glomobile, mtn

Macau

3macao, any

Egypt

any, etisalat, orange, vodafone

India

any

Ireland

48mobile, any, cablenet, lycamobile, tesco

Cambodia

any, metfone

Laos

any, etl, telekom, tplus, unitel

Haiti

any, natcom

Côte d'Ivoire

any, moov, mtn, orange

Gambia

africel, any, comium, gamcel, qcell

Serbia

a1, any, mobtel, mts, vip

Yemen

any, mtn, sabafon, yemen_mobile

SOUTH AFRICA

any, cell_c, lycamobile, mtn, telkom, vodacom

Romania

any, benefito_mobile, digi, lycamobile, my_avon, orange, runex_telecom, telekom, vodafone

Colombia

any, claro, movistar, tigo, virgin, wom

Estonia

any, elisa, goodline, super, tele2, topconnect

Azerbaijan

any, azerfon, humans

Canada

any, cellular, chatrmobile, fido, lucky, rogers, telus

Morocco

any, iam, inwi, itissalat, orange

Ghana

airtel, any, glomobile, millicom, mtn, vodafone

Argentina

any, claro, movistar

Uzbekistan

any, beeline, humans, mobiuz, mts, ucell, uzmobile

Cameroon

any, mtn, nexttel, orange

Chad

airtel, any, salam, tigo

Germany

any, fonic, lebara, lycamobile, o2, ortel_mobile, telekom, vodafone

Lithuania

any, bite, tele2, telia

Croatia

a1, any, tele2, telemach, tmobile, tomato

Sweden

any, comviq, lycamobile, tele2, telenor, telia, three, vectone, vodafone

Iraq

any, asiacell, korek, zain

Netherlands

any, kpn, l_mobi, lebara, lycamobile, tmobile, vodafone

Latvia

any, bite, lmt, tele2, xomobile

Austria

a1, any, eety, hot_mobile, lidl, lycamobile, orange, telering, three, tmobile, yesss

Belarus

any, best, life, mdc, mts

Thailand

ais, any, dtac, truemove

Saudi Arabia

any

Mexico

any, telcel

Taiwan

any, chunghwa, fareast

Spain

altecom, any, euskaltel, lebara, llamaya, lycamobile, movistar, orange, vodafone, yoigo, you_mobile

Iran

any, aptel, azartel, hamrah_e_aval, irancell, mtn, rightel, samantel, shatel, taliya, tci

Algeria

any, djezzy, mobilis, ooredoo

Slovenia

a1, any, telekom, telemach

Bangladesh

any

Senegal

any, expresso, free, orange

Turkey

any, turk_telekom, turkcell

Czech Republic

any, kaktus, o2, tmobile, vodafone

Sri Lanka

airtel, any, dialog, etisalat, hutch, sltmobitel

Peru

any

Pakistan

any, jazz, ptcl, sco, telenor, ufone, zong

New Zealand

2degree, any, one_nz, skinny, vodafone, warehouse

Guinea

any, cellcom, mtn, orange, sotelgui, telecel

Mali

any, malitel, orange, telecel

Venezuela

any

Ethiopia

any, mtn

Mongolia

any, beeline

Brazil

algartelecom, any, claro, correios_celular, nlt, oi, tim, vivo

Afghanistan

any, salaam

Uganda

airtel, any, k2_telecom, lycamobile, mtn, orange, smart, smile, uganda_telecom

Angola

africel, any, unitel

Cyprus

any, cablenet, cyta, epic, lemontel, primetel, vectone

France

any, bouygues, free, lebara, lycamobile, orange, sfr, syma_mobile, vectone

New Guinea

any

Mozambique

any

Nepal

any

Belgium

any, bandwidth, base, infrabel, lycamobile, nethys, orange, proximus, vectone

Bulgaria

a1, any, telenor, vivacom, yettel

Hungary

any, tmobile, vodafone, yettel

Moldova

any, idc, moldcell, orange, unite

Italy

any, ho, kena_mobile, lycamobile, optima, tim, vodafone, wind

Paraguay

any, claro, personal

Honduras

any, claro

Tunisia

any, ooredoo, orange, tunicell

Nicaragua

any, movistar

Timor-Leste

any

Bolivia

any

Costa Rica

any

Guatemala

any, claro, movistar, tigo

UNITED ARAB EMIRATES

any

Zimbabwe

any, econet

Puerto Rico

any

Togo

any

100

Kuwait

any

101

El Salvador

any, claro, digi, movistar, red, tigo

102

Libya

any

103

Jamaica

any, digi

104

Trinidad and Tobago

any

105

Ecuador

any, claro, cnt_mobile, movistar, tuenti

106

Swaziland

any

107

Oman

any

108

Bosnia and Herzegovina

a1, any

109

Dominican Republic

altice, any, claro, viva

111

Qatar

any

112

Panama

any

113

Cuba

any, cubacel

114

Mauritania

any, chinguitel, mattel, mauritel

115

Sierra Leone

africel, airtel, any, qcell

116

Jordan

any, orange, umniah, xpress, zain

117

Portugal

any, lebara, lycamobile, nos, vodafone

118

Barbados

any

119

Burundi

africel, any, econet, lacell, telecel, viettel

120

Benin

any

121

Brunei

any

122

Bahamas

any

123

Botswana

any, be_mobile, mascom, orange

124

Belize

any

125

CAR

any

126

Dominica

any

127

Grenada

any

128

Georgia

any, beeline, geocell, hamrah_e_aval, magticom

129

Greece

any, cosmote, ose, q_telecom, vodafone

130

Guinea-Bissau

any

131

Guyana

any

132

Iceland

any

133

Comoros

any

134

Saint Kitts and Nevis

any

135

Liberia

any, cellcom, comium, libercell, libtelco, lonestar

136

Lesotho

any

137

Malawi

any

138

Namibia

any

139

Niger

any

140

Rwanda

airtel, any, mtn

141

Slovakia

any, o2

142

Suriname

any

143

Tajikistan

any, indigo

144

Monaco

any

145

Bahrain

any

146

Reunion

any

147

Zambia

airtel, any, mtn, zamtel

148

Armenia

any, viva, vivo

149

Somalia

any

150

Congo

airtel, any

151

Chile

any, claro, entel, movistar

152

Burkina Faso

airtel, any, onatel, telecel

153

Lebanon

alfa, any, ogero, touch

154

Gabon

any

155

Albania

any, telekom, vodafone

156

Uruguay

any

157

Mauritius

any

158

Bhutan

any

159

Maldives

any

160

Guadeloupe

any

161

Turkmenistan

any

162

French Guiana

any

163

Finland

any, dna, elisa, telia

164

Saint Lucia

any

165

Luxembourg

any

166

Saint Pierre and Miquelon

any

167

Equatorial Guinea

any

168

Djibouti

any

169

Saint Kitts and Nevis

any

170

Cayman Islands

any

171

Montenegro

any

172

Denmark

any, lebara, lycamobile

173

Switzerland

any

174

Norway

any

175

Australia

any, optus, telstra, vodafone

176

Eritrea

any

177

South Sudan

any, mtn, zain

178

Sao Tome and Principe

any

179

Aruba

any

180

Montserrat

any

181

Anguilla

any

183

Northern Macedonia

a1, any, lycamobile, telekom, vip

184

Republic of Seychelles

any

185

New Caledonia

any

186

Cape Verde

any

187

USA (Real)

any, at_t, lycamobile, tmobile

189

Fiji

any

196

Singapore

any

Annex 2. Service list

Name

IndianOil

Dana

AIS

OkCupid

Pairs

Yahoo

MoneyPay

TurkiyePetrolleri

勇仕网络Ys4fun

AOL

Dostavista

NRJ Music Awards

Около

Brand20ua

Mewt

Vkontakte(vk.ru)

LoveRu

AptekaRU

Максавит

Brahma

Pocket52

Socios

Dosi

BlaBlaCar

Wmaraci

Праймериз 2020

AptekiPlus

KakaoTalk

TradeUP

Самокат

CashKaro

InDriver

Gittigidiyor

MOMO

GuruBets

Santander

Детский мир

Alfagift

CloudChat

Ininal

YandexGo

Consultant

Эльдорадо

Giftcloud

EFood

Avito

OnTaxi

Papara

MyMusicTaste

Virgo

Quipp

OfferUp

Seosprint

Bumble

Skout

Paysend

ROBINHOOD

Twilio

BLIBLI

Iti

СберАптека

RummyLoot

Asda

BIGO LIVE

CommunityGaming

MIYACHAT

Paysafecard

HQ Trivia

Paytm

LYKA

Zalo

Chispa

XadrezFeliz

Perfluence

Oriflame

ChatGPT (openAI.com)

Porbet

TeenPattiStarpro

4Fun

MarketGuru

SamsungShop

Badoo

Starbucks

RedBus

DoorDash

SneakersnStuff

Coindcx

YoWin

Digikala

Вита экспресс

NoBroker

Quack

GyFTR

Uklon

CELEBe

LightChat

Юла

HOP

HandyPick

PharmEasy

AliExpress

Taikang

Bolt

MapleSEA

99app

Fiqsy

CDkeys

Surveytime

Rambler

Taki

LigaPro

Line msg

Urent

Things

MarketPapa

Faberlic

Disney Hotstar

Voltz

FoxFord

MyDailyCash

Hopi

Mocospace

IQIYI

Nttgame

Nextdoor

Skroutz

Voggt

Potato Chat

Microsoft

Zomato

Yemeksepeti

ЗдравСити

PingPong

Gett

Hamrahaval

Taksheel

Rediffmail

Mylove

Humblebundle

Whoosh

Верный

Powerkredite

Blizzard

Leboncoin1

Siply

Coinbase

Trendyol

Facebook

Author24

Ticketmaster

Parkplus

Magnolia

Qoo10

Uber

Kufarby

Instagram

Ace2Three

GCash

Ukrnet

Gamekit

LOCO

Nike

Twitter

McDonalds

Bazos

DewuPoison

Linode

Imo

Idealista

Indomaret

Vidio

Onet

Mzadqatar

Tick

1хbet

CashApp

Fora

LiveScore

AVON

Tencent QQ

Окей

IceCasino

MPL

IVI

My11Circle

PingCode

ВкусВилл

Noon

WestStein

Sizeer

KeyPay

Pyro Music

Paxful

Fruitz

UU163

Перекресток

Ximalaya

OZON

MonobankIndia

GalaxyWin

CoinField

Airtel

TikTok/Douyin

Fiverr

Megogo

IndiaGold

PGbonus

Lidl

Huya

Bit

Sorare

Kotak811

MediBuddy

Yalla

Freelancer

Douyu

HappyFresh

HeyBox

YikYak

Loanflix

Alfa

Mobile01

Icrypex

Allegro

MobiKwik

Olacabs

Tinder

Global24

Stripe

KFC

23red

Naver

MIRATORG (Мираторг)

GameArena

Dominos Pizza

WinzoGame

BLS-SPAIN

TopDetal

Dundle

LazyPay

Craigslist

Budget4me

1688

Zdorov

MTS CashBack (МТС Кешбек)

Weverse

Agroinform

GiraBank

Ruten

TenChat

Kaggle

Divar

Deliveroo

Lalamove

Foodpanda

FreshKarta

Venmo

Neftm

JungleeRummy

Vlife

Weibo

Switips

Glovo

Hermes

MyLavash

KazanExpress

EBay

Wink

Лейка

Netflix

Магнит

YouStar

IFood

Gojek

Delivery Club

RosaKhutor

MoneyСontrol

Hezzl

Lotus

Wildberries

Rbt

Mosru

JamesDelivery

Cryptocom

ChaingeFinance

CourseHero

JKF

Kolesa.kz

LUKOIL-AZS

CMTcuzdan

Rozetka

Aitu

Viber

Lazada

888casino

Myntra

Pivko24

Swiggy

SnappFood

CloudBet

E bike Gewinnspiel

Getmega

Лэтуаль

Bet365

Trip

FotoCasa

Dent

Clubhouse

Uplay

Prom

Meliuz

MEGA

Magicbricks

ContactSys

EasyPay

Энергобум

Payzapp

UWIN

AGIBANK

СпортМастер

SpotHit

TanTan

AdaKami

Pof.com

Flink

EWallet

Humta

Nifty

Skype

Домовой

RummyWealth

Adani

Onlinerby

GMNG

Iwplay

Rush

NovaPoshta

Grindr

Immowelt

FWDMAX

Burger King

Uteka

PaddyPower

NimoTV

Yubo

Mamba

RedBook

Blued

Celcoin

CAIXA

GalaxyChat

CliQQ

CrefisaMais

Vivo

Gabi

Crowdtap

Akulaku

Sravni

КухняНаРайоне

FreeChargeApp

Однокласники (ok.ru)

WorldRemit

Контур

Getir

Cleartrip

Irancell

Штолле

Hily

Astropay

Swvl

CashFly

Discord

Akudo

RuTube

IZI

Joyride

Happn

Verse

Poshmark

Twitch

Stormgain

ZCity

Mercari

СhampionСasino

Apple

Wing Money

JTExpress

GlobalTel

Damejidlo

Premium.one

Hirect

Inboxlv

A9A

Букмекерские (Betting)

Zhihu

Ашан

GoFundMe

InFund

CityBase

Payoneer

Monese

Potato

Голос

Hepsiburadacom

Possible error

Server response

Description

BAD_ACTION

Incorrect request generation

BAD_KEY

Incorrect API key

BAD_LANG

Incorrect locale, accepted ru or en

NO_ACTIVATION

Activation ID does not exist

ERROR_SQL

SQL Server database error

ERROR_API

Processing error