Skip to main content
Cada escopo é uma porta na sua chave: enviar, consultar, cancelar ou gerenciar agentes — 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 de mensagens

rcs:send, rcs:read, rcs:cancel

Gerenciar agentes

rcs:instances:list, rcs:instances:create, rcs:instances:delete

Integração completa

Todos os escopos RCS acima
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 500 números por requisição. Tipos: BASIC, CARD, CAROUSEL, FILE, template. Use from (id ou nome da instância) para agente branded.Endpoint: POST /v1/rcs/messages
Listar e consultar envios RCS, e listar/detalhar mensagens recebidas (inbound).Endpoints: GET /v1/rcs/messages, GET /v1/rcs/messages/:id, GET /v1/rcs/inbound, GET /v1/rcs/inbound/:id
Cancelar mensagem na fila ou agendada. Só com status QUEUED ou SCHEDULED. Créditos são devolvidos quando aplicável.Endpoint: POST /v1/rcs/messages/:id/cancel
Listar instâncias RCS do workspace e consultar detalhe de um agente.Endpoints: GET /v1/rcs/instances, GET /v1/rcs/instances/:instanceId
Criar instância, atualizar perfil do agente e submeter para provisionamento.Endpoints: POST /v1/rcs/instances, PATCH /v1/rcs/instances/:instanceId, POST /v1/rcs/instances/:instanceId/submit
Remover instância RCS do workspace.Endpoint: DELETE /v1/rcs/instances/:instanceId

​
Restrição por instância

Se a API Key tiver instanceIds preenchido, ela só acessa e envia pelas instâncias listadas. Lista vazia = acesso a todas.

​
Erros comuns

Confira Authorization: Bearer sk_... e se a chave não foi apagada no painel.
Créditos insuficientes (INSUFFICIENT_CREDITS) ou plano expirado (WORKSPACE_BLOCKED).
Verifique escopo da operação. Agendamento depende do plano (PLAN_LIMIT_SCHEDULING). Instância não permitida pela chave retorna FORBIDDEN.
Limite de instâncias do plano atingido ao criar agente.
Só cancela com status QUEUED ou SCHEDULED. Depois de enviado, não há cancelamento.
Tentativa de envio com from apontando para agente ainda não aprovado.

​
Próximos passos