O webhook de Registros Detalhados de Chamadas oferece uma solução segura, escalável e robusta, orientada por eventos em vez de solicitações. Este webhook proporciona maior visibilidade das atividades de chamadas Webex dos seus clientes, suportando casos de uso que vão desde faturamento até relatórios personalizados.

Você pode usar este webhook para coletar registros de forma prática para todos os clientes gerenciados pelo Partner Hub, sem precisar consultar cada cliente individualmente. Este webhook permite desenvolver aplicações personalizadas de relatórios, faturamento e análise, tanto para requisitos internos de negócios quanto para serviços de valor agregado.

Para uma introdução ao webhook e às suas APIs associadas, assista a este Vidcast: API de histórico de chamadas detalhado do parceiro Webex.

O que o webhook de parceiros oferece

O webhook fornece registros detalhados do histórico de chamadas a cada 5 minutos. Cada carga útil do webhook contém:

• Registros de chamadas que terminaram entre 10 e 5 minutos antes do horário atual.
• Quaisquer registros atrasados processados pela nuvem do Webex Calling.
• Preenche automaticamente os registros de chamadas atrasadas nas cargas úteis do webhook subsequentes para garantir uma entrega confiável.

Para mostrar como os registros de chamadas são incluídos em cada carga útil, considere o seguinte exemplo:

• Uma carga útil recebida em 14:05 contém chamadas que terminaram entre 13:55 e 14:00.
• Chamadas que terminam entre 14:00 e 14:05 estão incluídos no 14:10 carga útil.
• Registros concluídos anteriormente (por exemplo, uma chamada que terminou em 14:04) mas processado tardiamente pela nuvem Webex Calling (por exemplo, às 14:11) estão incluídos na próxima carga útil programada (por exemplo, 14:15).

Webhook no Hub de Parceiros

Ao fornecer um webhook, você permite que a plataforma de análise envie registros de chamadas para seu URL de retorno de chamada sempre que eles forem gerados.

Os registros de chamadas do Webex são entregues usando o mesmo formato das APIs de Registros de Chamadas Detalhados existentes . Você pode configurar um webhook e escolher entre dois tipos de feed:

• Análises — Inclui todos os registros de chamadas de todas as organizações clientes com as quais o parceiro mantém um relacionamento de Webex Calling. Isso inclui organizações onde:
  • O parceiro gerencia a organização do cliente com a função de Administrador Pleno do Parceiro.
  • A organização do cliente possui uma assinatura ativa do Webex Calling na organização parceira.
• Faturamento — Inclui registros de chamadas feitas por usuários com uma licença do Webex Calling vendida e fornecida pelo parceiro. Os registros de chamadas para Espaços de Trabalho estão incluídos neste feed.

Acesso e privacidade de dados

Somente o sócio proprietário pode acessar os Registros Detalhados de Chamadas (CDR) para fins de faturamento.

• Um parceiro (ou subparceiro) que gerencia a licença associada ao registro de chamada torna-se o parceiro proprietário.
• A propriedade é determinada por: ID do usuário > ID da licença > ID da assinatura > ID do parceiro.
• Cada CDR é acessível a um único parceiro.
• Alguns registros de chamadas não são mapeados para um parceiro de faturamento, e nem todos os parceiros associados a uma organização recebem acesso igualitário a todos os registros, uma vez que esses registros podem conter informações de identificação pessoal (PII).

Além do webhook, o Webex Calling fornece endpoints de API para dar suporte à reconciliação de dados. Esses endpoints permitem que você atualize ou reconcilie seus bancos de dados com quaisquer registros ausentes que seu ouvinte de webhook possa não ter recebido. Os dois endpoints da API são a API de Reconciliação e a API de Registros.

Os registros dessas APIs ficam disponíveis por 30 dias. Para garantir que você receba todos os registros esperados, recomendamos que faça a conciliação dos seus arquivos periodicamente, por exemplo, a cada 12 ou 24 horas.

Você precisa usar um token de acesso de parceiro para acessar essas APIs. Obtenha e gerencie seu token de acesso de parceiro de acordo com as práticas padrão de gerenciamento de tokens de acesso doWebex Developer.

Endpoint da API de reconciliação

O endpoint da API de Reconciliação retorna o número total de registros de chamadas gerados para cada cliente gerenciado pelo parceiro dentro do período de tempo especificado. Você pode usar esses totais para verificar seu armazenamento local e identificar quaisquer registros de chamadas ausentes ou inconsistentes para clientes específicos.

Se você gerencia mais de 200 organizações de clientes, a API pagina os resultados para melhorar a legibilidade.

A URL do endpoint da API de Reconciliação utiliza o seguinte formato:

Parâmetros da API

Você pode usar a API para recuperar registros de chamadas dos últimos 30 dias. O intervalo de tempo selecionado deve começar pelo menos 5 minutos antes do horário UTC atual e não pode exceder 12 horas entre os horários de início e término em uma única chamada de API.

Os parâmetros da API são:

• startTime (obrigatório, string)—A data e hora de início (UTC) para o primeiro registro que você deseja coletar. Assegure-se de que:
  • Você formata a hora como YYYY-MM-DDTHH:MM:SS.mmmZ. Por exemplo, 2025-08-15T06:00:00.000Z.
  • A data e hora de início não devem ser anteriores a 30 dias a partir da hora UTC atual.
  • O intervalo entre startTime e endTime não pode exceder 12 horas.
