FAQAPI

Consulta de saldo da conta

O método getBalance é utilizado para obter o saldo atual da conta via API SMS.online. Ele permite automatizar a verificação dos fundos disponíveis, garantindo o controle de gastos e a continuidade do serviço.

Esse método é recomendado para sistemas que precisam de monitoramento regular da conta e decisões sobre recargas pontuais. Isso ajuda a evitar interrupções no serviço devido à falta de fundos.

Uma solicitação bem-sucedida retorna um objeto com informações sobre o saldo atual, incluindo os fundos disponíveis no momento da consulta. O método é especialmente útil em sistemas automatizados que requerem monitoramento em tempo real do saldo.

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
SimgetBalanceNome do método

Resposta do servidor

ACCESS_BALANCE:BALANCE
BALANCE - Saldo da conta em dólares

Exemplo de código

const api_key = "API_KEY"; # Substitua 'API_KEY' pela sua chave API real.
try {
const response = await fetch(`https://api.sms.onlinestubs/handler_api.php?api_key=${api_key}&action=getBalance`);
# 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