API Apps

A plataforma Contact Center AI (CCAI Platform) oferece endpoints de API para oferecer suporte à integração com a plataforma. A API Apps estende os recursos dos canais compatíveis com a plataforma, incluindo chamadas, chats e SMS. Os endpoints são agrupados nas seguintes categorias:

Autenticação básica

As solicitações usam 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 de API e dê um nome a elas.

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 um subdomínio próprio. 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 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​}/apps/api/v1/calls

Limites de taxas

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

Esperar chaves JSON não reconhecidas em respostas da API

Todas as atualizações de API são compatíveis com versões anteriores. Reservamos o direito de introduzir novas chaves JSON em respostas de API atuais a qualquer momento. Recomendamos processar as respostas de forma defensiva, ignorando chaves não reconhecidas para manter a funcionalidade.