Gestion des Groupes de Contacts SMS
Les groupes vous permettent d’organiser efficacement vos contacts pour optimiser l’envoi de campagnes SMS ciblées. Notre API REST offre des fonctionnalités complètes pour créer, modifier et gérer vos groupes de contacts, facilitant ainsi la segmentation de votre clientèle et l’organisation de vos campagnes SMS.
Fonctionnalités Principales
- Création et gestion de groupes de contacts
- Organisation hiérarchique des contacts
- Segmentation précise de la clientèle
- Gestion des campagnes SMS par groupe
- Modification et mise à jour des groupes
- Suppression sécurisée des groupes
- Pagination et tri des listes de groupes
Guide d’Utilisation
Après avoir initialisé votre API, vous pouvez utiliser les endpoints suivants pour gérer vos groupes de contacts SMS.
Création d’un groupe
POST /v1/group/create
Content-Type: application/json
{
"apiKey": "YOUR_API_KEY",
"name": "Clients Premium",
"description": "Groupe des clients premium",
"contactIds": ["id_contact_1", "id_contact_2"] // id_contact_1 et id_contact_2 sont les ids des contacts à ajouter au groupe
}Réponse
{
"success": true,
"data": {
"id": "6829f8169df4397112837d24",
"name": "Clients Premium",
"description": "Groupe des clients premium"
}
}Liste des groupes
POST /v1/group/list
Content-Type: application/json
{
"apiKey": "YOUR_API_KEY",
}Réponse
{
"success": true,
"data": [
{
"id": "6829f8169df4397112837d24",
"name": "Clients Premium",
"description": "Groupe des clients premium"
}
]
}Détails d’un groupe
POST /v1/group/[id]
Content-Type: application/json
{
"apiKey": "YOUR_API_KEY",
}Réponse
{
"success": true,
"data": {
"id": "6829f8169df4397112837d24",
"name": "Clients Premium",
"description": "Groupe des clients premium"
}
}Modification d’un groupe
POST /v1/group/[id]/update
Content-Type: application/json
{
"apiKey": "YOUR_API_KEY",
"name": "Nouveau nom du groupe", // Optionnel
"description": "Nouvelle description du groupe", // Optionnel
"contactIds": ["id_contact_1", "id_contact_2"] // Optionnel
}Réponse
{
"success": true,
"data": {
"id": "6829f8169df4397112837d24",
"name": "Nouveau nom du groupe",
"description": "Nouvelle description du groupe"
}
}Suppression d’un groupe
POST /v1/group/[id]/delete
Content-Type: application/json
{
"apiKey": "YOUR_API_KEY",
}Réponse
{
"success": true,
"data": {
"count": 1
}
}Documentation de l’API
POST /v1/group/create
Crée un nouveau groupe avec les contacts spécifiés.
| Nom | Description | Type | Facultatif | Valeur par défaut |
|---|---|---|---|---|
| apiKey | Clé API | String | Non | - |
| name | Nom du groupe | String | Non | - |
| description | Description du groupe | String | Oui | |
| contactIds | Liste des contacts | Array of String | Oui | [] |
Structure d’un groupe
{
"id": "string", // Identifiant unique du groupe
"name": "string", // Nom du groupe
"description": "string | null", // Description du groupe (peut être null)
"createdAt": "Date" // Date de création du groupe
}POST /v1/group/list
Récupère la liste des groupes avec pagination et tri.
| Nom | Description | Type | Facultatif | Valeur par défaut |
|---|---|---|---|---|
| apiKey | Clé API | String | Non | - |
| orderBy | Champ de tri | ”name” | “createdAt” | Oui | createdAt |
| page | Numéro de page | Number | Oui | 1 |
| limit | Nombre d’éléments par page | Number | Oui | 10 |
POST /v1/group/[id]/update
Modifie les informations d’un groupe existant.
| Nom | Description | Type | Facultatif | Valeur par défaut |
|---|---|---|---|---|
| apiKey | Clé API | String | Non | - |
| name | Nouveau nom du groupe | String | Oui | - |
| description | Nouvelle description du groupe | String | Oui | - |
| contactIds | Nouvelle liste des contacts | Array of String | Oui | - |
POST /v1/group/[id]/delete
Supprime un groupe existant.
| Nom | Description | Type | Facultatif | Valeur par défaut |
|---|---|---|---|---|
| apiKey | Clé API | String | Non | - |
Bonnes Pratiques pour la Gestion des Groupes
- Nommage : Utilisez des noms de groupes clairs, descriptifs et cohérents
- Organisation : Créez une structure logique et hiérarchique de groupes
- Description : Ajoutez des descriptions détaillées pour chaque groupe
- Contacts : Vérifiez et validez les contacts avant de les ajouter
- Mise à jour : Maintenez vos groupes à jour régulièrement
- Sécurité : Protégez les informations sensibles des groupes
- Archivage : Archivez les groupes inactifs pour maintenir la clarté
- Documentation : Documentez la structure et l’utilisation de vos groupes
Cas d’Utilisation Avancés
- Segmentation précise de la clientèle par catégorie
- Campagnes marketing SMS ciblées et personnalisées
- Notifications par catégorie de clients
- Gestion de projets avec notifications par groupe
- Communications internes organisées
- Service client segmenté
- Rappels et alertes par catégorie
- Analyse de performance par groupe
FAQ sur la Gestion des Groupes
Comment créer un groupe de contacts SMS ?
Utilisez l’endpoint /v1/group/create avec un nom et une description. Vous pouvez optionnellement ajouter des contacts en spécifiant leurs IDs dans le tableau contactIds.
Quels sont les champs obligatoires pour créer un groupe ?
Le nom (name) est le seul champ obligatoire. La description et la liste des contacts sont optionnels.
Comment lister mes groupes ?
Utilisez l’endpoint /v1/group/list. Vous pouvez paginer les résultats et les trier par nom ou date de création.
Comment obtenir les détails d’un groupe ?
Utilisez l’endpoint /v1/group/[id] avec l’ID du groupe pour obtenir toutes ses informations, y compris la liste des contacts.
Comment modifier un groupe ?
Utilisez l’endpoint /v1/group/[id]/update pour modifier le nom, la description ou la liste des contacts.
Comment supprimer un groupe ?
Utilisez l’endpoint /v1/group/[id]/delete. Attention, cette action est irréversible.
Puis-je avoir des groupes sans contacts ?
Oui, vous pouvez créer des groupes vides et ajouter des contacts plus tard via l’endpoint de mise à jour.
Y a-t-il une limite au nombre de contacts par groupe ?
Non, vous pouvez ajouter autant de contacts que nécessaire dans un groupe.