Skip to main content
A API Key é o cartão de acesso: cada escopo abre uma porta. Em produção, libere só o que sua integração precisa.

​
Em poucas palavras

  • Escopos telegram:* cobrem instâncias, envio, leitura e edição.
  • O campo instanceIds restringe quais conexões a chave pode usar.
  • Guia geral: Chaves de API. Conexão: Quick Start.

​
Como enviar a chave

Alternativa: x-api-key: sk_live_xxxxx.
Escopos vazios na criação = acesso ADMIN (tudo). Em produção, restrinja sempre.

​
Combinações prontas

Bot básico

telegram:instances:create, telegram:instances:list, telegram:send

Enviar e consultar

telegram:send, telegram:read

Com cancelamento

telegram:send, telegram:cancel

Fluxo completo

telegram:send, telegram:read, telegram:cancel, telegram:update, telegram:delete

​
Escopos disponíveis

Listar conexões, ver detalhes e QR (modo USER).
Criar bot com token ou iniciar conta USER (login por QR ou sessão).
Remover conexão.
Enviar texto, mídia por URL HTTPS e localização (modo bot).
Histórico de enviadas, lista de chats e inbound.
Cancelar na fila ou agendada.
Editar texto enviado.
Apagar mensagem no chat.

​
Limitar por conexão (instanceIds)

Além do escopo (o que), instanceIds define onde:

​
Erros comuns

Catálogo completo: Respostas de erro.

​
Próximos passos