Alterar status de aluguel

O método setRentStatus é utilizado para alterar o status atual de um número virtual alugado através da API SMS.online. Esse método permite automatizar a gestão dos status de aluguel, incluindo o término do uso do número, a prorrogação do aluguel ou a liberação do número.

O método é destinado a sistemas que exigem controle em tempo real do status dos números alugados. Com ele, é possível indicar o término do aluguel, prorrogações ou outras alterações de status, mantendo as informações atualizadas.

Uma solicitação bem-sucedida retorna um objeto com a confirmação da alteração do status de aluguel, incluindo os parâmetros atualizados do aluguel. O método é especialmente útil em serviços que requerem atualização rápida das informações sobre o uso dos números alugados.

Exemplo de solicitação:

Dados de entrada

ParâmetroObrigatórioNotaDescrição
SimVeja no perfil nas configurações Chave APIA chave API fornece acesso aos serviços pagos
SimsetRentStatusNome do método
SimValor numéricoID de ativação obtido ao solicitar o número
SimValor numéricoStatus do aluguel

O status pode assumir os seguintes valores:

1 - Encerrar uso do número

2 - Cancelar compra

Resposta do servidor

JSON
{ 
  "status": "success"
}

Exemplo de código

const api_key = "API_KEY"; # Substitua 'API_KEY' pela sua chave API real.
const id = 1; # Insira o ID de ativação obtido ao solicitar o número
const status = 1; # Insira o novo status da tabela acima
try {
const response = await fetch(`https://api.sms.onlinestubs/handler_api.php?api_key=${api_key}&action=setRentStatus&id=${id}&status=${status}`);
# Realizando uma solicitação GET para a URL especificada
const data = await response.json();
# Exibindo 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 API inválida
Erro na solicitação
Tempo pelo qual a conta está bloqueada
Conta inativa
ID de aluguel não especificado
Número alugado não pertence a você (ID de aluguel incorreto)
Status ausente ou incorretamente especificado
Não é possível cancelar o aluguel (mais de 20 min.)
Aluguel já concluído
Aluguel já cancelado