Alterar status de locação

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

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 da locação, a prorrogação 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 locação, 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

Obrigatório	Observação	Descrição
Sim	Veja no perfil nas configurações Chave da API	A chave da API fornece acesso aos serviços pagos
Sim	setRentStatus	Nome do método
Sim	Valor numérico	ID de ativação, obtido ao solicitar o número
Sim	Valor numérico	Status da locação

O status pode assumir os 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 de 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}`);
# 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âmetro	Descriçã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)
	Status ausente ou incorretamente especificado
	Não é possível cancelar a locação (mais de 20 min.)
	Locação já finalizada
	Locação já cancelada