Skip to main content
Você pode enviar a chave de duas formas (escolha a que seu framework preferir): Opção A (Padrão Recomendado): 
Authorization: Bearer sk_live_sua_chave_aqui
Opção B (Header Customizado): 
x-api-key: sk_live_sua_chave_aqui
A API Key está sempre vinculada a um único Workspace. Todas as operações de SMS (enviar, consultar status, cancelar) ocorrem dentro desse contexto. Você não consegue acessar dados de outro workspace com a mesma chave.

​
Tabela de Escopos (Permissões)

Ao criar uma API Key, você define o que ela pode fazer. Se você deixar a lista de escopos vazia, a chave terá acesso ADMIN (todas as operações permitidas). Para segurança, recomendamos restringir.

​
Escopos por envio e consulta

  • sms:send Enviar SMS (imediato ou agendado).
  • sms:read Listar SMS enviados (GET /v1/sms/messages), consultar status por ID (GET /v1/sms/messages/{id}), listar SMS recebidos/MO (GET /v1/sms/inbound) e obter um MO por ID (GET /v1/sms/inbound/{id}).
  • sms:cancel Cancelar um SMS agendado (status SCHEDULED). Os créditos são devolvidos ao workspace.

​
Respostas de Erro de Autenticação

Se algo der errado com sua chave, a API retorna códigos HTTP claros para facilitar o debug:
Verifique se o header está correto e se a chave não foi apagada no painel.
Verifique se a chave tem o Escopo necessário para a rota. Para envio, verifique também se não excedeu créditos ou limite do plano (code: PLAN_LIMIT_CREDITS). Agendamento pode não estar permitido no plano (PLAN_LIMIT_SCHEDULING).