1. Autenticação
Obtenha sua chave de API nas configurações do seu painel. Todas as requisições à API devem incluir o cabeçalho:
X-API-KEY: your_api_key_here2. URL base
Todas as requisições à API usam esta URL base:
https://api.smsactivate.ukExemplo de requisição
Esta requisição faz um pedido e pode cobrar da sua carteira. Substitua o serviço e o país de exemplo por uma seleção disponível na sua conta.
curl -X POST https://api.smsactivate.uk/get_numbers -H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" -d '{"service":"tg","country":2}'Referência da API
Cada operação lista suas entradas, um exemplo de requisição, uma resposta representativa e os principais erros. Integrações de API existentes podem continuar usando seus endpoints anteriores; os endpoints baseados em produto abaixo são recomendados para novas integrações. Os exemplos usam IDs e valores de exemplo. Envie requisições autenticadas do seu servidor com o cabeçalho da chave de API.
Comece aqui
GET/balanceConsulte o saldo atual da sua carteira.
Chave de API obrigatória.
Parâmetros
- Nenhum
- Sem parâmetros de consulta.
Exemplo de requisição
curl https://api.smsactivate.uk/balance -H "X-API-KEY: YOUR_API_KEY"Resposta
{ "balance": "10.0000" }Errors
O endpoint retorna o saldo atual da conta autenticada.
Obter e gerenciar um número
POST/get_numbersFaça um pedido de ativação.
Chave de API obrigatória.
Parâmetros
- service
- String obrigatória. Código do serviço, por exemplo tg.
- country
- Inteiro obrigatório. ID numérico do país.
- operator
- String opcional. O padrão é any.
- max_price
- Número opcional. Preço máximo; maxPrice também é aceito.
- min_price
- Número opcional; minPrice também é aceito.
- any_price
- Booleano opcional; anyPrice também é aceito.
- product
- Opcional: standard (padrão) ou api_links. API Links são compras de inventário de venda final.
- idempotency_key
- UUID opcional para ativações padrão. Reutilize a mesma chave somente para a mesma solicitação de compra quando o resultado estiver sendo verificado.
- quantity
- Inteiro opcional de 1 a 100 para pedidos de inventário de API Links; o padrão é 1. Pedidos de ativação padrão são de um único número.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/get_numbers \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"service":"tg","country":2}'Resposta
{
"id": "ORDER_ID",
"phone": "10000000000",
"price": "0.2500",
"balance_remaining": "9.7500"
}Errors
HTTP 400: seleção indisponível, limite de preço ou saldo insuficiente. HTTP 409: um pedido anterior ainda está sendo verificado. HTTP 503: falha temporária ou pedido incerto; se a resposta disser que é necessária reconciliação, não tente novamente e contate o suporte.
GET/sms/{order_id}Solicite uma nova verificação de status de um pedido ativo.
Chave de API obrigatória. Este endpoint tem limite de requisições.
Parâmetros
- order_id
- Valor de caminho obrigatório retornado quando o pedido foi criado.
Exemplo de requisição
curl https://api.smsactivate.uk/sms/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Resposta
{
"status": "received",
"sms_code": "123456",
"raw_sms": "Your verification code is 123456"
}Errors
HTTP 400: a verificação de SMS não está disponível para este pedido. HTTP 404: pedido não encontrado. HTTP 502: falha temporária na verificação. Pedidos expirados retornam o status armazenado sem nova verificação externa.
GET/status/{order_id}Consulte o status de um pedido e os SMS recebidos.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório retornado quando o pedido foi criado.
Exemplo de requisição
curl https://api.smsactivate.uk/status/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Resposta
{
"status": "received",
"sms_code": "123456",
"raw_sms": "Your verification code is 123456"
}Errors
A resposta se limita ao pedido da conta autenticada. Se a consulta de status falhar, a API retorna um erro; confira o ID do pedido e tente mais tarde se o serviço estiver temporariamente indisponível.
POST/resend/{order_id}Solicite outro SMS para uma ativação ativa compatível.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório. Sem corpo de requisição.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/resend/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Resposta
{ "message": "Resend request successful. Waiting for new SMS." }Errors
HTTP 400: reenvio não aceito ou pedido expirado. HTTP 409: o reenvio não está disponível para este pedido. HTTP 500: não foi possível concluir o reenvio.
POST/cancel/{order_id}Solicite o cancelamento de uma ativação elegível.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório. Sem corpo de requisição.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/cancel/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Resposta
{
"message": "Number cancelled and balance refunded",
"refunded_amount": "0.2500",
"new_balance": "10.0000"
}Errors
O cancelamento só está disponível para ativações ativas elegíveis, de 2 a 20 minutos após a compra e antes da chegada de um SMS. Aluguéis usam /rent/cancel/{order_id}; API Links são venda final. Cancelamentos inelegíveis ou não confirmados retornam um erro. Leia a resposta do cancelamento antes de tentar novamente.
GET/reactivate/{order_id}/optionsConsulte o preço e os detalhes atuais da reativação.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório do pedido original.
Exemplo de requisição
curl https://api.smsactivate.uk/reactivate/ORDER_ID/options -H "X-API-KEY: YOUR_API_KEY"Resposta
{
"price": 0.25,
"duration": 20,
"phone": "10000000000",
"service": "tg",
"country": 2
}Errors
HTTP 400: reativação não compatível ou indisponível. HTTP 409: a reativação não está disponível para este pedido. HTTP 503: não foi possível confirmar um preço atual válido.
POST/reactivate/{order_id}Reative uma ativação elegível pelo preço atual.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório do pedido original. Sem corpo de requisição.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/reactivate/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Resposta
{
"message": "Number reactivated successfully.",
"id": "NEW_ORDER_ID",
"phone": "10000000000",
"price": 0.25,
"balance_remaining": 9.75
}Errors
HTTP 400: reativação não compatível ou saldo da carteira insuficiente. HTTP 409: indisponível para este pedido. HTTP 503: não foi possível confirmar o resultado; contate o suporte antes de tentar novamente.
GET/orders/{order_id}Consulte os detalhes de um dos seus pedidos.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório retornado quando o pedido foi criado.
Exemplo de requisição
curl https://api.smsactivate.uk/orders/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Resposta
Returns the order record with buyer-facing fields, including its status and remaining time where applicable. Internal routing IDs and cost fields are not returned.Errors
HTTP 404: pedido não encontrado ou não pertence à sua conta.
Escolher serviços, países e preços
ServiçosPesquise o catálogo de serviços por nome ou código. A disponibilidade pode mudar; consulte o endpoint em tempo real antes de pedir.
163COMwp- 11688
hn - 11and1
ahs - 11xbet
wj - 224betting
lh - 22dehands
apd - 22domains
erc - 22ememain
blx - 22ГИС
bcg - 332Red
qi - 3360Kredi
ayo - 33Fun
auw - 44FunLite
hk - 5500px
fpx - 551exch
boc - 551exchange
exc - 77-Eleven
aws - 8888casino
ll - 9999 Md
brv
99acresfw
99appki- 999Game
qkb - 999k Outlet
amq - AA23
acv - AA9A
gn - AAadhar
hra
Abastece-aíanb- AAbbott
ags
Ace2Threerh- AAcima
cim - AAcko
amf
AdaKamiko- AAdaModal
bdo - AAdani
bq - AAdidas
an - AAditya Birla
qff - AAdmiralBet
bst - AAdobe
byh
Advertsagw- AAEG Presents
rsn - AAffirm
bow - AAfreecaTV
aip
AGIBANKsa- AAgoda
ag
AgriDevelopcs- AAgroinform
qu - AAhlan
bsm - AAiqfome
bbi - AAir Miles
bsy - AAirba Fresh
bnp
Airbnbuk- AAirtasker
byd
Airtelzl- AAirtime
acy
AISwv- AAIS PLAY
axs
Aitujj
Akudorf
Akulakutm
Alchemyaav
Alfabt
Alfagiftbn- AAlfamidi
bgt - AAlFursan
bxr - AAlgida
lp - AAlibaba
ab
AliExpresshx- AAlignable
aul
Alipay/Alibaba/1688hw
All Accessajy
Allegroyn
AlloBanknh- AAllofresh
aeo - AAltyn-i
al - AAmap 高德地图
btx - AAmarthaFin
bsv
Amasiayo- AAmaze Super App
bzk
Amazonam- AAme Digital
afi - AAmway
aee - AAngel One
aha
Ankamaalg- AAnnoncelight
byw
Any Otherot
AOLpm
ApostaGanhaml
Applewx
Apteka Aprelaeh
AptekaRUgk- AAptekiPlus
rq - AAR Lens
aco
ArenaPlusabt- AArgent
amo - AAri10
blq - AASAAS
bqr - AAsda
hs - AAsiaMiles
ajp - AAsianDating
ayb - AAskable
bpi - AAspiration
aptn
Astra Otoshopafd
AstraPayaem
Astropaygr- AASVLA
buj - AAti Su
bhl - AAtlas Earth
awq - AAtlasbus
atb
AttaPollanl- AAUBANK
du
Auchanst- AAudible
aud - AAukro
aox - AAuthentify
ccy - AAuthor24
kd - AAutodesk
bbl
Autoruaej- AAv100pro
ajl - AAvito
av
AVONff
Disponibilidade em tempo real e resposta de exemplo:
GET https://api.smsactivate.uk/services{
"services": ["tg", "wa", "go"],
"providers": { "source-counts": "per active catalog" },
"generated_at": "ISO 8601 timestamp"
}O catálogo fornece nomes e códigos para consulta. A disponibilidade é em tempo real e pode diferir desta lista; este JSON mostra o formato da resposta, não o estoque atual.
PaísesIDs numéricos de país do catálogo do painel. Não há endpoint geral da API com a lista de países para ativações padrão.
Afghanistan74
Albania155
Algeria58
Angola76
Anguilla181
Antigua and Barbuda169
Argentina39
Armenia148
Aruba179
Australia175
Austria50
Azerbaijan35
Bahamas122
Bahrain145
Bangladesh60
Barbados118
Belarus51
Belgium82
Belize124
Benin120
Bermuda195
Bhutan158
Bolivia92
Bosnia108
Botswana123
Brazil73
Brunei121
Bulgaria83
Burkina Faso152
Burundi119
Cambodia24
Cameroon41
Canada36
Cape Verde186
Cayman Islands170
Central African Republic125
Chad42
Chile151
China3
Colombia33
Comoros133
Congo150
Costa Rica93
Croatia45
Cuba113
Cyprus77
Czech63
Denmark172
Djibouti168
Dominica126
Dominican Republic109
DR Congo18
Ecuador105
Egypt21
Equatorial Guinea167
Eritrea176
Estonia34
Ethiopia71
Faroe Islands202
Fiji189
Finland163
France78
French Guiana162
Gabon154
Gambia28
Georgia128
Germany43
Ghana38
Gibraltar201
Greece129
Grenada127
Guadeloupe160
Guatemala94
Guinea68
Guinea-Bissau130
Guyana131
Haiti26
Honduras88
Hong Kong14
Hungary84
Iceland132
India22
Indonesia6
Iran57
Iraq47
Ireland23
Israel13
Italy86
Ivory Coast27
Jamaica103
Japan182
Jersey194
Jordan116
Kazakhstan2
Kenya8
Kosovo203
Kuwait100
Kyrgyzstan11
Laos25
Latvia49
Lebanon153
Lesotho136
Liberia135
Libya102
Liechtenstein200
Lithuania44
Luxembourg165
Macao20
Madagascar17
Malawi137
Malaysia7
Maldives159
Mali69
Malta199
Mauritania114
Mauritius157
Mexico54
Moldova85
Monaco144
Mongolia72
Formato da resposta de ofertas para um serviço e país:
[
{ "name": "any", "offers": [{ "price": 0.25, "count": 4 }] }
]Os IDs do catálogo identificam opções de país, não garantem ofertas em tempo real. Consulte /offers/{service}/{country} para ver a disponibilidade.
GET/servicesConsulte a disponibilidade atual dos serviços.
Público - não exige chave de API.
Parâmetros
- Nenhum
- Este endpoint não aceita parâmetros de consulta.
Exemplo de requisição
curl https://api.smsactivate.uk/servicesResposta
Returns the current services array and generated_at timestamp. See the searchable Services catalog below for code/name lookup; it is a maintained reference, not a live availability guarantee.Errors
A disponibilidade pode mudar. Consulte o endpoint em tempo real e /offers/{service}/{country} antes de fazer um pedido.
GET/countries/{service}Liste os IDs de país que têm números para um serviço.
Público - não exige chave de API.
Parâmetros
- service
- Código de serviço obrigatório, como tg.
Exemplo de requisição
curl https://api.smsactivate.uk/countries/tgResposta
{ "countries": [2, 6, 187] }Errors
Os IDs de país correspondem ao catálogo de países abaixo. A disponibilidade muda; consulte /offers/{service}/{country} antes de pedir. Este endpoint tem limite de requisições.
GET/offers/{service}/{country}/deliveryVeja as taxas recentes de entrega de códigos por faixa de preço.
Público - não exige chave de API.
Parâmetros
- service
- Código de serviço obrigatório, como tg.
- country
- ID numérico de país obrigatório.
Exemplo de requisição
curl https://api.smsactivate.uk/offers/tg/2/deliveryResposta
{
"window_days": 30,
"tiers": { "0.2500": { "orders": 120, "codes": 108, "delivery_pct": 90, "best": true } }
}Errors
HTTP 400: serviço ou país inválido. Faixas sem códigos entregues não são listadas. Os resultados ficam em cache por cerca de 5 minutos e cobrem os últimos window_days dias. Este endpoint tem limite de requisições.
GET/operators?service={service}&country={country}Liste as operadoras disponíveis para um serviço e país.
Público - não exige chave de API.
Parâmetros
- service
- Código de serviço obrigatório, como tg.
- country
- ID numérico de país obrigatório.
Exemplo de requisição
curl 'https://api.smsactivate.uk/operators?service=tg&country=2'Resposta
[
{ "name": "any", "localName": "Any Operator" },
{ "name": "example", "localName": "Example operator" }
]Errors
A lista depende do país selecionado e da disponibilidade atual. service e country são obrigatórios; valores ausentes ou inválidos retornam HTTP 422.
GET/links/optionsListe os serviços e países do catálogo de API Links.
Público - não exige chave de API.
Parâmetros
- Nenhum
- Este endpoint não aceita parâmetros de consulta.
Exemplo de requisição
curl https://api.smsactivate.uk/links/optionsResposta
{
"services": [{
"id": "sample_service",
"name": "Sample service",
"countries": [{ "id": 2, "name": "United States", "price": 0.25, "stock": 4 }]
}],
"countries": [{ "id": 2, "name": "United States" }]
}Errors
Esta lista é apenas para API Links. Não é uma lista geral de países para pedidos de ativação padrão.
GET/links/offers/{service}/{country}Consulte os preços e o estoque atuais de inventário de API Links.
Público - não exige chave de API.
Parâmetros
- service
- Código de serviço do catálogo de opções de API Links.
- country
- ID numérico de país da lista de países de API Links do serviço selecionado.
Exemplo de requisição
curl https://api.smsactivate.uk/links/offers/tg/1Resposta
[{ "name": "any", "offers": [{ "price": "0.2500", "count": 4 }] }]Errors
Seleções indisponíveis retornam uma lista vazia. Para comprar este produto, envie product=api_links para /get_numbers. API Links são venda final; quantity é 1 por padrão e deve estar entre 1 e 100.
GET/offers/{service}/{country}Consulte as ofertas de uma combinação de serviço e país.
Público - não exige chave de API.
Parâmetros
- service
- Valor de caminho obrigatório. Use um código de serviço retornado por /services, como tg.
- country
- Valor de caminho obrigatório. ID numérico de país; use o catálogo de países do painel para ativações padrão. Não há endpoint geral da API que liste esses IDs de país.
Exemplo de requisição
curl https://api.smsactivate.uk/offers/tg/2Resposta
[
{
"name": "any",
"offers": [{ "price": "0.2500", "count": 4 }]
}
]Errors
Um par não compatível ou indisponível pode retornar uma lista vazia. Os dados de ofertas ficam em cache; uma falha de cache pode demorar mais enquanto a disponibilidade é verificada.
Ver atividade anterior
GET/ordersVeja seu histórico de pedidos, do mais recente ao mais antigo.
Chave de API obrigatória.
Parâmetros
- page
- Número de página opcional; o padrão é 1.
- per_page
- Tamanho de página opcional; o padrão é 20 e o limite é 100.
- status
- Opcional: active, completed (ou received), cancelled, expired, refunded. Omita ou use all para incluir todos os status.
- search
- Busca opcional por número de telefone.
- category
- Opcional: rents, links ou numbers.
Exemplo de requisição
curl 'https://api.smsactivate.uk/orders?page=2&per_page=100&status=received&category=numbers' -H "X-API-KEY: YOUR_API_KEY"Resposta
{
"current_page": 2,
"data": [{ "id": "ORDER_ID", "status": "received", "phone": "10000000000" }],
"first_page_url": "…?page=1",
"last_page": 4,
"last_page_url": "…?page=4",
"next_page_url": "…?page=3",
"per_page": 100,
"prev_page_url": "…?page=1",
"total": 350
}Errors
Siga next_page_url até que seja null. page é 1 por padrão; per_page é 20 por padrão e os valores são limitados a 1–100. status aceita active, completed/received, cancelled, expired ou refunded; all ou um valor desconhecido deixa status sem filtro. search corresponde a números de telefone. category aceita rents, links ou numbers; categorias desconhecidas são ignoradas. Históricos grandes exigem várias requisições de página.
Aluguéis
GET/rent/servicesConsulte os serviços de aluguel para um país e uma duração.
Chave de API obrigatória.
Parâmetros
- country
- ID de país inteiro opcional; o padrão é 2.
- duration
- Horas opcionais; o padrão é 24. Intervalo permitido: 24–1.344 horas.
Exemplo de requisição
curl 'https://api.smsactivate.uk/rent/services?country=2&duration=24' -H "X-API-KEY: YOUR_API_KEY"Resposta
Returns rental availability, with service codes and current prices for the selected country and duration.Errors
HTTP 400: nenhum número de aluguel disponível para a seleção. HTTP 422: país ou duração inválidos. HTTP 503: catálogo de aluguéis temporariamente indisponível.
POST/rent/orderFaça um pedido de aluguel.
Chave de API obrigatória.
Parâmetros
- service
- Código de serviço obrigatório (string).
- country
- ID de país obrigatório (inteiro).
- duration
- Horas obrigatórias, de 24 a 1.344.
- operator
- String opcional; o padrão é any.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/rent/order \
-H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"service":"tg","country":2,"duration":24}'Resposta
{
"message": "Number rented successfully.",
"id": "ORDER_ID",
"phone": "10000000000",
"price": 2.50,
"balance_remaining": 7.50
}Errors
HTTP 400: requisição inválida ou saldo insuficiente. HTTP 409: nenhum aluguel disponível. HTTP 503: o resultado está pendente de análise; não tente novamente até o suporte verificar o pedido.
POST/rent/cancel/{order_id}Solicite o cancelamento de um aluguel elegível.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório. Sem corpo de requisição.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/rent/cancel/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Resposta
Returns the cancellation result. Refunds may remain pending verification after cancellation is accepted.Errors
O cancelamento se limita a aluguéis ativos elegíveis, de 2 a 20 minutos após a compra e antes da chegada de um SMS. HTTP 404: aluguel não encontrado. HTTP 409: o aluguel não é elegível. Se aceito, o reembolso pode ficar pendente de verificação.
GET/rent/extend/{order_id}/optionsConsulte as opções de extensão disponíveis para um aluguel.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório do aluguel.
Exemplo de requisição
curl https://api.smsactivate.uk/rent/extend/ORDER_ID/options -H "X-API-KEY: YOUR_API_KEY"Resposta
{
"options": [{ "duration": 24, "price": 2.50 }],
"expires_at": "2026-10-06T12:00:00Z"
}Errors
HTTP 404: aluguel não encontrado. HTTP 409: o aluguel não é elegível (a extensão abre após os primeiros 20 minutos, o aluguel deve estar active ou received, ou há uma extensão anterior pendente de análise). HTTP 503: a extensão está temporariamente indisponível ou as opções não puderam ser carregadas; tente mais tarde. Este endpoint tem limite de requisições.
POST/rent/extend/{order_id}Estenda um aluguel ativo.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório do aluguel.
- duration
- Obrigatório: 24, 72, 168, 336, 720, 1.440, 2.160 ou 4.320 horas. Escolha na resposta atual de opções.
- expected_price
- Número obrigatório copiado da resposta atual de opções.
- Idempotency-Key
- Cabeçalho de requisição UUID v4 obrigatório. Reutilize-o somente para repetir com segurança a mesma tentativa de extensão.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/rent/extend/ORDER_ID \
-H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
-H "Idempotency-Key: 3f6c1a52-8b1e-4c47-9d0a-6a1f2c9e7b10" \
-d '{"duration":24,"expected_price":2.50}'Resposta
{
"message": "Rental extended successfully.",
"attempt_id": "REQUEST_UUID",
"status": "settled",
"charged": 2.50,
"new_expires_at": "2026-10-10T12:00:00Z",
"balance_remaining": 7.50
}Errors
HTTP 422: duration, expected_price ou Idempotency-Key ausente/inválido. HTTP 409: o aluguel não é elegível, a duração ou o preço não é mais oferecido, ou a Idempotency-Key já foi usada. HTTP 202: a extensão está pendente de análise; não tente novamente com uma nova chave de idempotência. HTTP 503: a extensão não pôde ser confirmada; contate o suporte.
Verificação por e-mail
GET/emails/catalog?site={site}Liste os domínios de endereço de verificação disponíveis para um site.
Chave de API obrigatória.
Parâmetros
- site
- Domínio do site obrigatório, por exemplo example.com.
Exemplo de requisição
curl 'https://api.smsactivate.uk/emails/catalog?site=example.com' -H "X-API-KEY: YOUR_API_KEY"Resposta
[{ "name": "sample-domain.test", "price": 0.10, "stock": 5 }]Errors
HTTP 422: valor de site inválido. HTTP 503: catálogo de e-mail temporariamente indisponível.
POST/emails/buyCompre um endereço de verificação.
Chave de API obrigatória.
Parâmetros
- site
- Domínio do site obrigatório.
- domain
- Domínio obrigatório escolhido na resposta atual do catálogo.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/emails/buy \
-H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"site":"example.com","domain":"sample-domain.test"}'Resposta
Returns an order object and balance_remaining when the purchase is confirmed.Errors
HTTP 400: saldo da carteira insuficiente. HTTP 409: domínio sem estoque. HTTP 503: a compra está pendente de análise; não tente novamente até o suporte verificar o pedido.
POST/emails/{order_id}/reorderPeça o mesmo endereço novamente depois que o pedido anterior terminar.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório de um pedido de e-mail finalizado (numérico). Sem corpo de requisição.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/emails/ORDER_ID/reorder -H "X-API-KEY: YOUR_API_KEY"Resposta
Returns the new email order, same shape as the email order response. The price is quoted at order time and charged from your balance.Errors
HTTP 404: pedido não encontrado. HTTP 409: o pedido anterior não terminou, já há um novo pedido em andamento ou este endereço não pode ser pedido novamente agora. HTTP 503: as verificações por e-mail estão temporariamente indisponíveis. Este endpoint tem limite de requisições.
GET/emails/historyListe seus pedidos de verificação por e-mail.
Chave de API obrigatória.
Parâmetros
- page
- Número de página opcional; o padrão é 1.
- per_page
- Tamanho de página opcional; o padrão é 20 e o limite é 50.
Exemplo de requisição
curl 'https://api.smsactivate.uk/emails/history?page=1&per_page=20' -H "X-API-KEY: YOUR_API_KEY"Resposta
Returns paginated order data and page metadata.Errors
Se a tabela de pedidos de e-mail não estiver disponível, a API retorna um array data vazio.
GET/emails/status/{order_id}Leia ou atualize um pedido de verificação.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório retornado pela resposta de compra.
Exemplo de requisição
curl https://api.smsactivate.uk/emails/status/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Resposta
Returns the order status and available verification result fields.Errors
HTTP 404: pedido não encontrado. HTTP 503: não foi possível atualizar o status. A resposta inclui apenas os campos disponíveis para o pedido.
DELETE/emails/{order_id}Solicite o cancelamento de um pedido de verificação por e-mail.
Chave de API obrigatória.
Parâmetros
- order_id
- Valor de caminho obrigatório retornado pela resposta de compra.
Exemplo de requisição
curl -X DELETE https://api.smsactivate.uk/emails/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Resposta
Returns the cancellation result. The refund can remain pending verification.Errors
O pedido deve pertencer à sua conta e ser elegível para cancelamento; veja a mensagem de erro retornada para o estado atual do pedido. Se a resposta disser que o cancelamento ainda não foi confirmado (HTTP 503), aguarde alguns minutos e envie a requisição novamente.
Webhooks
GET/webhookLeia a configuração do seu webhook.
Chave de API obrigatória.
Parâmetros
- Nenhum
- Sem parâmetros de consulta.
Exemplo de requisição
curl https://api.smsactivate.uk/webhook -H "X-API-KEY: YOUR_API_KEY"Resposta
Returns the saved endpoint configuration. The signing secret is not returned by this read request.Errors
Retorna a configuração atual da conta autenticada.
PUT/webhookCrie ou atualize a URL do seu webhook.
Chave de API obrigatória.
Parâmetros
- url
- URL HTTPS pública obrigatória na porta 443. Endereços locais e privados são rejeitados.
Exemplo de requisição
curl -X PUT https://api.smsactivate.uk/webhook \
-H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"url":"https://example.com/hooks/sms"}'Resposta
Returns the saved configuration. On first setup the signing secret is returned once; store it safely.Errors
HTTP 422: a URL não é um endereço HTTPS público aceito.
POST/webhook/rotate-secretSubstitua o segredo de assinatura do seu webhook configurado.
Chave de API obrigatória.
Parâmetros
- Nenhum
- Sem corpo de requisição. Configure um webhook primeiro.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/webhook/rotate-secret -H "X-API-KEY: YOUR_API_KEY"Resposta
{ "secret": "NEW_SECRET_SHOWN_ONCE" }Errors
HTTP 404: nenhum webhook configurado. Guarde o novo segredo com segurança; ele é retornado por esta resposta de rotação, não pelo endpoint de leitura.
DELETE/webhookRemova a configuração do seu webhook.
Chave de API obrigatória.
Parâmetros
- Nenhum
- Sem corpo de requisição.
Exemplo de requisição
curl -X DELETE https://api.smsactivate.uk/webhook -H "X-API-KEY: YOUR_API_KEY"Resposta
{ "configured": false }Errors
Remove a configuração de webhook da conta autenticada.
POST/webhook/testEnvie um evento de teste para o seu endpoint configurado.
Chave de API obrigatória.
Parâmetros
- Nenhum
- Sem corpo de requisição. Configure um webhook primeiro.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/webhook/test -H "X-API-KEY: YOUR_API_KEY"Resposta
{
"delivered": true,
"http_status": 200,
"message": "Your server accepted the test message."
}Errors
HTTP 404: nenhum webhook configurado. Uma entrega de teste informa delivered=false quando seu servidor não a aceita.
GET/webhook/deliveriesVeja até 50 tentativas recentes de entrega de webhook.
Chave de API obrigatória.
Parâmetros
- Nenhum
- Sem parâmetros de consulta.
Exemplo de requisição
curl https://api.smsactivate.uk/webhook/deliveries -H "X-API-KEY: YOUR_API_KEY"Resposta
{
"data": [{ "id": 42, "event_id": "EVENT_ID", "event_type": "sms.received", "status": "success", "attempts": 1, "http_status": 200 }]
}Errors
Retorna as 50 entregas HTTP de webhook mais recentes, da mais nova para a mais antiga.
POST/webhook/deliveries/{id}/retryTente novamente agora uma das suas entregas de webhook.
Chave de API obrigatória.
Parâmetros
- id
- Valor de caminho obrigatório do registro de entrega.
Exemplo de requisição
curl -X POST https://api.smsactivate.uk/webhook/deliveries/42/retry -H "X-API-KEY: YOUR_API_KEY"Resposta
{ "status": "success", "http_status": 200 }Errors
HTTP 404: entrega não encontrada. Este endpoint tem limite de requisições.
4. Cobrança
Seu saldo é cobrado quando você faz um pedido. Ativações que não recebem nenhum SMS dentro da janela de 20 minutos são reembolsadas no seu saldo. As regras de cancelamento e reembolso são diferentes para aluguéis, e-mails e API Links.
5. Cancelamento e reembolsos
Em pedidos de números (ativações), você pode solicitar o cancelamento depois dos primeiros 2 minutos e antes do fim da janela de ativação de 20 minutos, apenas enquanto nenhum SMS tiver chegado. Cancelamentos elegíveis e confirmados devolvem o valor do pedido ao seu saldo.
Uma ativação não pode ser cancelada depois que um SMS chega nem depois do fim da sua janela. Se uma ativação elegível não receber nenhum SMS durante a janela de 20 minutos, o valor do pedido é reembolsado no seu saldo.
Os aluguéis podem ser cancelados na mesma janela de 2 a 20 minutos, enquanto nenhum código tiver chegado. O reembolso de um aluguel fica pendente de verificação e não é automático.
Números em lote, API Links e pedidos de e-mail não são reembolsáveis depois de entregues, a menos que o painel indique o contrário.
Se não for possível confirmar um cancelamento, fale com o suporte antes de tentar novamente.
Frequently asked questions
How do I authenticate with the API?
Create or rotate a key in your dashboard. Send it in the X-API-KEY header with every request. The key is shown once when you create or rotate it. Keep it server-side. Open your dashboard.
What do I need for my first order?
A service code and a numeric country ID. Find them with GET /services and GET /countries/{service}, then check GET /offers/{service}/{country}. Prices are shown live in the dashboard. See live prices.
How do I read the code that arrives?
Poll GET /status/{order_id} and read sms_code when the status is received. GET /sms/{order_id} is rate-limited; do not use it for routine polling.
What if no SMS arrives?
An eligible activation with no SMS in its 20-minute window is refunded. You can also cancel an eligible active activation 2 to 20 minutes after purchase, before an SMS arrives. If a purchase response is uncertain, do not retry it; contact support. Read the FAQ.
Can I cancel an order?
For eligible active activations: POST /cancel/{order_id}, 2 to 20 minutes after purchase, before an SMS arrives. Rentals use POST /rent/cancel/{order_id}. API Links are final sale.
Does this API send verification codes to my users?
No. It receives codes on a number you order. If you need to send codes to your own users, this API is not the tool for that job.
How do webhooks work?
Set a public HTTPS URL on port 443 with PUT /webhook; the signing secret is returned once. Verify the signature as sha256= HMAC-SHA256 of "
Precisa de um limite maior ou de uma integração sob medida? Fale com nossa equipe. ou abra o seu painel.
