# SMSGo | API SMS ## API Docs - Raiz > Autenticação [Trocar SMSGo-key por token Bearer](https://doc.smsgo.com.br/trocar-smsgo-key-por-token-bearer-39041496e0.md): Recebe a chave permanente no header `SMSGo-key` e retorna um token Bearer válido por 48h. - Raiz > Autenticação [Revogar o token atual](https://doc.smsgo.com.br/revogar-o-token-atual-39041497e0.md): - Raiz > SMS [Enviar um SMS](https://doc.smsgo.com.br/enviar-um-sms-39041498e0.md): Envia uma mensagem para um número. Debita o saldo da conta. - Raiz > SMS [Enviar SMS em massa](https://doc.smsgo.com.br/enviar-sms-em-massa-39041499e0.md): Envia várias mensagens em uma transação única (até 5000). Debita o total do saldo. - Raiz > SMS [Listar envios](https://doc.smsgo.com.br/listar-envios-39041500e0.md): - Raiz > SMS [Detalhar um envio](https://doc.smsgo.com.br/detalhar-um-envio-39041501e0.md): Retorna o envio, seus números e um objeto `summary` de acompanhamento com as contagens por bucket de status: `{ total, delivered, failed, inProgress, done }`. `done` é `true` quando nenhum número está mais em andamento (processo encerrado). - Raiz > SMS [Listar números de um envio (paginado)](https://doc.smsgo.com.br/listar-n%C3%BAmeros-de-um-envio-paginado-39041502e0.md): Lista paginada dos números do envio, para acompanhar envios grandes sem baixar tudo de uma vez. Filtre por bucket de status com `status`. - Raiz > SMS [Catálogo de tipos de SMS](https://doc.smsgo.com.br/cat%C3%A1logo-de-tipos-de-sms-39041503e0.md): Lista os tipos de SMS ativos, cujo `id` é aceito em `sms_type_id` nos endpoints de envio. O tipo decide o roteamento no provedor (ex.: o tipo de token usa a rota OTP de entrega imediata, quando disponível na conta). O preço é único por segmento, independente do tipo. - Raiz > Contatos [Listar contatos](https://doc.smsgo.com.br/listar-contatos-39041504e0.md): - Raiz > Contatos [Criar contato](https://doc.smsgo.com.br/criar-contato-39041505e0.md): Cria (ou faz upsert pelo telefone) um contato. Retorna o UUID do contato. - Raiz > Contatos [Detalhar contato](https://doc.smsgo.com.br/detalhar-contato-39041506e0.md): - Raiz > Contatos [Atualizar contato](https://doc.smsgo.com.br/atualizar-contato-39041507e0.md): - Raiz > Contatos [Excluir contato](https://doc.smsgo.com.br/excluir-contato-39041508e0.md): - Raiz > Listas [Listar listas](https://doc.smsgo.com.br/listar-listas-39041509e0.md): - Raiz > Listas [Criar lista](https://doc.smsgo.com.br/criar-lista-39041510e0.md): - Raiz > Listas [Detalhar lista](https://doc.smsgo.com.br/detalhar-lista-39041511e0.md): - Raiz > Listas [Atualizar lista](https://doc.smsgo.com.br/atualizar-lista-39041512e0.md): - Raiz > Listas [Excluir lista](https://doc.smsgo.com.br/excluir-lista-39041513e0.md): - Raiz > Conta [Consultar saldo da conta](https://doc.smsgo.com.br/consultar-saldo-da-conta-39041514e0.md): Retorna o saldo monetário (R$) disponível e os dados básicos da conta. - Raiz > Conta [Ler configuração de recarga automática](https://doc.smsgo.com.br/ler-configura%C3%A7%C3%A3o-de-recarga-autom%C3%A1tica-39041515e0.md): - Raiz > Conta [Atualizar recarga automática + alerta de saldo](https://doc.smsgo.com.br/atualizar-recarga-autom%C3%A1tica-alerta-de-saldo-39041516e0.md): Define o limiar de recarga (`threshold`), o plano (`plan_quantity`), o cartão (`card_id`) e o alerta de saldo (`alert_enabled` + `alert_threshold`). Para LIGAR a recarga é obrigatório `card_id` + `plan_quantity`. - Raiz > Conta [Ler webhook de saída](https://doc.smsgo.com.br/ler-webhook-de-sa%C3%ADda-39041517e0.md): - Raiz > Conta [Definir webhook de saída (DLR + cliques)](https://doc.smsgo.com.br/definir-webhook-de-sa%C3%ADda-dlr-cliques-39041518e0.md): Define a URL que receberá os eventos `sms.status` e `link.click`. Gera um segredo de assinatura na 1ª vez; use `rotate_secret` para girar. URL vazia desativa o webhook. - Raiz > Faturamento [Pacotes de recarga](https://doc.smsgo.com.br/pacotes-de-recarga-39041519e0.md): Lista os pacotes de créditos (tiers) disponíveis para compra, com preço unitário por faixa. - Raiz > Faturamento [Cartões salvos](https://doc.smsgo.com.br/cart%C3%B5es-salvos-39041520e0.md): Lista os cartões de crédito salvos da conta (apenas os 4 últimos dígitos). - Raiz > Faturamento [Histórico de faturas](https://doc.smsgo.com.br/hist%C3%B3rico-de-faturas-39041521e0.md): - Raiz > Faturamento [Comprar créditos (cartão salvo)](https://doc.smsgo.com.br/comprar-cr%C3%A9ditos-cart%C3%A3o-salvo-39041522e0.md): Compra créditos cobrando um cartão salvo **sem o cliente presente** (off-session). Informe `quantity` (entre 250 e 1.000.000) ou `plan_id` (uuid de um pacote de `GET /v1/billing/plans`). Se `card_id` for omitido, usa o cartão padrão. `status=succeeded` já credita o saldo; `processing` confirma de forma assíncrona. - Raiz > Links curtos [Listar links curtos](https://doc.smsgo.com.br/listar-links-curtos-45509947e0.md): - Raiz > Links curtos [Criar link curto](https://doc.smsgo.com.br/criar-link-curto-45509948e0.md): O `slug` é sempre gerado pela SMSGo (7 caracteres); um `slug` enviado no corpo é ignorado. Use o `short_url` da resposta. Exige a assinatura do módulo de links curtos. Sujeito a rate-limit (429). - Raiz > Links curtos [Detalhar link curto](https://doc.smsgo.com.br/detalhar-link-curto-45509949e0.md): - Raiz > Links curtos [Desativar link curto](https://doc.smsgo.com.br/desativar-link-curto-45509950e0.md): Desativa o link (`status: disabled`) preservando os cliques. Link de outra empresa responde 404. Sujeito a rate-limit (429). - Raiz > Links curtos [Listar cliques de um link](https://doc.smsgo.com.br/listar-cliques-de-um-link-45509951e0.md): ## Schemas - [SendResult](https://doc.smsgo.com.br/sendresult-16120596d0.md): - [PurchaseResult](https://doc.smsgo.com.br/purchaseresult-16120597d0.md): - [PaginationMeta](https://doc.smsgo.com.br/paginationmeta-16120598d0.md): - [SendListItem](https://doc.smsgo.com.br/sendlistitem-16120599d0.md): - [SendDetail](https://doc.smsgo.com.br/senddetail-16120600d0.md): - [SendSummary](https://doc.smsgo.com.br/sendsummary-16120601d0.md): - [SendNumberDetail](https://doc.smsgo.com.br/sendnumberdetail-16120602d0.md): - [SendNumberItem](https://doc.smsgo.com.br/sendnumberitem-16120603d0.md): - [ContactInput](https://doc.smsgo.com.br/contactinput-16120604d0.md): - [ListInput](https://doc.smsgo.com.br/listinput-16120605d0.md): - [ListResult](https://doc.smsgo.com.br/listresult-16120606d0.md): - [Balance](https://doc.smsgo.com.br/balance-16120607d0.md): - [SmsTypeItem](https://doc.smsgo.com.br/smstypeitem-16120608d0.md): - [Plan](https://doc.smsgo.com.br/plan-16120609d0.md): - [Card](https://doc.smsgo.com.br/card-16120610d0.md): - [InvoiceItem](https://doc.smsgo.com.br/invoiceitem-16120611d0.md): - [AutoRechargeConfig](https://doc.smsgo.com.br/autorechargeconfig-16120612d0.md): - [WebhookConfig](https://doc.smsgo.com.br/webhookconfig-16120613d0.md): - [WebhookStatusEvent](https://doc.smsgo.com.br/webhookstatusevent-16120614d0.md): - [WebhookReplyEvent](https://doc.smsgo.com.br/webhookreplyevent-16120615d0.md): - [ShortLink](https://doc.smsgo.com.br/shortlink-18333985d0.md): - [ShortLinkClick](https://doc.smsgo.com.br/shortlinkclick-18333986d0.md): - [WebhookLinkClickEvent](https://doc.smsgo.com.br/webhooklinkclickevent-18333987d0.md): - [Error](https://doc.smsgo.com.br/error-16120616d0.md):