> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Escopos da API Key

> Permissões do canal SMS: enviar, ler histórico e cancelar agendamento.

<Tip>
  A **API Key** é o cartão de acesso: cada **escopo** abre uma porta. Em produção, libere só o que sua integração precisa.
</Tip>

## Em poucas palavras

* Escopos `sms:*` cobrem envio, leitura e cancelamento.
* SMS **não usa instância**, não há `instanceIds` no canal.
* Guia geral: [Chaves de API](/guides/api-key/index). Primeiro envio: [Quick Start](/sms-api/como-funciona/quick-start).

***

## Como enviar a chave

```http theme={null}
Authorization: Bearer sk_live_xxxxx
```

Alternativa: `x-api-key: sk_live_xxxxx`.

<Warning>
  Escopos **vazios** na criação = acesso **ADMIN** (tudo). Em produção, restrinja sempre.
</Warning>

***

## Combinações prontas

<CardGroup cols={2}>
  <Card title="Só enviar" icon="paper-plane">
    `sms:send`
  </Card>

  <Card title="Enviar e consultar" icon="magnifying-glass">
    `sms:send`, `sms:read`
  </Card>

  <Card title="Com agendamento" icon="clock">
    `sms:send`, `sms:cancel`
  </Card>

  <Card title="Fluxo completo" icon="list-check">
    `sms:send`, `sms:read`, `sms:cancel`
  </Card>
</CardGroup>

***

## Escopos disponíveis

<AccordionGroup>
  <Accordion title="sms:send">
    Enviar SMS imediato ou agendado (`POST /v1/sms/messages`).
  </Accordion>

  <Accordion title="sms:read">
    Listar enviados, consultar por id e SMS recebidos (MO).
  </Accordion>

  <Accordion title="sms:cancel">
    Cancelar agendado (`SCHEDULED`), créditos devolvidos.
  </Accordion>
</AccordionGroup>

***

## Erros comuns

| HTTP / `code`                   | O que fazer                            |
| ------------------------------- | -------------------------------------- |
| **401** `UNAUTHORIZED`          | Confira `Authorization: Bearer sk_...` |
| **403** escopo ausente          | Inclua o escopo da rota na chave       |
| **403** `PLAN_LIMIT_CREDITS`    | Sem créditos para enviar               |
| **403** `PLAN_LIMIT_SCHEDULING` | Agendamento fora do plano              |

Catálogo completo: [Respostas de erro](/guides/conceitos/resposta-de-erros) (accordion **SMS**).

***

## Próximos passos

* [Quick Start](/sms-api/como-funciona/quick-start)
* [Eventos dos webhooks](/sms-api/como-funciona/eventos-do-webhooks)
* [Introdução](/sms-api/como-funciona/introducao)