Saltar al contenido principal

  Artículo actualizado: 4 de enero de 2022

API de métricas en tiempo real de Sparkcentral

La API de métricas en tiempo real le brinda acceso directo a las métricas en tiempo real en la plataforma Sparkcentral a través de una API RESTful conveniente y segura. La API proporciona a los clientes de Sparkcentral un medio para integrarse con los paneles de control internos del centro de contacto junto con otros canales de comunicación tradicionales y / o digitales, como teléfono, correo electrónico, chat en vivo, etc.

Usos de la API de métricas en tiempo real

Si está creando software, puede utilizar la API para atraer a sus clientes al:

  • Mostrar el tiempo de espera actual a los clientes en una aplicación móvil o un sitio web.

Si tiene una empresa, puede utilizar la API para optimizar los procesos comerciales internos de la siguiente manera:

  • Visualización de la acumulación actual y métricas clave en canales digitales junto con otros medios del centro de contacto en paneles de control en tiempo real mantenidos internamente.
  • Mantener a las partes interesadas internas informadas al informar sobre las tendencias horarias en el volumen y las estadísticas de la acumulación en los canales digitales, para enrutar de manera eficiente a los agentes a otro canal si el volumen aumenta.

Redes compatibles

Sparkcentral se compromete a respaldar la mayoría de las redes de mensajería del mercado con el conjunto de funciones más completo. Hoy, puede usar Sparkcentral para conversar sobre:

  • Facebook
  • Gorjeo
  • Instagram
  • MessageBird
  • Mensajería en la aplicación
  • Whatsapp
  • Twilio
  • WeChat
  • Mailgun
  • Telegrama
  • Viber

Empezar

El acceso a los puntos finales de mensajería proactiva de Sparkcentral requiere claves de acceso. Los usuarios con acceso de nivel de administrador pueden generar claves en la configuración de administrador expandiendo Integración y API y seleccionando Claves de API REST.

Autenticación

La API de métricas en tiempo real utiliza el flujo de concesión de credenciales de cliente de la especificación Oauth 2.0 para la autenticación y autorización del cliente. Los clientes reciben un client_id y client_secret para autenticarse con el servidor de autorización de Sparkcentral y reciben un access_token para usar en la autorización de solicitudes de API. El access_token debe usarse en un encabezado de autorización, pero opcionalmente se puede pasar como un parámetro de cadena de consulta (ver detalles de solicitud / respuesta más adelante en este artículo). Cuando expira el access_token , la API devuelve un 401 no autorizado . El cliente puede automatizar esto generando un nuevo token de acceso y reproduciendo la solicitud fallida con el token de acceso nuevo, como se documenta en la siguiente sección.

Concesión de credenciales de cliente

Recupere un access_token para realizar solicitudes de API autorizadas. Cuando expire el access_token , use este punto final para generar un nuevo token.

Solicitud

Dupdo
Plataforma estadounidense:
$ curl -X POST https://public-api.sparkcentral.com/oauth2/token -H 'content-type: application / x-www-form-urlencoded' -d 'grant_type = client_credentials & client_id = YOUR_CLIENT_ID_HERE & client_secret = YOUR_CLIENT_SECRET_HERE & scope -leer'
Plataforma de la UE:
$ curl -X POST https://public-api-eu.sparkcentral.com/oauth2/token -H 'content-type: application / x-www-form-urlencoded' -d 'grant_type = client_credentials & client_id = YOUR_CLIENT_ID_HERE & client_secret = YOUR_CLIENT_SECRET_HERE = cliente-leído '
Solicitar parámetros, estado y descripciones
Parámetro Estado Descripción
grant_type requerido Debe establecerse en client_credentials
Identificación del cliente requerido Identificador de cliente proporcionado por Sparkcentral
client_secret requerido Sparkcentral proporcionó el secreto del cliente
alcance requerido Debe estar configurado para lectura de cliente

Respuesta

Dupdo
{ “token_type”: “bearer”, “access_token”: “a1b2c3d4e5f6”, “expires_in”: 43200 }
Parámetros de respuesta y descripciones
Parámetro Descripción
token_type El tipo de token que se utilizará en el encabezado de autorización. Este será siempre al portador de la concesión de las credenciales del cliente.
access_token El token utilizado para autorizar solicitudes. Esto debe agregarse a las solicitudes como un encabezado de autorización: Authorization: Bearer a1b2c3d4e5f6 . La API también aceptará access_token como un parámetro de cadena de consulta; sin embargo, utilizar el encabezado de autorización es el método preferido.
expira en La cantidad de segundos hasta que caduque el token (12 horas)

API de datos

Volumen de mensajes entrantes

Un recuento de mensajes entrantes según los filtros aplicados.

URI de ejemplo:

GET / reporting-metrics / inbound-message-volume

Parámetros de URI

Parámetros de URI
   
de

string (requerido)

