Webhooks

Webhooks #

Os webhooks pós-chamada fornecem informações sobre cada chamada concluída no sistema. Essas informações podem ser usadas para atualizar sistemas externos ou iniciar automações de fluxo de trabalho, usando produtos como Aplicativos Lógicos do Azure ou Zapier.

Exemplos de casos de uso:

  • Adicionar um evento de histórico de chamadas em relação a um CRM registro
  • Adicione detalhes de reprodução de gravação de chamadas a um CRM registro
  • Recorde de vendas bem-sucedidas em CRM
  • Rastreie reclamações de clientes em um sistema externo
Information Circle info
Vários Webhooks podem ser configurados (dependendo da licença) para fornecer informações pós-chamada para diferentes sistemas externos, conforme necessário.

Configurando um Webhook #

Condições de filtro #

Por padrão, um webhook será acionado para todas as sessões de chamada, a menos que um filtro seja aplicado. Filtros podem ser adicionados para a maioria das propriedades de chamada para permitir que o webhook seja restrito a disparar apenas em chamadas 'Externas', por exemplo, ou chamadas que correspondam a um número 'DID' específico.

Adicione opções de filtro conforme necessário. Quando vários campos de filtro são adicionados, eles são combinados usando um ' E' operador.

Information Circle info
Para obter mais informações sobre filtragem, consulte aqui

Ação #

Parâmetro Opções Descrição
URL https:// Forneça um HTTPS URL que o gatilho chamará quando disparado.
Método de solicitação GET, POST, PUT Escolha o método de solicitação necessário para o webhook.
Formato da solicitação JSON, dados do formulário Escolha o formato de solicitação necessário para o webhook se POST ou PUT são selecionados como o método Request.
Dados adicionais de carga útil Par chave/valor Se necessário, informações estáticas adicionais podem ser adicionadas à carga útil do webhook. Insira quaisquer dados adicionais como pares chave/valor, conforme necessário.
Tentativas de repetição 0 - 10 Padrão 1. Insira o número de vezes que o webhook deve tentar novamente se a qualquer momento houver um erro de
Hand Left warning
A configuração do gatilho do webhook é armazenada em cache para melhorar o desempenho. Quaisquer novos gatilhos ou alterações nos gatilhos existentes podem levar até 10 minutos para entrar em vigor.
Information Circle info
O tempo limite para uma solicitação de webhook é de 10 segundos. O tempo entre as tentativas de repetição é igual ao Número da tentativa x 2 segundos

Dados de carga útil

A tabela abaixo mostra os dados fornecidos na carga útil do gatilho.

Parâmetro Descrição
ID de gatilho O ID exclusivo do gatilho para o qual a solicitação de web hook está sendo disparada.
id A ID da entidade que está sendo alterada (ID do usuário ou ID do locatário).
ID do inquilino A ID do locatário do cliente à qual o evento está associado.
Cdr A carga útil de dados de chamada
Dados personalizados Se configurado em relação ao gatilho, qualquer informação adicional do par chave/valor de carga útil será passada aqui.

CDR Dados

