FAQAPI

Solicitação de número para locação

O método getRentNumber é utilizado para alugar um número virtual por um período específico via API SMS.online. Ele automatiza o processo de obtenção de um número para receber SMS em um país determinado e de um serviço específico. Você pode definir os parâmetros do país, serviço e (opcionalmente) operador para escolher um número disponível para uso prolongado.

Este método é ideal para situações em que é necessário um número virtual constante por vários dias, semanas ou meses. Isso permite integrar o número em sistemas que exigem um canal estável para receber SMS por um longo período.

Uma solicitação bem-sucedida retorna um objeto com informações sobre o número, incluindo seu identificador, período de locação e custo. O método é especialmente útil para aplicativos e serviços com ciclos de interação prolongados, onde o acesso contínuo a um único número é necessário.

Exemplo de solicitação:

Dados de entrada

ParâmetroObrigatórioObservaçãoDescrição
SimVeja no perfil nas configurações Chave da APIA chave da API fornece acesso aos serviços pagos
SimgetRentNumberNome do método
SimVeja a lista de serviços no menu à esquerdaServiço, número para o qual é necessário obter
SimVeja a lista de países no menu à esquerdaPaís, número que precisa ser obtido
NãoVeja a lista de operadores no menu à esquerdaOperadora de telefonia, número que precisa ser obtido
Não4, 8, 12, 24, 72, 168, 360, 720, 2160Tempo de locação em horas
Não-Link para webhook (padrão não considerado)

Resposta do servidor

JSON
{ 
  "status": "success", 
  "phone": { 
    "id": 1, 
    "endDate": "2025-05-10T12:34:56", 
    "number": "79999876543"
    } 
}

Exemplo de código

const api_key = "API_KEY"; # Substitua 'API_KEY' pela sua chave de API real.
const service = "SERVICE"; # Substitua 'SERVICE' pelo identificador do serviço. Todos os identificadores podem ser visualizados na documentação na lista do menu à esquerda.
const country = 1; # Insira o número do país desejado. Os números de todos os países podem ser visualizados na documentação na lista do menu à esquerda.
try {
const response = await fetch(`https://api.sms.onlinestubs/handler_api.php?api_key=${api_key}&action=getRentNumber&service=${service}&country=${country}`);
# Realizamos uma solicitação GET para a URL especificada
const data = await response.json();
# Exibimos o conteúdo da resposta do servidor
console.log(data);
} catch (err) {
# Se ocorreu um erro, exibimos a mensagem de erro
console.error(err);
}

Possíveis erros

ParâmetroDescrição
Ação inválida
Chave da API inválida
Erro na solicitação
Tempo pelo qual a conta está bloqueada
Conta inativa
Nome do país inválido
Nome do serviço inválido
Hora inválida
Saldo não encontrado
Nenhum número disponível
Conta bloqueada