FAQAPI

Lista de números virtuais alugados ativos

O método getRentList é usado para obter a lista atual de todos os números virtuais alugados associados à sua conta via API SMS.online. Ele permite monitorar em tempo real os aluguéis ativos e gerenciar o uso dos recursos.

O método retorna informações detalhadas sobre cada aluguel, incluindo ID único do aluguel, data de início, duração, status atual, número de telefone e custo do aluguel. Isso facilita a gestão dos números ativos e permite renovar ou encerrar o aluguel a tempo.

O método é especialmente útil para sistemas de automação, análise e monitoramento, onde é necessário exibir apenas os números alugados atuais, sem o histórico de sessões concluídas.

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
SimgetRentListNome do método
SimValor numéricoID de locação, obtido ao solicitar o número

Resposta do servidor

JSON
{
  "status": "success", 
  "values": [
    { 
      "id": "12345", 
      "phone": "79181234567",
      "price": "100",
      "hours": "4"
    }, 
    { 
      "id": "12345", 
      "phone": "79181234568",
      "price": "100",
      "hours": "4"
    } 
  ]
}

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=getRentList&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