1. Contas
Documentação técnica das API do Messagefy
  • Introdução
  • Começando
  • Guia de Integração
  • Collections Postman
  • OnBoarding
    • OnBoarding para Organizações
  • Me
    • Introdução
    • Sobre
      GET
  • Contas
    • Introdução
    • Criar conta
      POST
    • Listar contas
      GET
    • Buscar por id
      GET
    • Atualizar conta
      PUT
    • Deletar conta
      DELETE
  • API Key
    • Introdução
    • Criar apikey
      POST
    • Listar ApiKeys
      GET
    • Buscar por ID
      GET
    • Atualizar apikey
      PUT
    • Deletar apiKey
      DELETE
  • Administrando Canais
    • Introdução
    • WebHook
      • Criar canal de Webhook
    • Whatsapp
      • Criar canal de Whatsapp
      • Status do Canal Whatsapp
      • Solicitar QRCode
      • Solicitar Pair Code
      • Solicitar Desconectar o número
    • Outbox
      • Listar Mensagens no Outbox do Canal
      • Obter detalhes da Mensagem no Outbox do Canal
      • Reenviar Múltiplas Mensagens no Outbox do Canal
      • Cancelar Mensagem no Outbox do Canal
    • Listar canais
      GET
    • Buscar por id
      GET
    • Atualizar canal
      PUT
    • Deletar canal
      DELETE
    • Transferir canal
      POST
  • Usando o Canal Whatsapp
    • Introdução
    • Contatos e Grupos
      • Solicitar contatos
      • Solicitar informações do contato
      • Solicitar grupos
      • Solicitar presença de contato (online/offline)
      • Solicitar Chats
      • Solicitar informação do grupo
    • Enviando Mensagens
      • Texto, imagem, audio, video, documentos e sticker
      • Enviar contatos
      • Enviar lista de contato
      • Marcar mensagens como lida
    • Excluindo e Editando Mensagens
      • Apagar mensagem para todos
      • Editar mensagem
    • Recuperar Messagens Antigas
  • Recebendo WebHooks
    • Guia Completo de WebHooks
    • Mensagens Recebidas
      • TEXT
      • CONTACT_MESSAGE
      • CONTACTS_MESSAGE
    • Status do canal
    • QRCode gerado retorno
    • Lista de contatos
    • Lista de grupos
    • Mensagem entregue
    • Mensagem lida
    • Download Disponivel
    • Localização e Localização em tempo real
    • Lista de Histórico
    • Ligação recebida e realizada
    • Lista de contatos do grupo
    • Lista de chats
    • Alteração de Grupo
  • Raiz
  • Esquemas
    • Eventos de WebHook
      • Eventos de Conexão
        • PAIR_CODE_GENERATED_RESPONSE: PairCode de conexão
        • INSTANCE_USER_CONNECT_TIMEOUT: Usuário não realizou Login
        • DISCONNECTED: Celular desconectado
        • CONNECTED: Celular conectado
      • Eventos de Mensagens
        • EchoMessage: Eco de Mensagem enviada
      • Eventos de Status de Mensagens
        • MESSAGE_SENT: Mensagem enviada
        • MESSAGE_DELIVERED: Mensagem entregue
        • MESSAGE_READ: Mensagem lida
    • ContatoWhatsapp
    • ContactResponseInfo
    • AccountResponse
    • Organization
    • ResourcePlanResponse
    • ChannelType
    • ChannelStatus
    • Provider
  1. Contas

Introdução

Bem-vindo à seção de Contas. Esta área é o ponto de partida para a organização da sua estrutura na plataforma Messagefy. Uma "Conta" representa a entidade principal que agrupa seus canais, chaves de API e configurações, funcionando como um contêiner isolado para cada um de seus projetos ou clientes.
Nesta seção, você encontrará todos os endpoints necessários para realizar o ciclo de vida completo de uma conta, incluindo:
Criação: Para iniciar um novo projeto ou cliente.
Listagem: Para visualizar todas as contas sob sua gestão.
Busca: Para recuperar detalhes de uma conta específica por seu ID.
Atualização: Para modificar informações da conta.
Deleção: Para remover contas que não são mais necessárias.
Um gerenciamento de contas eficaz é fundamental para manter seus projetos organizados, seguros e escaláveis. Antes de criar canais ou enviar mensagens, você deve primeiro configurar uma conta.

