Ganchos de teia

Ganchos de teia #

Os webhooks de 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 CRM recorde
  • Adicionar detalhes de reprodução de gravação de chamadas a um CRM recorde
  • 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 do 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 apenas disparar 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:// Fornecer um HTTPS URL que o gatilho chamará quando acionado.
Método de solicitação GET, POST, PUT Escolha o método de solicitação necessário para o webhook.
Formato do pedido JSON, Dados do formulário Escolha o formato de solicitação necessário para o webhook if POST ou PUT são selecionados como o método Request.
Dados adicionais sobre a 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 em algum momento houver um malsucedido
Hand Left warning
A configuração do gatilho Webhook é armazenada em cache para melhorar o desempenho. Quaisquer novos gatilhos ou alterações em gatilhos existentes podem levar até 10 minutos antes de entrarem 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 do gatilho O id exclusivo para o gatilho para o qual a solicitação de gancho da Web está sendo disparado.
ID A id da entidade que está mudando (ID do usuário ou ID do locatário).
inquilinoId O ID do locatário do cliente ao qual o evento está associado.
CDR A carga útil de dados da chamada
customData Se configurado contra o gatilho, qualquer informação adicional do par chave/valor da carga útil será passada aqui.

CDR Dados

Parâmetro Descrição
ID O ID da sessão para o CDR recorde.
dTipo CDR tipo de registro - "CloudSessionCdr"
Ver 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.
Início Hora de início da sessão de chamada.
resposta Hora em que as chamadas foram atendidas pela primeira vez.
fim Hora de fim 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 Segure o tempo da chamada em segundos.
parque Estacione o tempo da chamada em segundos.
perdeu Indicação de que a chamada foi abandonada - 1/0
lostinPark Indicação de que a chamada foi abandonada enquanto estava estacionada - 1/0
Aban Indicação se a chamada foi ou não uma chamada de toque curto - 1/0
ans Indicação se a chamada foi ans - 1/0
curtas Indicação de que a chamada foi chamada como tendo uma curta duração - 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 de tronco para tronco - 1/0
cliNum Número de identificação do chamador (CLI) em E.164 formato.
cliName Nome do chamador
cliLoc Localização da CLI
cliÁrea Código de área CLI
cliEstado Estado da CLI (somente nos EUA)
cliCtry País CLI
ddiNum Número DID em E.164 formato.
ddiName Nome DID
fRngDevNum Primeiro número do dispositivo tocado.
fRngDevName Primeiro tocou o nome do dispositivo.
lRngDevNum Número do dispositivo tocado pela última vez.
lRngDevName Nome do dispositivo tocado pela última vez.
ansDevNum Número do dispositivo de resposta.
ansDevName Nome do dispositivo de resposta.
lAnsDevNum Número do último dispositivo de resposta.
lAnsDevName Nome do último dispositivo de resposta.
fRngUsrNum Primeiro número de usuário tocado.
fRngUsrName Primeiro tocou o nome de usuário.
lRngUsrNum Número de usuário do último toque.
lRngUsrName Nome de usuário do último toque.
ansUsrNum Número de usuário de resposta.
ansUsrName Nome de usuário respondendo.
lAnsUsrNum Número do usuário da última resposta.
lAnsUsrName Última resposta nome de usuário.
fRngAgtNum Primeiro número do agente de toque.
fRngAgtName Primeiro nome do agente.
lRngAgtNum Número do último agente.
lRngAgtName Nome do último agente.
ansAgtNum Número do atendente.
ansAgtName Nome do agente de resposta.
lAnsAgtNum Número do último agente de resposta.
lAnsAgtName Último nome do agente de resposta.
rteID Número do prefixo. Qualquer número adicionado à CLI como prefixo durante o roteamento através da plataforma de comunicações.
rteName Nome do prefixo. Qualquer string adicionada ao Nome do chamador como prefixo durante o roteamento através da plataforma de comunicações.
fRngGroupName Primeiro tocou o nome do grupo.
lRngGroupName Nome do grupo tocado pela última vez.
ansGroupName Respondendo ao nome do grupo.
hasRec Indicação de que a chamada foi gravada - 1/0
Avaliar Indicação de que a chamada foi classificada - 1/0
taxaCusto O custo da taxa (o dobro).
rateBand O nome da banda para a taxa.
rateName O nome da taxa aplicada.
recordingIds Matriz de cadeia de caracteres de Ids para quaisquer gravações associadas a esta sessão de chamada.
directorymatches Item do diretório de contatos Matriz de todos os contatos correspondentes à chamada.
Etiquetas Matriz que contém um par chave/valor de quaisquer tags aplicadas à chamada.

CDR Item de diretório de contatos

Chave Descrição Tipo
título Título do contacto (Sr., Sra., Dr., etc.) string
Nome completo Nome completo do contacto. Isso é usado em relatórios e ~.UcClient.~ clientes para ajudar os usuários a identificar chamadores. string
Nome da empresa O nome da empresa para a qual o contato trabalha. string
cargoTítulo A posição de contato com a empresa. string
phone1 para phone4 Um endereço de e-mail de contato para o contato. E.164
Email Até 4 campos diferentes de número de telefone de contacto string
crmId Um id exclusivo para o registro de contato de um CRM sistema string
campo1 a campo 10 10 campos para transportar quaisquer dados personalizados para o registo de contacto string
Color Wand tip
O triggerId pode ser encontrado editando um gatilho configurado no Portal do Cliente e copiando o GUID a partir 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 Pedidos:

{
    "triggerId": "00000000-0000-0000-0000-0000000000000",
    "ID": "00000000-0000-0000-0000-00000000000000",
    "tenantId": "00000000-0000-0000-0000-00000000000000",
    "cdr": {
        "ID": "00000000-0000-0000-0000-00000000000000",
        "dType": "CloudSessionCdr",
        "sVer": 1,
        "pbxId": "00000000-0000-0000-0000-0000000000000",
        "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_ COMPENSAÇÃO",
        "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": "(T42S) Usuário de teste",
        "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",
        "hasRec": 1,
        "recordingIds": [" 00000000-0000-0000-0000-000000000000"]["00000000-0000-0000-0000-000000000000"],
        "directoryMatches": [ {
            "dirName": "Meu Global",
            "dirId": "00000000-0000-0000-0000-0000000000000",
            "dirType": "DirectoryContactMatch",
            "contactId": "00000000-0000-0000-0000-0000000000000",
            "campos": {
            "fullName": "Exemplo de contato",
            "CompanyName": "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": "passo1"
        }
    },
    "customData": {
        "gancho": "pós-chamada"
    }
}