- Página inicial
- /
- Artigo
Webhook de registros detalhados de chamadas para Webex Calling no Partner Hub
Você pode configurar um webhook para reunir registros do Webex Calling para todos os seus clientes para fins de reconciliação de cobrança, análise ou relatório.
Visão geral
O webhook de registros detalhados de chamadas permite que você tenha maior visibilidade da atividade do Webex Calling de seus clientes para vários fins, desde a cobrança até os relatórios personalizados. Você pode usar este webhook para reunir registros convenientemente para todos os seus clientes sem ter que consultar registros para cada cliente, um por um. Este webhook permite que você desenvolva aplicativos de relatórios e análises personalizados para ambos os fins comerciais internos ou o fornecimento de serviços de valor agregado aos clientes. Para uma introdução ao webhook e suas APIs que o acompanham, você pode assistir a este vidcast .
O webhook fornece registros a cada 5 minutos. Cada carga de webhook contém registros para chamadas encerradas entre 10 e 5 minutos atrás. Por exemplo, uma carga recebida às 17:00 inclui chamadas que terminaram entre 16:50 e 16:55. As chamadas que terminarem entre 16:55 e 17:00 estarão na carga útil 17:05.
Os registros do Webex Calling são entregues usando o mesmo formato das APIs de registros detalhados existentes . Você pode configurar um webhook e escolher entre dois tipos de feed:
- Análise — Inclui todos os registros de chamadas de todas as organizações de clientes com as quais o parceiro tem uma relação do Webex Calling. Isso inclui organizações para as quais:
- O parceiro gerencia a organização do cliente com uma função de administrador total de parceiros.
- A organização do cliente tem uma assinatura ativa do Webex Calling dentro da organização parceira.
- Cobrança —Inclui apenas registros de chamadas para chamadas feitas por usuários com uma licença do Webex Calling vendida pelo parceiro. Os registros de chamadas para espaços de trabalho estão incluídos neste feed.
Configurar uma URL de retorno de chamada webhook
Configure o webhook no Hub de parceiros. Você só pode configurar um webhook por organização parceira. Você deve ser um administrador completo para configurar um webhook.
1 |
Entrar no Hub de parceiros. |
2 |
Vá para . |
3 |
Insira uma URL a ser usada em Webhook . |
4 |
Se você quiser autenticar as cargas de webhook com um token secreto, poderá adicionar uma. Você pode encontrar mais informações sobre webhooks Webex e tokens secretos aqui . |
5 |
Selecione um dos seguintes Tipo de recurso para usar no webhook:
![]() |
Terminais API
Fornecemos dois terminais de API juntamente com o webhook para ajudar na reconciliação de dados. Esses terminais permitem que você "atualize" ou reconcilie seus armazenamentos de dados com registros ausentes que não são recebidos pelo ouvinte de webhook. Essas duas APIs são o Endpoint da API de Reconciliação e o Endpoint da API de registros .
Os registros estão disponíveis nessas APIs por 48 horas. Recomendamos conciliar as lojas de discos periodicamente, como a cada 12 ou 24 horas, para que todos os registros sejam recebidos conforme esperado. Um token de acesso de parceiro é necessário para usar esta API. Você pode obter um token de acesso de parceiro e gerenciá-lo de acordo com os princípios padrão Gerenciamento de token de acesso do desenvolvedor Webex .
Terminal de API de reconciliação
O terminal da API de reconciliação retorna o número de registros gerados por cada cliente que é gerenciado pelo parceiro no período de tempo especificado. Se um parceiro gerencia mais de 200 organizações de clientes, os resultados da API serão paginados para melhor legibilidade. Você pode usar esses totais para verificar o armazenamento local se algum registro estiver ausente para clientes específicos. Você pode encontrar a URL do terminal da API de reconciliação aqui:
https://analytics.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z
Parâmetros
A API de reconciliação só pode ser chamada por uma duração máxima de 1 hora, com os parâmetros startTime
e endTime
não mais do que 60 minutos de distância. A API pode ser usada para qualquer período de 1 hora entre 5 minutos e 48 horas atrás, mas para gerenciar a carga de serviço, apenas 1 hora pode ser chamada por vez.
Os parâmetros disponíveis são:
- startTime (string) — Hora do primeiro relatório que você deseja coletar. A hora do relatório especifica o tempo de conclusão da chamada.
Você deve formatar a hora como
AAAA-MM-DDTHH:MM:SS.mmmZ
. - endTime (string) — Hora do último relatório que você deseja coletar. A hora do relatório especifica o tempo de conclusão da chamada.
O tempo especificado deve ser posterior ao
startTime
mas não depois de 48 horas e você deve formatar o horário comoAAAA-MM-DDTHH:MM:SS.mmmZ
.
Aqui está um exemplo de como uma carga de retorno JSON do terminal da API de reconciliação se parece:
{ "cdr_counts": [ { "orgId": "zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyy", "count": 3009 }, { "orgId": "aaaa-aaaaa-zzz-xxxx-aaaaaaa", "count": 129 }, { "orgId": "xxxxxxx-yyyy-zzzz-xxxx-yyyyyyyyyyyyy", "count": 278 } ] }
Os cabeçalhos da resposta API indicam o número total de organizações retornadas e se houver páginas extras. Verifique os seguintes parâmetros para garantir que todas as páginas foram consultadas.
num-pages = 2 total-orgs = 283 página atual = 1
Os parâmetros acima mostram que a página atual é a primeira página, que há 2 páginas totais e que toda a resposta contém 283 organizações. Acesse a segunda página adicionando o parâmetro page=2
à solicitação GET , conforme mostrado abaixo.
https://analytics.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2
Grava o terminal da API
Esse terminal da API retorna registros de chamadas em formato JSON, idêntico ao formato descrito na API do histórico de chamadas detalhado . A carga útil retornada contém campos idênticos à carga retornada do Histórico detalhado de chamadas. Você pode encontrar mais detalhes sobre os valores em cada campo retornado aqui . O terminal da API de registros é usado para consultar registros ausentes em organizações para as quais os registros estão ausentes. Você pode encontrar a URL do terminal da API de registros aqui:
https://analytics.webexapis.com/v1/partners/cdrsbyorg?orgId=zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy&endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z
Parâmetros
-
orgID — A ID da organização para a qual você deseja consultar registros. Você pode abrir esses identificadores do terminal de reconciliação anterior.
-
startTime (string) — Hora do primeiro relatório que você deseja coletar. A hora do relatório especifica o tempo de conclusão da chamada.
O tempo especificado deve estar entre 5 minutos atrás e 48 horas atrás, e você deve formatar a hora como AAAA-MM-DDTHH:MM:SS.mmmZ
.
-
endTime (string) — Hora do último relatório que você deseja coletar. A hora do relatório especifica o tempo de conclusão da chamada.
O tempo especificado deve ser posterior ao startTime
mas não depois de 48 horas e você deve formatar o horário como AAAA-MM-DDTHH:MM:SS.mmmZ
.