FAQAPI

Consultar status da locação do número

O método getRentStatus é utilizado para obter o status atual do número virtual alugado via API SMS.online. Ele automatiza o processo de verificação da locação e permite acompanhar os códigos SMS recebidos no número alugado.

Esse método é ideal para sistemas que precisam monitorar regularmente o número alugado, garantindo o recebimento oportuno de códigos de confirmação e outros dados durante o período de locação.

Uma solicitação bem-sucedida retorna um objeto com informações sobre o status atual da locação, incluindo um identificador único da locação, uma lista de códigos SMS recebidos e o tempo restante da locação. Isso permite um controle eficaz do uso do número e do recebimento de mensagens em tempo real.

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
SimgetRentStatusNome do método
SimValor numéricoID de ativação, obtido ao solicitar o número
NãoValor numéricoNúmero da página de onde começa a seleção (a numeração das páginas começa em 0, do mais novo para o mais antigo; padrão 0)
NãoValor numéricoNúmero de páginas solicitadas (padrão 10)

Resposta do servidor

JSON
{
  "status": "success", 
  "quantity": "2", 
  "values": { 
    "0": { 
      "phoneFrom": "79180230628", 
      "text": "5", 
      "service": "ot", 
      "date": "2020-01-30 14:31:58" 
    }, 
    "1": { 
      "phoneFrom": "79180230628", 
      "text": "4", 
      "service": "ot", 
      "date": "2025-05-30 14:04:16" 
    } 
  } 
}

Exemplo de código

const api_key = "API_KEY"; # Substitua 'API_KEY' pela sua chave de API real.
const id = 1; # Insira o ID de ativação obtido ao solicitar o número
try {
const response = await fetch(`https://api.sms.onlinestubs/handler_api.php?api_key=${api_key}&action=getRentStatus&id=${id}`);
# 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
ID de locação não especificado
Número alugado não é seu (ID de locação incorreto)
Locação paga e finalizada
Locação cancelada com reembolso
Aguardando o primeiro SMS
Número bloqueado, fundos devolvidos