API Apps

Contact Center AI Platform (CCAI Platform) fournit des points de terminaison d'API pour prendre en charge l'intégration à la plate-forme. L'API Apps étend les fonctionnalités des canaux compatibles avec la plate-forme, y compris les appels, les discussions et les SMS. Les points de terminaison sont regroupés dans les catégories suivantes :

Authentification de base

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

  1. Accédez au portail CCAI Platform.

  2. Accédez à Settings > Developer Settings > API Credentials (Paramètres > Paramètres pour les développeurs > Identifiants d'API).

  3. Ajoutez des identifiants d'API et fournissez 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 d'API.

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

où une mention de /calls signifie https://{subdomain​}.​{domain​}/apps/api/v1/calls.

Limites de débit

Le système limite les requêtes à un débit de 10 requêtes par seconde et par client.

Attendez-vous à des clés JSON non reconnues dans les réponses de l'API

Toutes les mises à jour de l'API sont rétrocompatibles. Nous nous réservons le droit d'introduire de nouvelles clés JSON dans les réponses d'API existantes à tout moment. Nous vous recommandons de gérer les réponses de manière défensive en ignorant toutes les clés non reconnues afin de maintenir la fonctionnalité.