Référence API REST
L'API Cortex Voice est une API REST standard utilisant JSON pour toutes les requêtes et réponses. L'authentification se fait via une clé API transmise dans l'en-tête HTTP.
URL de base : https://api.comulead.com/v1
En-tête requis : Authorization: Bearer VOTRE_CLE_API
Format : Content-Type: application/json
| Endpoint | Méthode | Description |
|---|---|---|
/surveys | GET | Lister toutes les enquêtes du compte |
/surveys/{id} | GET | Détails d'une enquête spécifique |
/surveys/{id}/responses | GET | Toutes les réponses d'une enquête |
/responses/{id} | GET | Détails d'une réponse (score + verbatim + thèmes) |
/contacts | POST | Ajouter ou mettre à jour des contacts |
/reports/nps | GET | Score NPS agrégé sur une période |
La documentation API complète avec exemples de requêtes et réponses est disponible à api.comulead.com/docs. Vous pouvez tester chaque endpoint directement depuis l'interface en vous authentifiant avec votre clé API de test (environnement sandbox).
Modèles CSV téléchargeables
Cortex Voice accepte les fichiers CSV pour l'import de contacts et l'envoi d'enquêtes en masse. Utilisez les modèles officiels pour éviter les erreurs de format.
| Modèle | Colonnes requises | Colonnes optionnelles |
|---|---|---|
| Import contacts standard | email | prenom · nom · entreprise |
| Import contacts enrichi | email | prenom · segment · date_achat · produit |
| Import contacts CRM | email · crm_id | prenom · responsable · valeur_contrat |
Dans Cortex Voice → Enquêtes → Nouvelle enquête → Étape Diffusion → Canal Courriel → cliquez sur Télécharger le modèle CSV. Le fichier s'ouvre directement dans Excel ou Google Sheets.
Respectez ces règles pour éviter les erreurs d'import :
- Encodage UTF-8 obligatoire (accents et caractères spéciaux québécois)
- Séparateur : virgule (
,) — pas de point-virgule - Première ligne = en-têtes de colonnes (noms exacts du modèle)
- Pas de lignes vides ni de colonnes fusionnées
- Adresses courriel en minuscules, format
nom@domaine.com
Excel sur Windows enregistre parfois en encodage ANSI par défaut, ce qui corrompt les accents (é, è, à, ç). Pour forcer l'UTF-8 dans Excel : Fichier → Enregistrer sous → Type : CSV UTF-8 (délimité par des virgules). Dans Google Sheets, l'export CSV est toujours en UTF-8.
Bibliothèque de modèles d'enquêtes
Cortex Voice propose des modèles prêts à l'emploi pour les cas d'usage les plus courants en PME québécoise.
| Modèle | Usage | Nb questions |
|---|---|---|
| NPS Relationnel Standard | Programme trimestriel, satisfaction globale | 2 |
| NPS Post-achat | Déclenché 48h après transaction | 3 |
| NPS Onboarding | 30 jours après activation du service | 3 |
| NPS Renouvellement | 45 jours avant l'échéance du contrat | 4 |
| NPS Support | Après résolution d'un ticket support | 3 |
Ressources téléchargeables
Ces ressources sont disponibles dans Cortex Voice → Ressources (menu latéral bas) :
- Guide de démarrage rapide (PDF, 8 pages) — Synthèse des 5 premières étapes en format imprimable
- Tableau de suivi NPS (Google Sheets) — Template de suivi mensuel avec formules et graphiques automatiques
- Modèles de courriels de suivi (DOCX) — 6 templates pour répondre aux détracteurs, neutres et promoteurs
- Checklist conformité Loi 25 (PDF) — 10 points de vérification pour vos enquêtes et vos données
- Glossaire NPS & CX (PDF) — 35 définitions clés pour partager la culture NPS avec votre équipe
Limites et quotas de l'API
| Limite | Valeur | Réinitialisation |
|---|---|---|
| Requêtes API | 1 000 / heure | Toutes les heures |
| Import contacts | 5 000 par fichier | Par import |
| Envois courriel | 10 000 / jour | Minuit HNE |
| Webhooks actifs | 10 par compte | Permanent |
| Rétention des données | 24 mois glissants | Mensuelle |
Si votre usage dépasse ces quotas, contactez support@comulead.com pour discuter d'un plan adapté. Les limites d'envoi courriel peuvent être augmentées sur demande après vérification de la délivrabilité de votre domaine.
Ce qu'il faut retenir
- L'API REST est documentée en mode interactif à
api.comulead.com/docs— testez chaque endpoint en sandbox - Utilisez toujours le modèle CSV officiel et exportez en UTF-8 pour éviter la corruption des accents
- 5 modèles d'enquêtes prêts à l'emploi couvrent les cas d'usage PME les plus courants
- Les ressources téléchargeables (templates, checklist Loi 25, glossaire) sont dans le menu Ressources de Cortex Voice
- Limite de 1 000 requêtes API par heure — utilisez la pagination pour les exports de données volumineuses