Parâmetro Descrição
id O id da sessão para o CDR registro.
dType CDR tipo de registro - "CloudSessionCdr"
sVer CDR versão - 1
pbxId ~.Dimensions.~ ID para a plataforma de comunicações o CDR é de (por exemplo, ~.pbx.kazoo.name.~)
pbxName O nome configurado da plataforma de comunicações
tz Identificador TZ para os tempos de chamada.
começar Hora de início da sessão de chamada.
responder Hora em que as chamadas foram atendidas pela primeira vez.
fim Hora de término da sessão de chamada.
Dur Duração da chamada em segundos.
anel Tempo de toque da chamada em segundos.
falar Tempo de conversação da chamada em segundos.
segurar Tempo de espera da chamada em segundos.
parque Tempo de estacionamento da chamada em segundos.
perdido Indicação se a chamada foi abandonada - 1/0
lostinPark Indicação se a chamada foi abandonada enquanto estacionada - 1/0
aban Indicação se a chamada foi uma chamada de toque curto ou não - 1/0
Ans Indicação se a chamada foi ans - 1/0
curto Indicação se a chamada foi chamada como tendo uma duração curta - 1/0
causa Limpe a causa da chamada.
Dir Direção da chamada. 0 - Desconhecido, 1 - Interno, 2 - Entrada, 3 - Saída, 4 - Ambos
tipo Tipo de chamada. 0 - Desconhecido, 1 - Interno, 2 - Externo
t2t Indicação se a chamada foi uma chamada tronco a tronco - 1/0
cliNum Número de ID do chamador (CLI) em E.164 formato.
cliName Nome do chamador
cliLoc Localização da CLI
cliArea Código de área da CLI
cliEstado Estado da CLI (somente EUA)
clichê País da CLI
ddiNum Número DID em E.164 formato.
ddiName Nome do DID
fRngDevNum Primeiro tocou o número do dispositivo.
Nome do Desenvolvedor fRng Primeiro tocou o nome do dispositivo.
lRngDevNum Número do dispositivo que tocou pela última vez.
lRngDevName Nome do dispositivo tocado pela última vez.
ansDevNum Número do dispositivo de atendimento.
ansDevName Nome da secretária eletrônica.
lAnsDevNum Número do último atendedor de chamadas.
lAnsDevName Nome do último dispositivo de atendimento.
fRngUsrNum Primeiro ligou para o número do usuário.
Nome do fRngUsr Primeiro tocou o nome de usuário.
lRngUsrNum Número de usuário do último toque.
lRngUsrName Nome de usuário do último toque.
respostasUsrNum Número de usuário de resposta.
ansUsrName Nome de usuário de resposta.
lAnsUsrNum Número do último usuário que atendeu.
lAnsUsrName Nome de usuário que respondeu pela última vez.
fRngAgtNum Número do agente que ligou pela primeira vez.
Nome do fRngAgt Nome do agente ligado pela primeira vez.
lRngAgtNum Número do último agente ligado.
lRngAgtName Nome do agente ligado pela última vez.
respostasAgtNum Número do atendente de chamadas.
ansAgtName Nome do agente de atendimento.
lAnsAgtNum Número do último atendente.
lAnsAgtName Nome do último atendente.
rteID Número do prefixo. Qualquer número adicionado à CLI como prefixo durante o roteamento pela plataforma de comunicações.
rteName Nome do prefixo. Qualquer string adicionada ao Nome do Chamador como prefixo durante o roteamento pela plataforma de comunicações.
Nome do Grupo fRng Primeiro ligou para o nome do grupo.
lRngGroupName Nome do grupo que tocou pela última vez.
ansGroupName Nome do grupo de resposta.
hasRec Indicação se a chamada foi gravada - 1/0
taxa Indicação se a chamada foi classificada - 1/0
rateCost O custo da taxa (o dobro).
rateBand O nome da banda para a taxa.
nome_da_taxa O nome da taxa aplicada.
Ids de gravação Matriz de cadeia de caracteres de IDs para todas as gravações associadas a essa sessão de chamada.
partidas de diretório Item do diretório de contatos Matriz de todos os contatos correspondentes à chamada.
Tags Matriz que contém um par chave/valor de todas as tags aplicadas à chamada.

CDR Item do diretório de contatos

