- Inicio
- /
- Artículo
Webex Calling Los socios multiinquilino (MT) pueden configurar un webhook para recopilar registros Webex Calling para todos sus clientes. Esto permite una conciliación de facturación eficiente, análisis e informes sin necesidad de consultar a cada cliente individualmente.
Descripción general
El webhook Detailed Call Records ofrece una solución segura, escalable y robusta impulsada por eventos en lugar de solicitudes. Este webhook proporciona una mayor visibilidad de Webex Calling las actividades de sus clientes, soportando casos de uso, desde facturación hasta informes personalizados.
Puede usar este webhook para recopilar registros convenientemente para todos los clientes administrados a través de Partner Hub sin consultar a cada cliente individualmente. Este webhook le permite desarrollar informes personalizados, facturación y aplicaciones analíticas tanto para los requisitos internos del negocio como para los servicios de valor agregado.
Para una introducción al webhook y sus API que lo acompañan, vea esta API de Vidcast: Webex Calling Partner Detailed Call History.
Qué ofrece el Webhook Partner
El webhook entrega registros detallados del historial de llamadas cada 5 minutos. Cada carga útil de webhook contiene :
- Registros de llamadas que terminaron entre 10 minutos y 5 minutos antes de la hora actual.
- Cualquier registro tardío procesado por la Webex Calling nube.
- Rellena automáticamente los registros de llamadas tardías en las cargas útiles subsiguientes del webhook para garantizar una entrega confiable.
Para mostrar cómo se incluyen los registros de llamadas en cada carga útil, considere el siguiente ejemplo:
- Una carga útil recibida a las 14:05 contiene llamadas que terminaron entre las 13:55 y las 14:00.
- Las llamadas que terminan entre las 14:00 y las 14:05 están incluidas en la carga útil 14:10.
- Los registros completados antes (por ejemplo, una llamada que terminó a las 14:04) pero procesados tarde por Webex Calling la nube (por ejemplo, a las 14:11) se incluyen en la siguiente carga útil programada (por ejemplo, 14:15).
Los webhooks entregan registros de manera confiable. Sin embargo, puede recibir registros duplicados en cargas útiles de webhook posteriores cuando el sistema reproduce registros bajo ciertas condiciones. Usted es responsable de manejar la deduplicación de registros. Para identificar registros duplicados, utilice el campo ReportId como clave principal y el campo ReportTime para determinar cuándo se completó o procesó una llamada. Utilice estos campos para actualizar o insertar los registros en sus almacenes de datos internos.
Webhook en Partner Hub
Al proporcionar un webhook, permite que la plataforma de análisis envíe registros de llamadas a su URL de devolución de llamada cada vez que se generen.
Webex Callinglos registros se entregan utilizando el mismo formato que las API de Registros de Llamadas Detallados 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 Webex Calling relación. Esto incluye organizaciones en las que:
- El socio administra la organización del cliente con una función de Partner Full Administrator.
- La organización del cliente tiene una Webex Calling suscripción activa dentro de la organización asociada.
- Facturación: incluye registros de llamadas para llamadas realizadas por usuarios con una Webex Calling licencia vendida y aprovisionada por el socio. Los registros de llamadas de los espacios de trabajo se incluyen en este feed.
Acceso y privacidad de datos
Solo el socio propietario puede acceder a los registros de detalles de llamadas (CDR) para facturación.
- Un socio (o subsocio) que administra la licencia asociada con el registro de llamadas se convierte en el socio propietario.
- La propiedad está determinada por: ID de usuario > ID de licencia > ID de suscripción > ID de socio.
- Cada CDR es accesible para un solo socio.
- Algunos registros de llamadas no se asignan a un socio de facturación, y no todos los socios asociados con una organización reciben el mismo acceso a todos los registros, ya que estos registros pueden contener información de identificación personal (PII).
Configurar una URL de devolución de llamada de webhook
Configure el webhook en Partner Hub. Solo puede configurar un webhook por organización asociada.
Asegúrese de que tiene el rol de administrador completo del socio con 'Acceso completo de nivel de administrador organizativo' y marcado en Control Hub (en Administración > , seleccione un administrador completo o administrador completo del socio y, a continuación, seleccione Funciones de administrador > Socio).
Los mismos requisitos de acceso se aplican cuando utiliza las API de Reconciliación y Registros de Asociados de Asociados.
| 1 |
Inicie sesión en Partner Hub. |
| 2 |
Vaya a .
|
| 3 |
Ingrese una URL para usar en Webhook. La URL debe terminar con /webhook (por ejemplo, https://yourdomain.com/webhook).
|
| 4 |
Si desea autenticar sus cargas útiles de webhook con un token secreto, puede agregar uno. Para obtener más información sobre los webhooks de Webex y los tokens secretos, consulte Webex para desarrolladores: Webhooks. |
| 5 |
Seleccione uno de los siguientes tipos de recursos para usar para el webhook:
|
Puntos finales de API de socios
Además del webhook, Webex Calling proporciona puntos finales API para admitir la reconciliación de datos. Estos puntos finales le permiten ponerse al día o reconciliar sus almacenes de datos con cualquier registro faltante que su oyente de webhook podría no haber recibido. Los dos puntos finales de API son la API de reconciliación y la API de registros.
Los registros de estas API están disponibles durante 30 días. Para asegurarse de recibir todos los registros esperados, le recomendamos reconciliar sus tiendas de discos periódicamente, como cada 12 o 24 horas.
Debe usar un token de acceso de socio para acceder a estas API. El usuario autenticador debe ser un administrador completo asociado con acceso de nivel administrativo completo de la organización y debe tener habilitado el acceso a la API Webex Calling CDR. El token OAuth debe incluir el spark-admin:calling_cdr_readalcance. Las funciones de administrador de solo lectura no son suficientes para las API de Reconciliación y Registros de socios.
Utilice el analytics-callingpunto final para la región de Webex Calling datos de la organización del cliente. Utilice la URL base aplicable para las API de reconciliación y registros:
- Estados Unidos y Canadá:
https://analytics-calling.webexapis.com - Europa:
https://analytics-calling-eu.webexapis.com - India:
https://analytics-calling-in.webexapis.com - Australia:
https://analytics-calling-au.webexapis.com
Los rangos de ventana API son aplicables a ambos puntos finales para manejar mejor la carga de servicio.
- Para rangos de tiempo superiores a 48 horas, la duración máxima permitida de la ventana es de 12 horas (se aplica).
- Para un ID de organización asociada, las API tienen una tasa limitada a una solicitud inicial de API por minuto, por alcance de token. Si se utiliza la paginación, se permiten hasta 10 solicitudes API paginadas adicionales por minuto, por token, y estas se pueden realizar inmediatamente después de la solicitud inicial.
Punto final de API de reconciliación
El punto final de la API de reconciliación devuelve el número total de registros de llamadas generados para cada cliente administrado por el socio dentro del período de tiempo especificado. Puede usar estos totales para verificar su almacenamiento local e identificar cualquier registro de llamadas faltante o inconsistente para clientes específicos.
Requisito de acceso: El usuario autenticador debe ser un administrador asociado con acceso de nivel de administrador completo y debe tener habilitado el acceso a la API Webex Calling CDR. El token de acceso debe incluir el spark-admin:calling_cdr_readalcance.
Si administra más de 200 organizaciones de clientes, la API pagina los resultados para mejorar la legibilidad.
La dirección URL del punto final de la API de reconciliación utiliza el siguiente formato:
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z
Parámetros de API
Puede usar la API para recuperar registros de llamadas de los últimos 30 días. La ventana de tiempo seleccionada debe comenzar al menos 5 minutos antes de la hora UTC actual y no puede exceder las 12 horas entre las horas de inicio y finalización en una sola llamada a la API.
Los parámetros de la API son:
-
StartTime (requerido, cadena): la fecha y hora de inicio (UTC) del primer registro que desea recopilar. Asegúrese de que:
- Formatee la hora como
YYYY-MM-DDTHH:MM:SS.mmmZ. Por ejemplo,2025-08-15T06:00:00.000Z.
- La fecha y hora de inicio no deben ser mayores de 30 días a partir de la hora UTC actual.
- La ventana entre
startTimey noendTimepuede exceder las 12 horas.
- Formatee la hora como
-
EndTime (requerido, cadena): la fecha y hora de finalización (UTC) de los registros que desea recopilar. Los registros se basan en la hora del informe, que es cuando se realiza la llamada. Asegúrese de que:
- Formatee la hora como
YYYY-MM-DDTHH:MM:SS.mmmZ. Por ejemplo,2025-08-15T18:00:00.000Z. - La fecha y hora de finalización deben ser 5 minutos antes de la hora UTC actual y no más de 30 días.
- La fecha y hora de finalización deben ser mayores que la
startTime. - La ventana entre los
startTimey noendTimepuede exceder las 12 horas.
- Formatee la hora como
Ejemplo de una respuesta JSON de punto final de API de reconciliació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": 27895
}
]
}
Los encabezados de respuesta API indican el número total de organizaciones devueltas y si hay páginas adicionales disponibles. Compruebe los siguientes parámetros de encabezado para asegurarse de que ha realizado consultas en todas las páginas:
- número de páginas: número total de páginas (por ejemplo, 2)
- organizaciones totales: número total de organizaciones incluidas en la respuesta (por ejemplo, 283)
- página actual: el número de página actual (por ejemplo, 1)
Por ejemplo, si los encabezados muestran num-pages=2, total-orgs=283 y current-page=1, está viendo la primera página de una respuesta de dos páginas que contiene 283 organizaciones en total. Para acceder a la página siguiente, agregue el parámetro page=2 a su solicitud GET, como se muestra a continuación:
https://analytics-calling.webexapis.com/v1/partners/cdrcountbyorg?endTime=YYYY-MM-DDTHH:MM:SS.000Z&startTime=YYYY-MM-DDTHH:MM:SS.000Z&page=2
Registra el punto final de la API
El punto final de la API de registros se utiliza para consultar registros de llamadas faltantes para organizaciones específicas donde se identificaron discrepancias o datos faltantes mediante la API de reconciliación.
Flujo recomendado: Llame /v1/partners/cdrcountbyorgprimero. Luego use la información exacta orgIddevuelta cdr_counts[].orgIdcuando llame /v1/partners/cdrsbyorg.
La API de registros devuelve registros de llamadas en formato JSON, idéntico al formato descrito en la API de historial de llamadas detallado. La carga útil devuelta contiene campos idénticos a la carga útil devuelta del Historial de llamadas detallado. Para obtener más información sobre los campos y sus valores, consulte Informe Webex Calling detallado del historial de llamadas.
La API proporciona registros de llamadas que terminaron 5 minutos antes de la hora actual. Para asegurarse de que todos los registros de llamadas estén disponibles, le recomendamos consultar la API una hora después de su horario preferido.
La URL del punto final de la API de registros utiliza el siguiente 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 de API
-
orgId(obligatorio, cadena): el ID de organización del cliente para el que desea recuperar registros. El nombre del parámetro distingue entre mayúsculas y minúsculas. Puede obtener ID de organización en el campo de respuesta API de reconciliacióncdr_counts[].orgId. -
StartTime (requerido, cadena): la fecha y hora de inicio (UTC) del primer registro que desea recopilar. Asegúrese de que:
- Formatee la hora como
YYYY-MM-DDTHH:MM:SS.mmmZ. Por ejemplo,2025-08-15T06:00:00.000Z. - La fecha y hora de inicio no deben ser mayores de 30 días a partir de la hora UTC actual.
- El intervalo entre los
startTimey noendTimedebe exceder las 12 horas en una sola solicitud de API.
- Formatee la hora como
-
EndTime (requerido, cadena): la fecha y hora de finalización (UTC) del último registro que desea recopilar. Los registros se basan en la hora del informe, que es cuando se realiza la llamada. Asegúrese de que:
- Formatee la hora como
YYYY-MM-DDTHH:MM:SS.mmmZ. Por ejemplo,2025-08-15T18:00:00.000Z. - La fecha y hora de finalización deben ser al menos 5 minutos antes de la hora UTC actual y no más de 30 días.
- La fecha y hora de finalización deben ser mayores que la
startTime. - El intervalo entre los
startTimey noendTimedebe exceder las 12 horas en una sola solicitud de API.
- Formatee la hora como
-
max (opcional, número): limita el número máximo de registros por página en la respuesta. Asegúrese de que:
- El rango es de 500 a 5000. El valor predeterminado es 5000. Por ejemplo,
max=1000. - Si la API tiene más registros que devolver que el valor máximo especificado, entonces la respuesta se pagina.
- Si se especifica un valor inferior a 500, se ajusta automáticamente hasta 500. Si se especifica un valor superior a 5000, se ajusta a 5000.
- El rango es de 500 a 5000. El valor predeterminado es 5000. Por ejemplo,
Paginación
Para identificar si las respuestas API están paginadas, compruebe los encabezados de respuesta para un encabezado Link. Si hay un nextenlace en el encabezado Link, extráigalo y use el startTimeForNextFetchvalor para solicitar el siguiente conjunto de registros. Si no hay un enlace siguiente, entonces se recopilan todos los informes para el intervalo de tiempo seleccionado.
Las solicitudes de API para páginas posteriores se pueden realizar de inmediato, pero deben tener una tarifa limitada a un máximo de 10 solicitudes paginadas por minuto, por alcance de token.
Utilice el procesamiento idempotente y la deduplicación cuando recupere registros, incluso a través de respuestas paginadas o ventanas de reconciliación repetidas. reportIdUtilícelo como clave principal y reportTimepara determinar el último registro procesado.
Por ejemplo, si la solicitud inicial de API es:
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
entonces el encabezado Link en la respuesta es:
<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&startTimeForNextFetch=2025-08-15T09:30:00.000Z&totalCount=20000&max=5000>; rel="next"
La paginación utiliza solo el encabezado rel="next"Link. Si la respuesta incluye un rel="next"enlace, use esa URL para recuperar la siguiente página de registros. Si la respuesta no incluye un rel="next"enlace, ha recuperado todos los registros disponibles para el intervalo de tiempo seleccionado.
La paginación para esta API sigue el estándar RFC5988 (Web Linking). Para obtener más información, consulte Conceptos básicos de la API REST.
Comprender los códigos de respuesta de punto final de API
Esta sección proporciona una descripción general de los códigos de respuesta comunes que se pueden encontrar al trabajar con el punto final de la API de reconciliación y el punto final de la API de registros. Estos puntos finales juegan un papel crítico en la sincronización, validación e informes de datos. Comprender estos códigos de respuesta es esencial para una resolución eficaz de problemas y para mantener integraciones confiables y estables.
|
Código de respuesta |
Descripción del código de respuesta |
|---|---|
|
200 |
OK |
|
400 |
Solicitud incorrecta: La solicitud no fue válida o no puede ser atendida de otra manera. Un mensaje de error adjunto explicará más. |
|
401 |
No autorizado: Faltaban credenciales de autenticación o eran incorrectas. |
|
403 |
Prohibido: La solicitud se entiende, pero ha sido rechazada o no se permite el acceso. |
|
404 |
No encontrado: El URI solicitado no es válido o el recurso solicitado, como un usuario, no existe. También se devuelve cuando el formato solicitado no es compatible con el método solicitado. |
|
405 |
Método no permitido: La solicitud se realizó a un recurso mediante un método de solicitud HTTP que no es compatible. |
|
409 |
Conflicto: La solicitud no se pudo procesar porque entra en conflicto con alguna regla establecida del sistema. Por ejemplo, una persona no puede ser agregada a una habitación más de una vez. |
|
410 |
Atrás: El recurso solicitado ya no está disponible. |
|
415 |
Tipo de medio no admitido: La solicitud se realizó a un recurso sin especificar un tipo de medio o se utilizó un tipo de medio que no es compatible. |
|
423 |
Bloqueado: El recurso solicitado no está disponible temporalmente. Un encabezado Retry-After puede estar presente que especifica cuántos segundos debe esperar antes de volver a intentar la solicitud. |
|
428 |
Precondición requerida: Los archivos no se pueden escanear en busca de malware y deben ser descargados a la fuerza. |
|
429 |
Demasiadas solicitudes: Se han enviado demasiadas solicitudes en un período de tiempo determinado y la solicitud tiene una tarifa limitada. Debe estar presente un encabezado Retry-After que especifique cuántos segundos debe esperar antes de que se pueda realizar una solicitud exitosa. |
|
451 |
De forma predeterminada, las solicitudes |
|
500 |
Error interno del servidor: Algo salió mal en el servidor. Si el problema persiste, no dude en ponerse en contacto con el [equipo de soporte para desarrolladores de Webex] (/explorar/support). |
|
502 |
Puerta de enlace incorrecta: el servidor recibió una respuesta no válida de un servidor ascendente mientras procesaba la solicitud. Inténtelo de nuevo más tarde. |
|
503 |
Servicio no disponible: El servidor está sobrecargado de solicitudes. Inténtelo de nuevo más tarde. |
|
504 |
Tiempo de espera de la puerta de enlace: un servidor ascendente no respondió a tiempo. Si su consulta utiliza el parámetro máximo, intente reducirlo. |
API de informes/plantillas de socios
Puede generar y descargar informes disponibles en Partner Hub utilizando las API de informes de socios. Para obtener más información, consulte el informe/plantillas de socios.
Los socios también pueden acceder y descargar múltiples informes directamente desde Partner Hub. Para obtener más información, consulte los informes de Partner Hub.
Historial de revisiones
Historial de revisión de documentos
|
Fecha de revisión |
Hemos hecho los siguientes cambios en el artículo |
|---|---|
|
13/08/26 |
|
|
2/04/2026 |
|