Distribuição via API
Configure a distribuição pela API e entenda como o direcionamento muda ao criar um atendimento.
A API permite duas coisas: configurar a distribuição e o transbordo de uma equipe, sem passar pela tela de Ajustes, e criar atendimentos que respeitam ou ignoram essa distribuição, conforme os campos enviados.
Pré-requisitos:
Aplicativo de distribuição de atendimentos habilitado. Saiba como habilitar.
Acesso à API da plataforma.
Configurar a distribuição e o transbordo
A configuração é feita pelos endpoints Equipes → Criar, ao criar uma nova equipe, ou Equipes → Atualizar, para uma equipe já existente.
distributionIsEnabled
Chave Distribuição de atendimentos
distributionConfig.expirationIsEnabled
Chave Transbordo na distribuição
distributionConfig.inactivityTimeInMinutes
Campo Limite de tempo para realizar transbordo
distributionConfig.maximumDurationInMinutes
Campo Tempo limite máximo
distributionConfig é um objeto enviado junto ao corpo da requisição, contendo os três campos relacionados ao transbordo.
Para configurar:
Acesse o endpoint Equipes → Criar, para configurar já na criação da equipe, ou Equipes → Atualizar, para uma equipe existente.
Se estiver atualizando, informe o ID da equipe que deseja configurar.
No corpo da requisição, envie distributionIsEnabled para habilitar ou desabilitar a distribuição.
Se quiser configurar o transbordo, envie o objeto distributionConfig com expirationIsEnabled habilitado e os tempos definidos em inactivityTimeInMinutes e maximumDurationInMinutes.
O resultado é o mesmo de configurar pela tela: a chave fica sincronizada entre API e plataforma, então alterar por um canal reflete no outro.
Atenção: assim como pela tela, inactivityTimeInMinutes não pode ser igual a maximumDurationInMinutes. Se os dois valores forem iguais, o transbordo não ocorre.
Direcionar um atendimento ao criar
Ao criar um atendimento pelos endpoints Mensagens → Enviar ou Mensagens → Enviar Síncrono, o direcionamento varia conforme os campos informados na requisição:
Apenas a equipe
O atendimento segue a distribuição normalmente, considerando ordem, disponibilidade e transbordo
Equipe + usuário específico
A distribuição é ignorada e o atendimento é direcionado diretamente para o usuário informado
Exemplo 1: uma requisição informa apenas o ID da Equipe Comercial. O atendimento entra na fila de distribuição normalmente e é direcionado ao próximo usuário disponível, na ordem configurada.
Exemplo 2: uma requisição informa o ID da Equipe Comercial junto com o ID do usuário B. O atendimento vai direto para o usuário B, independentemente de qual seria o próximo da ordem de distribuição ou se B está marcado como disponível.
Informar um usuário específico ignora tanto a ordem de distribuição quanto o status de disponibilidade dele. O atendimento é direcionado mesmo que esse usuário esteja marcado como Indisponível.
Se a equipe também tiver Carteirização de Contatos habilitada, ela pode alterar esse comportamento. Consulte Funcionamento da Carteirização para entender como as duas funcionalidades se combinam.
Artigos relacionados
Atualizado
Isto foi útil?