• endTime (obrigatório, string)—A data e hora de término (UTC) para os registros que você deseja coletar. Os registros são baseados no horário do relatório, ou seja, quando a chamada é concluída. Assegure-se de que:
  • Você formata a hora como YYYY-MM-DDTHH:MM:SS.mmmZ. Por exemplo, 2025-08-15T18:00:00.000Z.
  • A data e hora de término devem ser 5 minutos anteriores à hora UTC atual e não podem ter mais de 30 dias.
  • A data e hora de término devem ser maiores que startTime.
  • O intervalo entre startTime e endTime não pode exceder 12 horas.

Exemplo de resposta JSON de um endpoint da API de Reconciliação:

          {
          "cdr_counts": [
          {
          "orgId": "zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy",
          "count": 3009
          },
          {
          "orgId": "yyyyyyyy-yyyy-zzzz-xxxx-yyyyyyyyyyyy",
          "count": 129
          },
          {
          "orgId": "xxxxxxxx-yyyy-zzzz-xxxx-yyyyyyyyyyyy",
          "count": 27895
          }
          ]
          }          
        

Os cabeçalhos de resposta da API indicam o número total de organizações retornadas e se páginas adicionais estão disponíveis. Verifique os seguintes parâmetros de cabeçalho para garantir que você consultou todas as páginas:

• num-páginas: Número total de páginas (por exemplo, 2)
• organizações totais: Número total de organizações incluídas na resposta (por exemplo, 283)
• página atual: O número da página atual (por exemplo, 1)

Por exemplo, se os cabeçalhos mostrarem num-pages=2, total-orgs=283, e current-page=1, Você está visualizando a primeira página de uma resposta de duas páginas contendo um total de 283 organizações. Para acessar a próxima página, adicione o page=2 parâmetro para sua solicitação GET, conforme mostrado abaixo:

https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2

Endpoint da API de Registros

O endpoint da API de Registros é usado para consultar registros de chamadas ausentes para organizações específicas onde discrepâncias ou dados faltantes foram identificados usando a API de Reconciliação.

A API Records retorna registros de chamadas em formato JSON , idêntico ao formato descrito naAPI Detailed Call History. A carga útil retornada contém campos idênticos à carga útil retornada pelo Histórico Detalhado de Chamadas. Para obter mais informações sobre os campos e seus valores, consulte Relatório de histórico de chamadas detalhado do Webex Calling.

A API fornece registros de chamadas que terminaram 5 minutos antes do horário atual. Para garantir que todos os registros de chamadas sejam disponibilizados, recomendamos consultar a API uma hora após o período desejado.

A URL do endpoint da API de Registros utiliza o seguinte formato:

https://analytics-calling.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 da API

• OrgID (obrigatório, string)—O ID da organização para a qual você deseja recuperar registros. Você pode obter os IDs das organizações através da API de Reconciliação.
• startTime (obrigatório, string)—A data e hora de início (UTC) para o primeiro registro que você deseja coletar. Assegure-se de que:
  • Você formata a hora como YYYY-MM-DDTHH:MM:SS.mmmZ. Por exemplo, 2025-08-15T06:00:00.000Z.
  • A data e hora de início não devem ser anteriores a 30 dias a partir da hora UTC atual.
  • O intervalo entre startTime e endTime não deve exceder 12 horas em uma única solicitação de API.
• endTime (obrigatório, string)—A data e hora final (UTC) do último registro que você deseja coletar. Os registros são baseados no horário do relatório, ou seja, quando a chamada é concluída. Assegure-se de que:
  • Você formata a hora como YYYY-MM-DDTHH:MM:SS.mmmZ. Por exemplo, 2025-08-15T18:00:00.000Z.
  • A data e hora de término devem ser, no mínimo, 5 minutos anteriores à hora UTC atual e não podem ter mais de 30 dias.
  • A data e hora de término devem ser maiores que startTime.
  • O intervalo entre startTime e endTime não deve exceder 12 horas em uma única solicitação de API.
• Max (opcional, número) — Limita o número máximo de registros por página na resposta. Assegure-se de que:
  • A faixa de valores é de 500 a 5000. O valor padrão é 5000. Por exemplo, Max=1000.
  • Se a API tiver mais registros para retornar do que o valor máximo especificado, a resposta será paginada.
  • Se for especificado um valor inferior a 500, ele será ajustado automaticamente para 500. Se for especificado um valor acima de 5000, ele será ajustado para 5000.

Paginação

Para identificar se as respostas da API são paginadas, verifique os cabeçalhos da resposta em busca de um cabeçalho Link. Se um link next estiver presente no cabeçalho Link, extraia-o e use o valor startTimeForNextFetch para solicitar o próximo conjunto de registros. Caso não haja um próximo link, todos os relatórios referentes ao intervalo de tempo selecionado serão coletados.

As solicitações de API para páginas subsequentes podem ser feitas imediatamente, mas devem ser limitadas a um máximo de 10 solicitações paginadas por minuto, por escopo de token.

Por exemplo, se a solicitação inicial da API for:

https://analytics-calling.webexapis.com/v1/partners/cdrsbyorg?orgId=zzzzzzzz-yyyy-zzzz-xxxx-yyyyyyyyyyyy&endTime=2025-08-15T18:00:00.000Z&startTime=2025-08-15T06:00:00.000Z&Max=5000

Então, o cabeçalho Link na resposta é:

; rel="next"

Outros valores de link possíveis incluem rel="first" e rel="prev" para a primeira e a página anterior, respectivamente.

Parceiro reports/templates API

Você pode gerar e baixar relatórios disponíveis no Partner Hub usando as APIs de Relatórios de Parceiros . Para obter mais informações, consulte o parceiro report/templates.

Os parceiros também podem acessar e baixar diversos relatórios diretamente do Partner Hub. Para obter mais informações, consulte os relatórios do Partner Hub.