Pular para o conteúdo principal

  Artigo atualizado: 04 de janeiro de 2022

API de métricas em tempo real Sparkcentral

A API de métricas em tempo real oferece acesso direto às métricas em tempo real na plataforma Sparkcentral por meio de uma API RESTful conveniente e segura. A API fornece aos clientes da Sparkcentral um meio de se integrar aos painéis internos do contact center em conjunto com outros canais de comunicação tradicionais e/ou digitais, como telefone, e-mail, bate-papo ao vivo, etc.

A API de métricas em tempo real usa

Se você estiver criando software, você pode usar a API para envolver seus clientes:

  • Exibindo o tempo de espera atual para os clientes em um aplicativo ou site móvel.

Se você for um negócio, você pode usar a API para simplificar os processos comerciais internos:

  • Exibindo o backlog atual e as principais métricas em canais digitais juntamente com outras mídias de contact center em painéis em tempo real mantidos internamente.
  • Manter as partes interessadas internas informadas relatando tendências por hora em estatísticas de& backlog de volume em canais digitais, para encaminhar agentes de forma eficiente para outro canal se o volume aumentar.

Redes suportadas

A Sparkcentral está comprometida em oferecer suporte à maioria das redes de mensagens do mercado com o mais rico conjunto de funcionalidades. Hoje, você pode usar o Sparkcentral para conversar sobre:

  • Facebook
  • Twitter
  • Instagram
  • MessageBird
  • Mensagens no aplicativo
  • WhatsApp
  • Twilio
  • WeChat
  • Mailgun
  • Telegram
  • Viber

Comece agora

O acesso aos endpoints de mensagens proativas do Sparkcentral requer chaves de acesso. Os usuários com acesso no nível de administrador podem gerar chaves nas configurações do administrador expandindo Integração e APIs e selecionando Chaves de API Rest.

Autenticação

A API de métricas em tempo real usa o Fluxo de concessão de credenciais de cliente da especificação Oauth 2.0 para autenticação e autorização do cliente. Os clientes recebem um client_id e client_secret para autenticar com o servidor de autorização do Sparkcentral e recebem um access_token para usar na autorização de solicitação de API. O access_token deve ser usado em um cabeçalho de autorização, mas pode ser passado como um parâmetro de string de busca (consulte detalhes de solicitação/resposta mais adiante neste artigo). Quando o access_token expira, a API retorna um 401 não autorizado. O cliente pode automatizar isso gerando um novo token de acesso e reproduzindo a solicitação com falha com o token de acesso novo, conforme documentado na seção a seguir.

Concessão de credenciais

Recupere um access_token para fazer solicitações de API autorizadas. Quando o access_token expirar, use esse endpoint para gerar um novo token.

Solicitação

Copiar
Plataforma dos EUA: 
$ 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=client-read'
Plataforma da 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=seu_ CLIENT_ID_HERE& CLIENT_SECRET=YOU_CLIENT_SECRET_HERE& scope=client-read'
Parâmetros de solicitação, status e descrições
Parâmetro Status Descrição
grant_type requeridos Deve ser definido como client_credentials
client_id requeridos Identificador de cliente fornecido pelo Sparkcentral
client_secret requeridos Sparkcentral forneceu segredo do cliente
objetivo requeridos Deve ser definido como lido pelo cliente

Resposta

Copiar
{ “token_type”: “bearer”, “access_token”: “a1b2c3d4e5f6”, “expires_in”: 43200 }
Parâmetros e descrições de resposta
Parâmetro Descrição
token_type O tipo de token a ser usado no cabeçalho de autorização. Isso sempre será portador da concessão de credenciais do cliente.
access_token O token usado para autorizar solicitações. Isso deve ser adicionado às solicitações como cabeçalho de autorização: Autorização: Portador a1b2c3d4e5f6. A API também aceitará access_token como um parâmetro de string de consulta; no entanto, usar o cabeçalho de autorização é o método preferido.
expires_in O número de segundos até o token expirar (12 horas)

APIs de dados

Volume de mensagens de entrada

Uma contagem de mensagens de entrada com base em filtros aplicados.

Exemplo de URI:

GET /reporting-metrics/inbound-message-volume

parâmetros de URI

parâmetros de URI
   
desde

string (obrigatório)

Uma data e hora ISO-8601 marcando o início inclusivo do resultado. Deve ser codificado por URL. O filtro de pode ter no máximo 14 dias no passado.

para

string (opcional)

Uma data e hora ISO-8601 marcando o final exclusivo do resultado. Deve ser codificado por URL. Se não for fornecido para filtrar, as mensagens que foram enviadas até agora serão incluídas.

MediumID

string (opcional)

Filtre por identificador médio. Se nenhum filtro MediumID for fornecido, as mensagens enviadas de todas as mídias conectadas serão incluídas. Opções: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

ChannelID

string (opcional)

