Conceitos
Os objetos do Zaplin e como eles se ligam.
Workspace
O workspace é a empresa no Zaplin: membros, equipes, números de WhatsApp, cobrança, fuso horário e horário de atendimento. Toda chave de API e todo token OAuth valem para um workspace, e nada atravessa de um workspace para outro.
Papéis
| Papel | O que pode |
|---|---|
| Owner | Tudo, inclusive cobrança |
| Admin | Tudo, menos cobrança |
| Manager | Contatos, conversas, grupos, pipelines, lembretes e campanhas; rascunhos de automação; equipes |
| Agent | Atender conversas, editar contatos, mover negócios, lembretes e rascunhos de campanha |
| Viewer | Só leitura |
Além do papel, cada membro tem um alcance: todo o workspace, as equipes dele ou só o que é atribuído a ele. O alcance limita números, conversas, grupos, lembretes e campanhas. Só Owner e Admin criam chaves de API, apps OAuth e webhooks.
Números
Um número de WhatsApp conectado ao workspace por QR code. O status é provisioning, awaiting_pairing, connected, degraded, disconnected, suspended ou error. Pela API você lê os números e muda o nome, as equipes, a equipe padrão, a etapa e o horário, mas nunca a conexão.
Contatos
Uma pessoa, com nome, telefone em E.164 (no máximo um contato por telefone no workspace), e-mail, responsável, tags e campos personalizados (texto, número, data, seleção, sim/não, link ou rede social).
Um contato descadastrado (opted_out) pediu para não receber mais mensagens em massa: campanhas e automações o deixam de fora.
Conversas
Uma conversa por contato (ou grupo) e número. Ela está open ou closed, pertence a uma equipe e pode ter um responsável. Uma mensagem nova reabre a conversa. Notas internas ficam na conversa, visíveis só para a equipe.
Pipelines
Um pipeline tem etapas (abertas, ganho ou perda) e itens, os negócios. Cada item tem um contato, título, responsável, valor e o histórico das etapas. Um contato tem no máximo um item aberto por pipeline.
Campanhas
Um disparo de uma mensagem para um segmento, uma lista de contatos ou grupos, a partir de um número. Status: draft, scheduled, sending, paused, done ou cancelled. O pace é quantas mensagens por minuto: 5, 10, 15 ou 20. Criar uma campanha nunca envia: enviar é outra chamada, com o escopo campaigns:send.
Automações
Um fluxo que começa por um gatilho (mensagem recebida, contato criado, etapa alterada, webhook recebido, agendamento, formulário enviado e outros) e segue por ações. Status: draft, active ou inactive. Ativar publica o rascunho como uma nova versão. Veja automações para desenvolvedores.
Lembretes
Mensagens de WhatsApp agendadas para um contato, grupo, segmento, telefone ou aniversário, uma vez ou repetindo (diário, dias úteis, semanal, mensal ou anual), no fuso do workspace.
Formulários
Páginas públicas que criam ou atualizam um contato, podem pôr uma tag e iniciar uma automação. Têm rascunho e versão publicada.
Segmentos e listas
Uma lista é um conjunto fixo de contatos. Um segmento é definido por regras (tag, atividade, etapa, campo, data, pipeline, descadastro) e muda sozinho. Campanhas e lembretes podem mirar em qualquer um dos dois.