> For the complete documentation index, see [llms.txt](https://docs.smsfunnel.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.smsfunnel.com.br/api/parceiros.md).

# Parceiros

Saiba como acessar e interagir com nossa API de Parceiros

A API de Parceiros permite integrar a SMS Funnel ao seu sistema: enviar SMS e ligações, montar campanhas automatizadas, gerenciar listas e leads, acompanhar o resultado de cada envio e consultar o saldo e as métricas da sua conta — ou, para agências, das contas que você gerencia.

{% hint style="success" %}
**A URL de base de todos os endpoints é**: <https://web.smsfunnel.com.br/api/parceiros/v1>
{% endhint %}

#### Por onde começar

1. **Autenticação** — gere a sua Chave de API.
2. **Quickstart** — faça o seu primeiro envio de SMS em poucos minutos.
3. **Saldo e Carteira** — entenda como o seu saldo é informado e consumido.

#### O que você encontra nesta seção

| Página                                    | Para quê                                                                             |
| ----------------------------------------- | ------------------------------------------------------------------------------------ |
| Requisições                               | Consultas da conta (`/me`, saldo, recargas, mensagens enviadas, cliques) e blacklist |
| Saldo e Carteira                          | Formato do saldo, cobrança pela Carteira e o que acontece quando o saldo acaba       |
| Listas                                    | Criar listas e inserir leads                                                         |
| Campanhas e Sequências                    | Fluxos automatizados de SMS e de voz disparados quando o lead entra na lista         |
| Envios de uma Sequência                   | Resultado de cada SMS enviado por uma sequência                                      |
| Broadcasts                                | Envio de SMS em massa e acompanhamento de cada mensagem                              |
| Ligações - Áudios e Ligações - Broadcasts | Áudios, disparos de ligações em massa e métricas de ligações                         |
| Agências                                  | Operar as contas filhas com a sua própria Chave de API                               |
| Webhook de status                         | Receber na sua URL o status de cada SMS                                              |
| Guia de Migração Call4U → SMS Funnel      | Equivalência dos endpoints antigos do Call4U                                         |
| Referência                                | Formato de erros e limites de requisição                                             |

{% hint style="info" %}
A API de Parceiros precisa estar habilitada na sua conta. Caso ainda não esteja, entre em contato com nosso suporte.
{% endhint %}
