Documentação da API
Nossa API (Application Programming Interface) é totalmente compatível com o protocolo universal padrão de mercado de SMS. Isso significa que você pode integrar o BrazucaSMS facilmente em qualquer software, painel SMM ou robô de automação que suporte esse padrão, sem a necessidade de reescrever códigos complexos!
1. URL Base & Autenticação
Todos os pedidos (suporte a GET e POST) devem ser direcionados para a nossa URL Base. É obrigatório enviar a sua chave secreta no parâmetro api_key.
https://brazucasms.com/api/externalAcesse a aba de Perfil aqui no site para gerar sua chave secreta. Mantenha-a em sigilo absoluto!
2. Erros Comuns
Ao fazer uma requisição, o servidor pode retornar um erro genérico. Prepare seu sistema para tratá-los:
| Resposta do Servidor | Descrição |
|---|---|
| BAD_KEY | A chave de API informada é inválida ou foi revogada. |
| NO_BALANCE | A sua conta não tem saldo suficiente para realizar esta ação. |
| BAD_ACTION | Ação inválida ou parâmetros obrigatórios ausentes na URL. |
| ERROR_SQL | Erro interno de banco de dados. Tente novamente mais tarde. |
3. Endpoints de Ação
Consultar Saldo (getBalance)
?api_key=SUA_CHAVE&action=getBalanceRetorna o saldo atualizado da sua conta para compras na API.
ACCESS_BALANCE:150.50Tabela de Preços (getPrices)
?api_key=SUA_CHAVE&action=getPrices&country=73Retorna um JSON listando a quantidade de números em estoque e o custo unitário por serviço.
{"73": {"wa": {"Cost": 3.5, "Count": 1500}, "tg": {"Cost": 2.0, "Count": 340}}}Solicitar Número (getNumber)
?api_key=SUA_CHAVE&action=getNumber&service=wa&operator=any&country=73| Parâmetro | Obrigatório | Descrição |
|---|---|---|
| service | Sim | Código do serviço (ex: wa, tg, ig) |
| operator | Não | Use any para rota automática ou especifique o servidor desejado (ex: server1, server2, server3). |
| country | Não | Código do país (ex: 73 para Brasil). |
ACCESS_NUMBER:9876543:5511999999999 (ID : Número com DDI)Erros Específicos: NO_NUMBERS (Estoque esgotado), WRONG_SERVICE (Serviço inválido)Consultar SMS (getStatus)
?api_key=SUA_CHAVE&action=getStatus&id=ID_DA_ATIVACAOUtilize este comando em loop (a cada 5-10 segundos) para verificar se o SMS chegou na operadora.
STATUS_WAIT_CODESucesso: STATUS_OK:654321 (Onde 654321 é o SMS recebido)Cancelado: STATUS_CANCELGerenciar Status (setStatus)
?api_key=SUA_CHAVE&action=setStatus&id=ID_DA_ATIVACAO&status=STATUS_IDEnvia um comando para a operadora (Cancelar ou Solicitar Reenvio).
| Status | Ação Executada |
|---|---|
| 8 | Cancelar Ativação. Devolve imediatamente o valor integral para o seu saldo e finaliza o número. Retorno esperado: ACCESS_CANCEL. |
| 3 | Solicitar novo SMS. Avisa a operadora que você precisa de mais um SMS para o mesmo número (ex: verificação dupla). Retorno esperado: ACCESS_RETRY_GET. |
4. Lista de Serviços Disponíveis
Abaixo está a lista completa dos códigos dos serviços suportados pela nossa API (exclusivos para integração). Os serviços de WhatsApp e Telegram foram omitidos desta lista por estarem restritos.
kiacmesabbiukabhxhwampmmlwxbqrgrbbllivcabdiebzbblzsbajhtuabzjwannsybrdouztmoavyaffmylsgjpcixetreomwcaxcclajeahizkxkdsudblrcjxjdhbzwefiufarfapbetsyfbalcaslanyseaimcnnzmvbkxeargulaiujdadsgoccughtgmsggfafeywalbikguvdfvzhrnjieiqpdimrlanxigilbtnadzaxxpuk8betktrakiqvpfhdldometnluckybehafqfdbwvuycqamvmcmmgmaombgjaxmabnawgnvaexnfaeyawhewtfxoaaaokvmaornssndrotauzabgggzrabfnctsaolpcpbqhfxevopdpffjanwafsaadpbxjaykabaajjxuaozqfreipijavpljabjaezvgkaanabwaqtskyvapbagbfubxzmxkymtxrepqqlzrbgplftimmmampoiauchbtwubahbafrabhbdwvikckxvkebwrbfawbkfthbsampvsbaaboxvfaamlyumbylyayiyetzsmembtmzh