Chave Descrição Tipo
título Título de contato (Sr., Sra., Dr. etc.) corda
nome completo Nome completo do contato. Isso é usado em relatórios e ~.UcClient.~ clientes para ajudar os usuários a identificar os chamadores. corda
nomeDaempresa O nome da empresa para a qual o contato trabalha. corda
jobTitle A posição de contato com a empresa. corda
telefone1 para telefone4 Um endereço de email de contato para o contato. E.164
Email Até 4 campos diferentes de número de telefone de contato corda
crmId Um ID exclusivo para o registro de contato de um CRM sistema corda
campo1 ao campo 10 10 campos para transportar quaisquer dados personalizados para o registro de contato corda
Color Wand tip
O triggerId pode ser encontrado editando um gatilho configurado no Portal do Cliente e copiando o GUID do final do URL. por exemplo, https://myreports.com/en-GB/webhooks/00000000-0000-0000-0000-000000000000

Exemplo JSON carga útil

Exemplo JSON formato de carga útil para PUT/POST Solicitações:

{
    "triggerId": "00000000-0000-0000-0000-0000000000000000",
    "id": "00000000-0000-0000-0000-000000000000000",
    "tenantId": "00000000-0000-0000-0000-0000000000000000",
    "cdr": {
        "id": "00000000-0000-0000-0000-000000000000000",
        "dType": "CloudSessionCdr",
        "sVer": 1,
        "pbxId": "00000000-0000-0000-0000-00000000000000",
        "pbxName": "BenDV1 - Dev - Ben",
        "tz": "Europa/Londres",
        "início": "2024-05-29T09:37:35+01:00",
        "fim": "2024-05-29T09:37:45+01:00",
        "dur": 10,
        "anel": 10,
        "perdido": 1,
        "causa": "NORMAL_ LIMPEZA",
        "dir": 2,
        "tipo": 2,
        "cliNum": "\\u002B447000000000",
        "cliLoc": "Reino Unido",
        "cliCtry": "GB",
        "ddiNum": "\\u002B441610000000",
        "fRngDevNum": "usuário_ **\*\***",
        "fRngDevName": "(T42S) Usuário de Teste",
        "lRngDevNum": "user\_**\*\***",
        "lRgDevName": "Usuário de teste (T42S)",
        "fRngUsrNum": "302",
        "fRngUsrName": "Usuário de teste",
        "lRngUsrNum": "302",
        "lRngUsrName": "Usuário de teste",
        "fRngAgtNum": "302",
        "fRngAgtName": "Usuário de teste",
        "lRngAgtNum": "302",
        "lRngAgtName": "Usuário de teste",
        "temRec": 1,
        "recordingIds": [" 00000000-0000-0000-0000-00000000000000000000"]["00000000-0000-0000-0000-000000000000"],
        "directoryMatches": [ {
            "dirName": "Meu Global",
            "dirId": "00000000-0000-0000-0000-000000000000000",
            "dirType": "DirectoryContactMatch",
            "contactId": "00000000-0000-0000-0000-000000000000000",
            "campos": {
            "fullName": "Exemplo de contato",
            "nomedaempresa": "Empresa",
            "jobTitle": "Cargo",
            "email": "Endereço de e-mail",
            "campo1": "campo1",
            "campo2": "campo2",
            "campo3": "campo3",
            "campo4": "campo4",
            "campo5": "campo5",
            "campo6": "campo6",
            "campo7": "campo7",
            "campo8": "campo8",
            "campo9": "campo9",
            "campo10": "301"
            }][{
            "dirName": "My Global",
            "dirId": "00000000-0000-0000-0000-000000000000",
            "dirType": "DirectoryContactMatch",
            "contactId": "00000000-0000-0000-0000-000000000000",
            "fields": {
            "fullName": "Example Contact",
            "companyName": "Company",
            "jobTitle": "Job Title",
            "email": "Email Address",
            "field1": "field1",
            "field2": "field2",
            "field3": "field3",
            "field4": "field4",
            "field5": "field5",
            "field6": "field6",
            "field7": "field7",
            "field8": "field8",
            "field9": "field9",
            "field10": "301"
            }],
        "tags": {
            "Suporte": "passo 1"
        }
    },
    "Dados personalizados": {
        "gancho": "pós-chamada"
    }
}