Una ISO-8601 marca el inicio inclusivo del resultado. Debe estar codificado en URL. El from filtro puede ser un máximo de 14 días en el pasado.

para

string (opcional)

Una ISO-8601 marca el final exclusivo del resultado. Debe estar codificado en URL. Si hay to se proporciona filtro, se incluirán los mensajes que se han enviado hasta ahora.

mediumId

string (opcional)

Filtrar por identificador de medio. Si no mediumId se incluirán los mensajes enviados desde todos los medios conectados. opciones: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

Canal ID

string (opcional)

Filtre por identificador de canal (para obtener una lista de los ID de su canal, comuníquese con un representante de Sparkcentral). Si no channelId se incluirán los mensajes enviados desde todos los canales conectados.

groupByInterval

string (opcional)

Un intervalo por el que agrupar los resultados. Si no groupByInterval se devolverá el recuento total de mensajes que coincidan con los filtros dados. No se pueden solicitar más de 60 intervalos por solicitud. Por ejemplo, al seleccionar un minute , el intervalo de tiempo solicitado no puede ser superior a 1 hora. Opciones: minute hour day

zona horaria

cadena (opcional)

El timezone name que se utilizará junto con groupByInterval , por ejemplo, America / Los_Angeles. Debe estar codificado en URL. Si no timezone horaria, se utiliza la zona horaria predeterminada 'UTC'.

Volumen de mensajes salientes

Un recuento de mensajes salientes según los filtros aplicados.

URI de ejemplo:

GET / reporting-metrics / outbound-message-volume

Parámetros de URI

Parámetros de URI
   
de

string (requerido)

Una ISO-8601 marca el inicio inclusivo del resultado. Debe estar codificado en URL. El from filtro puede ser un máximo de 14 días en el pasado.

para

string (opcional)

Una ISO-8601 marca el final exclusivo del resultado. Si hay to se proporciona filtro, se incluirán los mensajes que se han enviado hasta ahora.

mediumId

string (opcional)

Filtrar por identificador de medio. Si no mediumId se incluirán los mensajes enviados a todos los medios conectados. opciones: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

Canal ID

string (opcional)

Filtre por identificador de canal (para obtener una lista de los ID de su canal, comuníquese con un representante de Sparkcentral). Si no channelId se incluirán los mensajes enviados desde todos los canales conectados.

groupByInterval

string (opcional)

Un intervalo por el que agrupar los resultados. Si no groupByInterval se devolverá el recuento total de mensajes que coincidan con los filtros dados. No se pueden solicitar más de 60 intervalos por solicitud. Por ejemplo, al seleccionar un minute , el intervalo de tiempo solicitado no puede ser superior a 1 hora. Opciones: minute hour day

zona horaria

string (opcional)

El nombre de la zona horaria que se utilizará junto con groupByInterval . Debe estar codificado en URL. Si no se proporciona una zona horaria, se utiliza la zona horaria predeterminada 'UTC'.

Tiempo medio de primera respuesta

El tiempo promedio en segundos hasta la primera respuesta a un mensaje entrante.

URI de ejemplo:

GET / reporting-metrics / primera-respuesta-tiempo

Parámetros de URI

Parámetros de URI
   
de

string (requerido)

Una ISO-8601 marca el inicio inclusivo del resultado. Debe estar codificado en URL. El from filtro puede ser un máximo de 14 días en el pasado.

para

string (opcional)

Una ISO-8601 marca el final del resultado. Debe estar codificado en URL. Solo los mensajes entrantes y las respuestas enviadas antes to fecha límite se incluirán en el cálculo del tiempo promedio de la primera respuesta. Si hay to se proporciona filtro, se incluirán los mensajes que se han enviado hasta ahora.

mediumId

string (opcional)

Filtrar por identificador de medio. Si no mediumId se incluirán los mensajes enviados en cualquier medio conectado. opciones: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

Canal ID

string (opcional)

Filtre por identificador de canal (para obtener una lista de los ID de su canal, comuníquese con un representante de Sparkcentral). Si no channelId se incluirán los mensajes enviados desde todos los canales conectados.

Resuelto con respuesta

La cantidad de mensajes que se han resuelto con al menos una respuesta.

URI de ejemplo:

GET / reporting-metrics / resuelto-con-una-respuesta

Parámetros de URI

Parámetros de URI
   
de

string (opcional)

Una ISO-8601 marca el inicio inclusivo del resultado. Debe estar codificado en URL. Solo los mensajes entrantes y las respuestas enviadas después from fecha y hora se incluirán en el cálculo de Resuelto con respuesta. Si hay from se proporciona filtro, los mensajes enviados desde los 5 días se incluirán.

para

string (opcional)

Una ISO-8601 marca el final exclusivo del resultado. Debe estar codificado en URL. Solo los mensajes entrantes y las respuestas enviadas antes to fecha se incluirán en el cálculo de Resuelto con respuesta. Si hay to se proporciona filtro, se incluirán los mensajes que se han enviado hasta ahora.

