API Manager

Contact Center AI Platform (CCAI Platform) fournit plusieurs points de terminaison d'API pour permettre l'intégration à la plate-forme. L'API Manager étend les fonctionnalités liées aux paramètres et à la configuration du système, ainsi qu'aux événements et activités.

Les points de terminaison de l'API Manager sont répartis dans plusieurs groupes :

  • Agent : ressources individuelles des agents

  • Activité de l'agent : chaque fois qu'un widget d'agent modifie l'état de l'utilisateur ou reçoit une notification

  • Campagnes : événements associés au composeur sortant

  • Appels : une seule ressource d'appel

  • Chats : une seule ressource de chat

  • E-mails : une seule ressource d'e-mail

  • Menu : files d'attente auxquelles les agents sont affectés et auxquelles les utilisateurs finaux accèdent pour obtenir l'aide d'un agent.

  • Équipe : les équipes auxquelles appartient un agent

  • État de l'utilisateur : états individuels dans lesquels le widget d'agent peut se trouver

Authentification de base

Les requêtes utilisent l'authentification de base. Pour créer des identifiants API, procédez comme suit :

  1. Accédez au portail CCAI Platform.

  2. Accédez à Paramètres > Paramètres pour les développeurs > Identifiants de l'API.

  3. Ajoutez de nouveaux identifiants API et donnez-leur un nom.

Les identifiants pour les appels d'API sont les suivants :

  • Le sous-domaine est utilisé comme variable {username}.

  • Le jeton est utilisé comme variable {​password}.

Chaque installation possède son propre sous-domaine. Pour trouver le sous-domaine, recherchez l'URL dans votre navigateur. Le résultat doit ressembler à ceci :

https://customer.uc1.ccaiplatform.com

Remplacez le sous-domaine (customer dans cet exemple) par la variable \{subdomain\​}. Remplacez le reste de l'URL (rest.of.url.com dans cet exemple) par la variable \{domain\}.

URL de base

L'API utilise l'URL de base suivante pour toutes ses requêtes API :

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

où la mention /calls signifie https://{subdomain​}.​{domain​}/manager/api/v1/calls.

Limites de débit

Le système limite le débit des requêtes à 10 requêtes par seconde et par client.