A API de Atendimento comercial foi desenvolvida para integrar leads ao Zenvia Customer Cloud de forma assíncrona, permitindo receber um webhook com seus resultados.
Saiba neste artigo como ativar a integração na sua conta e como configurar sua API.
⚠️ Atenção: A integração de uma API demanda conhecimento técnico avançado, portanto, é importante contar com a ajuda de um desenvolvedor.
Como ativar a integração da API de Atendimento comercial
Para ativar a API de Atendimento comercial no Zenvia Customer Cloud, siga estes passos:
1. Acesse Atendimentos > Integrações;
2. Clique no ícone no canto inferior direito;
3. Selecione o item de API Access;
4. Configure as permissões necessárias, como a sua atribuição e os níveis de acesso;
5. Salve o código da API key.
Pronto! Integração ativa.
💡Dica: Você só consegue acessar as rotas da API se informar API key nas chamadas. Esta chave pode sempre ser acessada na sua lista de integrações.
Conceitos das API de Atendimento comercial
Alguns termos são exclusivos do módulo de Atendimento comercial no Zenvia Customer Cloud. Conheça mais sobre cada um:
Lead
Lead é a informação básica de um contato que entrou para sua base de dados. Os leads podem ter diferentes origens, sejam vindos de integrações (Mercado Livre ou PayPal) ou de canais (WhatsApp ou Instagram).
Todo contato de Atendimentos é criado a partir dos dados de um lead. Cada lead está vinculado a um Prospect. O Zenvia Customer Cloud é capaz de identificar e unir leads que compartilham os mesmos dados.
Exemplo:
Lead 1: { phone: +55 51 987654321 }
Lead 2: { phone: +55 51 987654321, email: 'address@provider.com' }
Neste exemplo, Lead 2 possui o mesmo telefone de Lead 1, portanto o software entende que se trata do mesmo contato e agrupa esta informação, tornando este Lead em Prospect.
O link da documentação técnica está disponível em https://sales.zenvia.com/#tag/Leads
Prospect
Prospect é o nome que os contatos que estão disponíveis para interações no módulo de Atendimentos recebem no Zenvia Customer Cloud. Todo Prospect é um cliente em potencial e tem ao menos um Lead como base.
O identificador de um prospect é uma chave de 24 caracteres contendo letras e números, esse identificador é diferente do utilizado pela API de Contatos, onde o padrão é o de UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
O link da documentação técnica está disponível em https://sales.zenvia.com/#tag/Prospects
Agents
Agents é um perfil de usuário do Zenvia Customer Cloud que interage com os Prospects através do módulo de Atendimentos. Consulte o artigo Adicionar e gerenciar usuários da organização para saber mais sobre este assunto.
O link da documentação técnica está disponível em https://sales.zenvia.com/#tag/Agents
Groups
Groups são os grupos que os usuários do Zenvia Customer Cloud fazem parte. Você pode ter mais de um grupo e é possível realizar configurações de atendimentos em seus grupos.
O link da documentação técnica está disponível em https://sales.zenvia.com/#tag/Groups