Skip to main content
Cada escopo é uma porta na sua chave: enviar, consultar ou cancelar, abra só o necessário.
Cada escopo libera um tipo de operação no RCS. Use só o que sua integração precisa.

Como enviar a chave

Recomendado
Alternativo
A API Key pertence a um workspace. Você não acessa outro workspace com a mesma chave.

Combinações comuns

Só enviar

rcs:send

Enviar e consultar

rcs:send, rcs:read

Com agendamento

rcs:send, rcs:cancel

Fluxo completo

rcs:send, rcs:read, rcs:cancel
Lista de escopos vazia na criação = acesso ADMIN. Em produção, restrinja sempre.

Escopos disponíveis

Enviar RCS imediato ou agendado para 1 a 100 números por requisição. Tipos: BASIC, CARD, CAROUSEL, FILE.
Consultar status e dados de um envio pelo id.
Cancelar mensagem na fila ou agendada. Só com status QUEUED ou SCHEDULED. Créditos são devolvidos quando aplicável.

Erros comuns

Confira Authorization: Bearer sk_... e se a chave não foi apagada no painel.
Workspace suspenso ou expirado. Regularize o plano no painel.
Verifique escopo da operação. Em envio, confira créditos (60 por mensagem, PLAN_LIMIT_CREDITS) e se agendamento está no plano (PLAN_LIMIT_SCHEDULING).
Só cancela com status QUEUED ou SCHEDULED. Depois de enviado, não há cancelamento.

Próximos passos