Para que serve uma Account?#

As Accounts foram projetadas para resolver problemas reais de organização e segurança em empresas que usam múltiplos departamentos ou times:
Segregação de Responsabilidades - Cada departamento tem suas próprias credenciais e não pode acessar recursos de outros departamentos. O time de Vendas não tem acesso aos channels do Suporte, e vice-versa.
Controle de Acesso Granular - Você pode definir permissões específicas por Account através dos scopes das API Keys. Por exemplo, a Account de Marketing pode ter apenas permissão de leitura, enquanto Vendas tem permissão de escrita.
Métricas Independentes - Cada Account possui suas próprias métricas e estatísticas. Você pode acompanhar quantas mensagens cada departamento enviou, qual a taxa de entrega, tempo de resposta, e outros indicadores de forma isolada.
Faturamento Segmentado - Em planos enterprise, é possível ter relatórios de uso e custos separados por Account, facilitando o chargeback interno ou análise de ROI por departamento.
Escalabilidade Organizacional - À medida que sua empresa cresce, você pode criar novas Accounts sem afetar as existentes. Adicionar um novo time ou departamento é simples e não requer reconfiguração dos sistemas já em produção.

Casos de Uso Práticos#

Caso 1: E-commerce com múltiplos departamentos#

Organization: Loja Chat Guru LTDA
│
├── Account: Vendas
│   ├── Channel: WhatsApp (+55 11 98765-0001)
│   └── Webhook: https://api.loja.com/webhooks/vendas
│   └── Uso: Enviar confirmações de pedido, promoções
│
├── Account: Suporte
│   ├── Channel: WhatsApp (+55 11 98765-0002)
│   └── Webhook: https://api.loja.com/webhooks/suporte
│   └── Uso: Atendimento ao cliente, resolução de problemas
│
├── Account: Logística
│   ├── Channel: WhatsApp (+55 11 98765-0003)
│   └── Webhook: https://api.loja.com/webhooks/logistica
│   └── Uso: Notificações de envio, rastreamento
│
└── Account: Marketing
    ├── Channel: WhatsApp (+55 11 98765-0004)
    └── Webhook: https://api.loja.com/webhooks/marketing
    └── Uso: Campanhas, newsletters, remarketing

Caso 2: Software house com múltiplos clientes#

Organization: DevHouse LTDA
│
├── Account: Cliente A - Varejo
│   └── Channel: WhatsApp (número do cliente A)
│   └── API Key com scopes limitados
│
├── Account: Cliente B - Saúde
│   └── Channel: WhatsApp (número do cliente B)
│   └── API Key com scopes limitados
│
└── Account: Interno - Testes
    └── Channel: WhatsApp (número de testes)
    └── API Key com todos os scopes

Caso 3: Empresa com Filiais#

Organization: Rede FastFood
│
├── Account: Filial São Paulo
│   └── Channel: WhatsApp (+55 11 98765-1111)
│
├── Account: Filial Rio de Janeiro
│   └── Channel: WhatsApp (+55 21 98765-2222)
│
└── Account: Filial Belo Horizonte
    └── Channel: WhatsApp (+55 31 98765-3333)

Segurança e Isolamento#

Cada Account é completamente isolada das demais, garantindo:
Isolamento de Credenciais - API Keys de uma Account não podem acessar recursos de outra Account. Se uma chave for comprometida, apenas os recursos daquela Account específica estão em risco.
Isolamento de Dados - Mensagens, estatísticas e logs são separados por Account. O time de Vendas não consegue ver as mensagens enviadas pelo time de Suporte.
Isolamento de Configurações - Webhooks, channels e outras configurações são independentes. Alterar um webhook na Account de Marketing não afeta a Account de Vendas.
Auditoria Granular - Todos os logs e ações são registrados no nível da Account, permitindo rastreabilidade completa de quem fez o quê e quando.
Importante
Boas práticas de segurança: Nunca compartilhe API Keys entre Accounts.
Cada departamento deve ter suas próprias credenciais. Isso facilita a revogação em caso de comprometimento e melhora a auditoria.
Modificado em 2026-01-22 21:53:15
Página anterior
Sobre
Próxima página
Criar conta
Built with