Filtre por identificador de canal (para obter uma lista de IDs de canal, entre em contato com um representante da Sparkcentral). Se nenhum filtro ChannelID for fornecido, as mensagens enviadas de todos os canais conectados serão incluídas.

GroupByInterval

string (opcional)

Um intervalo para agrupar os resultados. Se nenhum GroupByInterval for fornecido, a contagem total de mensagens que correspondam a determinados filtros será retornada. Não podem ser solicitados mais de 60 intervalos por solicitação. Por exemplo, ao selecionar minuto, o intervalo de tempo solicitado não pode ser superior a 1 hora. Opções: dia de hora minuto

fuso horário

string (opcional)

O nome do fuso horário a ser usado em conjunto com GroupByInterval, por exemplo, America/Los_Angeles. Deve ser codificado por URL. Se nenhum fuso horário for fornecido, o fuso horário “UTC” padrão será usado.

Volume de mensagens de saída

Uma contagem de mensagens de saída com base em filtros aplicados.

Exemplo de URI:

GET /reporting-metrics/outbound-message-volume

parâmetros de URI

parâmetros de URI
   
desde

string (obrigatório)

Uma data e hora ISO-8601 marcando o início inclusivo do resultado. Deve ser codificado por URL. O filtro de pode ter no máximo 14 dias no passado.

para

string (opcional)

Uma data e hora ISO-8601 marcando o final exclusivo do resultado. Se não for fornecido para filtrar, as mensagens que foram enviadas até agora serão incluídas.

MediumID

string (opcional)

Filtre por identificador médio. Se nenhum filtro MediumID for fornecido, as mensagens enviadas para todas as mídias conectadas serão incluídas. Opções: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

ChannelID

string (opcional)

Filtre por identificador de canal (para obter uma lista de IDs de canal, entre em contato com um representante da Sparkcentral). Se nenhum filtro ChannelID for fornecido, as mensagens enviadas de todos os canais conectados serão incluídas.

GroupByInterval

string (opcional)

Um intervalo para agrupar os resultados. Se nenhum GroupByInterval for fornecido, a contagem total de mensagens que correspondam a determinados filtros será retornada. Não podem ser solicitados mais de 60 intervalos por solicitação. Por exemplo, ao selecionar minuto, o intervalo de tempo solicitado não pode ser superior a 1 hora. Opções: dia de hora minuto

fuso horário

string (opcional)

O nome do fuso horário a ser usado em conjunto com GroupByInterval. Deve ser codificado por URL. Se nenhum fuso horário for fornecido, o fuso horário padrão “UTC” será usado.

Tempo médio da primeira resposta

O tempo médio em segundos para a primeira resposta a uma mensagem de entrada.

Exemplo de URI:

GET /reporting-métricas/tempo de primeira resposta

parâmetros de URI

parâmetros de URI
   
desde

string (obrigatório)

Uma data e hora ISO-8601 marcando o início inclusivo do resultado. Deve ser codificado por URL. O filtro de pode ter no máximo 14 dias no passado.

para

string (opcional)

Uma data e hora ISO-8601 marcando o final do resultado. Deve ser codificado por URL. Somente mensagens de entrada e respostas enviadas antes da hora da data serão incluídas no cálculo médio do tempo de primeira resposta. Se não for fornecido para filtrar, as mensagens que foram enviadas até agora serão incluídas.

MediumID

string (opcional)

Filtre por identificador médio. Se nenhum filtro MediumID for fornecido, as mensagens enviadas em qualquer mídia conectada serão incluídas. Opções: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

ChannelID

string (opcional)

Filtre por identificador de canal (para obter uma lista de IDs de canal, entre em contato com um representante da Sparkcentral). Se nenhum filtro ChannelID for fornecido, as mensagens enviadas de todos os canais conectados serão incluídas.

Resolvido com resposta

O número de mensagens que foram resolvidas com pelo menos uma resposta.

Exemplo de URI:

GET /reporting-métricas/resolvido-com-uma resposta

parâmetros de URI

parâmetros de URI
   
desde

string (opcional)

Uma data e hora ISO-8601 marcando o início inclusivo do resultado. Deve ser codificado por URL. Somente mensagens de entrada e respostas enviadas após a data e hora serão incluídas no cálculo Resolved with Reply. Se não for fornecido nenhum filtro, as mensagens enviadas desde 5 dias atrás serão incluídas.

para

string (opcional)

Uma data e hora ISO-8601 marcando o final exclusivo do resultado. Deve ser codificado por URL. Somente mensagens de entrada e respostas enviadas antes da hora da data serão incluídas no cálculo Resolved with Reply. Se não for fornecido para filtrar, as mensagens que foram enviadas até agora serão incluídas.

MediumID

string (opcional)

Filtre por identificador médio. Se nenhum filtro MediumID for fornecido, as mensagens enviadas em qualquer mídia conectada serão incluídas. Opções: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

ChannelID

string (opcional)

