API Manager

Contact Center AI Platform (CCAI Platform) oferece vários endpoints de API para oferecer suporte à integração com a plataforma. A API do gerenciador estende os recursos relacionados às configurações e à configuração do sistema, bem como eventos e atividades.

Os endpoints da API do gerenciador se enquadram em um dos seguintes grupos:

  • Agente: recursos de agentes individuais

  • Atividade do agente: sempre que um widget do agente muda o status do usuário ou recebe uma notificação

  • Campanhas: os eventos associados ao discador automático

  • Chamadas: um único recurso de chamada

  • Chats: um único recurso de chat

  • E-mails: um único recurso de e-mail

  • Menu: as filas a que os agentes são atribuídos e que os usuários finais acessam para receber suporte de um agente.

  • Equipe: as equipes a que um agente pertence

  • Status do usuário: status individuais em que o widget do agente pode estar

Autenticação básica

As solicitações usam a autenticação básica. Para criar credenciais de API, siga estas etapas:

  1. Acesse o portal da CCAI Platform.

  2. Acesse Configurações > Configurações do desenvolvedor > Credenciais da API.

  3. Adicione novas credenciais da API e forneça um nome.

As credenciais para chamadas de API são as seguintes:

  • O subdomínio é usado como a variável {username}.

  • O token é usado como a variável {​password}.

Cada instalação tem seu próprio subdomínio. Para encontrar o subdomínio, localize o URL no navegador. Aparecerá da seguinte maneira:

https://customer.uc1.ccaiplatform.com

Substitua o subdomínio (customer, neste exemplo) pela variável \{subdomain\​}. Substitua o restante do URL (rest.of.url.com, neste exemplo) pela variável \{domain\}.

URL de base

A API usa o seguinte URL de base para todas as solicitações de API

https://{subdomain}.{domain​}/apps/api/v1

em que uma menção a /calls significa https://{subdomain​}.​{domain​}/manager/api/v1/calls

Limites de taxas

O sistema limita as solicitações a uma taxa de 10 solicitações por segundo por cliente.