mediumId

string (opcional)

Filtrar por identificador de medio. Si no mediumId se incluirán los mensajes enviados en cualquier medio conectado. opciones: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

Canal ID

string (opcional)

Filtre por identificador de canal (para obtener una lista de los ID de su canal, comuníquese con un representante de Sparkcentral). Si no channelId se incluirán los mensajes enviados desde todos los canales conectados.

 

Tiempo medio de manipulación

El tiempo promedio en segundos que un agente maneja una conversación, específicamente la diferencia entre las marcas de tiempo de la conversación abierta y la conversación pendiente / resuelta. Para que se calcule el tiempo promedio de manejo, debe haber un saliente entre el evento abierto y pendiente / resolución.

URI de ejemplo:

GET / reporting-metrics / tiempo de gestión

Parámetros de URI

Parámetros de URI
   
de

string (requerido)

Una ISO-8601 marca el inicio inclusivo del resultado. Debe estar codificado en URL. El from filtro puede ser un máximo de 14 días en el pasado.

para

cadena (opcional)

Una ISO-8601 marca el final exclusivo del resultado

mediumId

cadena (opcional)

Filtrar por identificador de medio. Si no mediumId se incluirán los mensajes enviados en cualquier medio conectado. opciones: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

Canal ID

string (opcional)

Filtre por identificador de canal (para obtener una lista de los ID de su canal, comuníquese con un representante de Sparkcentral). Si no channelId se incluirán los mensajes enviados desde todos los canales conectados.

Disponibilidad del agente

El número de agentes disponibles o ausentes.

URI de ejemplo:

GET / reporting-metrics / agente-disponibilidad

Parámetros de URI

Parámetros de URI
   
userPresenceStatus

string (opcional)

Estado del agente para filtrar. Se recomienda proporcionar siempre userPresenceStatus ; el resultado siempre será 0 en caso contrario. opciones: away available

Canal ID

string (opcional)

Filtre por identificador de canal (para obtener una lista de los ID de su canal, comuníquese con un representante de Sparkcentral). Si no channelId se incluirán los mensajes enviados desde todos los canales conectados.

Contactos esperando en cola

La cantidad de contactos que esperan en la cola una respuesta.

URI de ejemplo:

GET / queue-metrics / contactos-en espera

Parámetros de URI

Parámetros de URI
   
estado

string (requerido)

Estado de la cola para filtrar. Elecciones: new pending

mediumId

string (opcional)

Filtrar por identificador de medio. Si no mediumId se incluirán los mensajes enviados en cualquier medio conectado. opciones: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

Canal ID

string (opcional)

Filtre por identificador de canal (para obtener una lista de los ID de su canal, comuníquese con un representante de Sparkcentral). Si no channelId se incluirán los mensajes enviados desde todos los canales conectados.

Mayor tiempo de espera en la cola

El tiempo más largo actual en segundos que un contacto está esperando una respuesta. Si no se proporciona un filtro mediumId, se incluirán los mensajes enviados en cualquier medio conectado.

URI de ejemplo:

GET / queue-metrics / longest-wait-time

Parámetros de URI

Parámetros de URI
   
estado

string (requerido)

Estado de la cola para filtrar en opciones: new pending

mediumId

string (opcional)

Filtrar por identificador de medio Opciones: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

Canal ID

string (opcional)

Filtre por identificador de canal (para obtener una lista de los ID de su canal, comuníquese con un representante de Sparkcentral). Si no channelId se incluirán los mensajes enviados desde todos los canales conectados.

Ejemplos de

1. Muéstrame el volumen de mensajes entrantes por hora para todos los medios

URI de ejemplo:

GET / reporting-metrics / inbound-message-volume

2. Muéstrame el tiempo de respuesta promedio actual para un canal en un intervalo continuo de 30 minutos.

Si la hora actual es: 2017-06-22T14: 00: 00 + 01: 00; channelId es: 'efe3ca3a-9872-4ef2-9895-c948cadced29'

URI de ejemplo:

GET /reporting-metrics/first-response-time

3. Muéstrame el número total de contactos resueltos con al menos una respuesta para ayer en Twitter.

URI de ejemplo:

GET / reporting-metrics / resuelto-con-una-respuesta

4. Muéstrame el tiempo promedio de manejo durante la última hora para un canal de Twitter en la zona horaria PST.

Si la hora actual es: 2017-06-22T14: 00: 00-07: 00; channelId es: 'efe3ca3a-9872-4ef2-9895-c948cadced29'

URI de ejemplo:

GET /reporting-metrics/handle-time

5. Muéstrame el número total de contactos que están esperando actualmente en la nueva cola para todos los canales.

URI de ejemplo:

GET /queue-metrics/contacts-waiting

 

¿No encuentras lo que buscas? Estamos aquí para ayudar