Carteirização via API

O funcionamento da carteirização via API é similar ao da plataforma, com uma particularidade importante: ao criar um atendimento, o comportamento depende dos campos informados na requisição — e não apenas da carteira atribuída ao contato.

Atenção

Carteirização prevalece sobre a distribuição automática: quando a equipe possui distribuição de atendimentos configurada, ela é ignorada para contatos já carteirizados — desde que apenas a equipe seja informada na requisição. Se um atendente diferente do responsável pela carteira for informado, o sistema ignora a carteirização e direciona o atendimento para o atendente informado.

Como funciona na prática

Ao criar um atendimento via API utilizando os endpoints Mensagens > Enviar ou Mensagens > Enviar Síncrono, o comportamento da carteirização depende dos campos informados na requisição.

Contato já carteirizado

Quando o contato possui uma carteira atribuída e o atendimento é criado para a mesma equipe vinculada à carteira, o direcionamento varia conforme os campos informados:

Atenção

Se a equipe informada na requisição for diferente da vinculada à carteira, a carteirização é ignorada e o atendimento segue o fluxo normal daquela equipe.

Contato sem carteira ou com carteira de outra equipe

Quando o contato ainda não possui carteira ou a carteira está vinculada a uma equipe diferente da informada na requisição, a carteirização não se aplica e o direcionamento segue as configurações da equipe:

• Com distribuição de atendimentos ativada: o atendimento é direcionado automaticamente para um dos atendentes disponíveis da equipe. Nesse caso, o status de disponibilidade do usuário é considerado. Caso o transbordo esteja ativado e o atendente não assuma dentro do prazo definido, o atendimento é repassado para o próximo atendente disponível.
• Sem distribuição de atendimentos: o atendimento fica disponível na fila de Novos para todos os membros da equipe, aguardando que um atendente o assuma.

Carteirização automática

Quando um atendente assume o atendimento criado via API, a plataforma verifica se a carteirização automática está ativada na carteira:

• Com carteirização automática ativada: o contato é adicionado automaticamente à carteira do atendente que assumiu o atendimento. Um contato pode ter várias carteiras, desde que sejam de equipes diferentes.
• Sem carteirização automática: o contato não é carteirizado automaticamente — o usuário deve realizar a atribuição manualmente nos dados do contato.

Gerenciamento de contatos em carteiras via API

É possível adicionar e remover contatos de carteiras utilizando o endpoint Carteiras. Acesse o endpoint desejado e informe os parâmetros necessários:

Adicionar contato

• ID da carteira
• ID do contato ou telefone do contato

Remover contato

• ID da carteira
• ID do contato ou telefone do contato

Atenção

As mesmas regras da plataforma se aplicam via API. Não é possível adicionar um contato a duas carteiras vinculadas à mesma equipe.