Filtre por identificador de canal (para obter uma lista de IDs de canal, entre em contato com um representante da Sparkcentral). Se nenhum filtro ChannelID for fornecido, as mensagens enviadas de todos os canais conectados serão incluídas.

 

Tempo médio de manuseio

O tempo médio em segundos que uma conversa é tratada por um agente, especificamente a diferença entre carimbos de data/hora da conversa aberta e conversação pendente/resolvida. Para que o tempo médio de manipulação seja calculado, deve haver uma saída entre o evento aberto e pend/resolve.

Exemplo de URI:

GET /reporting-métricas/handle-time

parâmetros de URI

parâmetros de URI
   
desde

string (obrigatório)

Uma data e hora ISO-8601 marcando o início inclusivo do resultado. Deve ser codificado por URL. O filtro de pode ter no máximo 14 dias no passado.

para

string (opcional)

Uma data e hora ISO-8601 marcando o final exclusivo do resultado

MediumID

string (opcional)

Filtre por identificador médio. Se nenhum filtro MediumID for fornecido, as mensagens enviadas em qualquer mídia conectada serão incluídas. Opções: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

ChannelID

string (opcional)

Filtre por identificador de canal (para obter uma lista de IDs de canal, entre em contato com um representante da Sparkcentral). Se nenhum filtro ChannelID for fornecido, as mensagens enviadas de todos os canais conectados serão incluídas.

Disponibilidade do agente

O número de agentes disponíveis ou ausentes.

Exemplo de URI:

GET /reporting-métricas/agent-availability

parâmetros de URI

parâmetros de URI
   
UserPresenceStatus

string (opcional)

Status do agente para filtrar. Recomenda-se sempre fornecer UserPresenceStatus; o resultado sempre será 0 caso contrário. Opções: disponível fora

ChannelID

string (opcional)

Filtre por identificador de canal (para obter uma lista de IDs de canal, entre em contato com um representante da Sparkcentral). Se nenhum filtro ChannelID for fornecido, as mensagens enviadas de todos os canais conectados serão incluídas.

Contatos aguardando na fila

O número de contatos aguardando na fila por uma resposta.

Exemplo de URI:

GET /queue-métrica/contatos-espera

parâmetros de URI

parâmetros de URI
   
status

string (obrigatório)

Status da fila para filtrar. Opções: novo pendente

MediumID

string (opcional)

Filtre por identificador médio. Se nenhum filtro MediumID for fornecido, as mensagens enviadas em qualquer mídia conectada serão incluídas. Opções: fb twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

ChannelID

string (opcional)

Filtre por identificador de canal (para obter uma lista de IDs de canal, entre em contato com um representante da Sparkcentral). Se nenhum filtro ChannelID for fornecido, as mensagens enviadas de todos os canais conectados serão incluídas.

Tempo de espera mais longo na fila

O tempo mais longo atual em segundos que um contato está aguardando uma resposta. Se nenhum filtro MediumID for fornecido, as mensagens enviadas em qualquer mídia conectada serão incluídas.

Exemplo de URI:

OBTER /métricas de fila/maior tempo de espera

parâmetros de URI

parâmetros de URI
   
status

string (obrigatório)

Status da fila para filtrar Opções: novo pendente

MediumID

string (opcional)

Filtrar por identificador médio Opções: f b twit instagram messagebird rtm whatsapp twilio wechat mailgun telegram viber

ChannelID

string (opcional)

Filtre por identificador de canal (para obter uma lista de IDs de canal, entre em contato com um representante da Sparkcentral). Se nenhum filtro ChannelID for fornecido, as mensagens enviadas de todos os canais conectados serão incluídas.

Exemplos

1. Mostre-me o volume de mensagens recebidas por hora para todos os meios

Exemplo de URI:

GET /reporting-metrics/inbound-message-volume

2. Mostre-me o tempo médio de resposta atual para um canal em um intervalo de 30 minutos

Se a hora atual for: 2017-06-22T 14:00:00 + 01:00; ChannelID é: 'efe3ca3a-9872-4ef2-9895-c948cadced29'

Exemplo de URI:

GET /reporting-métricas/tempo de primeira resposta

3. Mostre-me o número total de contatos resolvidos com pelo menos uma resposta para ontem no Twitter

Exemplo de URI:

GET /reporting-métricas/resolvido-com-uma resposta

4. Mostre-me o tempo médio de manuseio da última hora para um canal do Twitter no fuso horário PST

Se a hora atual for: 2017-06-22T 14:00:00-07:00; ChannelID é: 'efe3ca3a-9872-4ef2-9895-c948cadced29'

Exemplo de URI:

GET /reporting-métricas/handle-time

5. Mostre-me o número total de contatos atualmente aguardando na nova fila para todos os canais

Exemplo de URI:

GET /queue-métrica/contatos-espera

 

Não consegue encontrar o que está procurando? Estamos aqui para ajudar