Descripción general

El webhook de registros de llamadas detallados le permite tener una mayor visibilidad de la actividad de Webex Calling de sus clientes para diversos fines, desde la facturación hasta los informes personalizados. Puede utilizar este webhook para recopilar registros cómodamente para todos sus clientes sin tener que consultar registros de cada cliente uno por uno. Este webhook le permite desarrollar aplicaciones analíticas y de informes personalizados tanto para fines empresariales internos como para la prestación de servicios de valor agregado a los clientes. Para obtener una introducción al webhook y las API que lo acompañan, puede ver este vidcast.

El webhook entrega registros cada 5 minutos. Cada carga de pago de webhook contiene registros de llamadas que finalizaron hace entre 10 y 5 minutos. Por ejemplo, una carga de pago recibida a las 17:00 incluye llamadas que finalizaron entre las 16:50 y las 16:55. Las llamadas que finalizan entre las 16:55 y las 17:00 estarán en la carga de pago de 17:05.

Los registros de Webex Calling se entregan con el mismo formato que las API de registros detallados de llamadas existentes. Puede configurar un webhook y elegir entre dos tipos de alimentación:

  • Análisis: incluye todos los registros de llamadas de todas las organizaciones de clientes con las que el socio tiene una relación de Webex Calling. Esto incluye organizaciones para las que:
    • El socio administra la organización del cliente con una función de administrador total del socio.
    • La organización del cliente tiene una suscripción activa de Webex Calling dentro de la organización del socio.
  • Facturación: solo incluye registros de llamadas para llamadas realizadas por usuarios con una licencia de Webex Calling vendida por el socio. Los registros de llamadas para los espacios de trabajo se incluyen en esta fuente.

Configurar una URL de devolución de llamada para una Webhook

Configure webhook en Partner Hub. Solo puede configurar un webhook por organización de socio. Debe ser administrador completo para configurar un webhook.

1

Inicie sesión en el Concentrador de socios.

2

Vaya a Configuración de la organización > Registros detallados de llamadas.

3

Introduzca una URL para utilizarla en Webhook.

4

Si desea autenticar las cargas útiles de webhook con un token secreto, puede agregar uno. Puede encontrar más información sobre los webhooks y los tokens secretos de Webex aquí.

5

Seleccione uno de los siguientes Tipo de recurs o que desea utilizar para el webhook:

  • Análisis: incluye todos los registros de llamadas de todas las organizaciones de clientes con las que el socio tiene una relación de Webex Calling.
  • Facturación: solo incluye los registros de llamadas a los que el socio vendió licencias de Webex Calling. Esta fuente incluye registros de llamadas para los espacios de trabajo.
Configuración de webhook de registros detallados de llamadas en Partner Hub

Extremos de API

Proporcionamos dos extremos de API junto con webhook para ayudar con la conciliación de datos. Estos extremos le permiten "ponerse al día" o conciliar sus almacenes de datos con los registros faltantes que no son recibidos por el oyente de webhook. Estas dos API son el parámetro de la API de conciliació n y el parámetro de la API de registros.

Los registros están disponibles en estas API durante 48 horas. Recomendamos reconciliar las tiendas de registros periódicamente, como cada 12 o 24 horas, para que todos los registros se reciban según lo previsto. Se requiere un token de acceso de socio para utilizar esta API. Puede obtener un token de acceso de socio y administrarlo según los principios estándar de administración de token de acceso para desarrolladores de Webex.

Extremo de la API de conciliación

El extremo de la API de conciliación devuelve la cantidad de registros generados por cada cliente que administra el socio en el período de tiempo especificado. Si un socio administra más de 200 organizaciones de clientes, los resultados de la API se detallarán para una mejor legibilidad. Puede utilizar estos totales para verificar su almacenamiento local si faltan registros para clientes específicos. Puede encontrar la URL del extremo de la API de conciliación aquí:

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

Parámetros

La API de conciliación solo se puede llamar durante una duración máxima de 1 hora, con los parámetros startTime y endTime a no más de 60 minutos de diferencia. La API se puede utilizar durante cualquier período de 1 hora entre 5 minutos y 48 horas atrás, pero para administrar la carga de servicio, solo se puede llamar a 1 hora a la vez.

Los parámetros disponibles son los siguientes:

  • startTime (cadena): hora del primer informe que desea recopilar. La hora del informe especifica la hora de finalización de la llamada.

    Debe formatear la hora como YYYY-MM-DDTHH:MM:SS.mmmZ.

  • endTime (cadena): hora del último informe que desea recopilar. La hora del informe especifica la hora de finalización de la llamada.

    La hora especificada debe ser posterior a startTime , pero no posterior a 48 horas, y debe formatear la hora como YYYY-MM-DDTHH:MM:SS.mmmZ.

A continuación, se muestra un ejemplo de cómo se ve una carga útil de retorno JSON de extremo de la API de conciliación:

{ "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": 278 } ] }

Los encabezados de la respuesta de la API indican la cantidad total de organizaciones devueltas y si hay páginas adicionales. Compruebe los siguientes parámetros para asegurarse de que todas las páginas han sido consultadas.

 páginas-num = 2 organizaciones-totales = 283 páginas-actual = 1

Los parámetros anteriores muestran que la página actual es la primera página, que hay 2 páginas en total y que la respuesta completa contiene 283 organizaciones. Para acceder a la segunda página, agregue el parámetro page=2 a la solicitud GET , como se muestra a continuación.

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

Registra el parámetro de la API

Este parámetro de API devuelve los registros de llamadas en formato JSON, idéntico al formato descrito en la API detallada del historial de llamadas. La carga útil devuelta contiene campos idénticos a la carga útil devuelta del historial de llamadas detallado. Puede encontrar más detalles sobre los valores de cada campo devuelto aquí. El parámetro de la API de registros se utiliza para consultar los registros faltantes de las organizaciones para las que faltan registros. Puede encontrar la URL del parámetro de la API de registros aquí:

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: el ID de la organización para la que desea consultar los registros. Puede abrir estos identificadores desde el extremo de conciliación anterior.

  • startTime (cadena): hora del primer informe que desea recopilar. La hora del informe especifica la hora de finalización de la llamada.

    La hora especificada debe ser de hace 5 minutos a 48 horas, y debe formatear la hora como YYYY-MM-DDTHH:MM:SS.mmmZ.

  • endTime (cadena): hora del último informe que desea recopilar. La hora del informe especifica la hora de finalización de la llamada.

    La hora especificada debe ser posterior a startTime , pero no posterior a 48 horas, y debe formatear la hora como YYYY-MM-DDTHH:MM:SS.mmmZ.