Gestion des Expéditeurs
Les expéditeurs (sender ID) sont les identifiants qui apparaissent comme expéditeur de vos messages SMS. Notre API REST vous permet de créer et gérer vos expéditeurs.
Fonctionnalités
- Création d’expéditeurs
- Liste des expéditeurs
- Détails des expéditeurs
- Gestion des statuts
- Personnalisation des communications
- Suivi des expéditeurs
Utilisation
Après avoir initialisé votre API, vous pouvez utiliser les endpoints suivants pour gérer vos expéditeurs.
Création d’un expéditeur
POST /v1/sender/create
Content-Type: application/json
{
"apiKey": "YOUR_API_KEY", // Required
"name": "MySender", // Required: Name of the sender ID
"description": "My custom sender ID for marketing campaigns" // Required: Description of the sender ID
}Réponse
{
"success": true,
"data": {
"id": "6828f5f79df4397112837d22",
"name": "MySender",
"description": "My custom sender ID for marketing campaigns",
"status": "PENDING",
"createdAt": "2025-05-17T20:47:51.320Z"
},
"error": null
}Liste des expéditeurs
POST /v1/sender/list
Content-Type: application/json
{
"apiKey": "YOUR_API_KEY", // Required
"sort": "asc", // Optional: "asc" | "desc"
"orderBy": "createdAt", // Optional: "name" | "createdAt"
"count": 10, // Optional: Number of items per page
"page": 1 // Optional: Page number
}Réponse
{
"success": true,
"data": [
{
"id": "6828f5f79df4397112837d22",
"name": "MySender",
"description": "My custom sender ID for marketing campaigns",
"status": "PENDING",
"createdAt": "2025-05-17T20:47:51.320Z"
}
],
"error": null,
"totalCount": 1,
"count": 1,
"page": 1,
"totalPage": 1
}Important : Le nom de l’expéditeur doit être entre 3 et 11 caractères et ne peut contenir que des caractères alphanumériques.
Toutes les réponses de l’API suivent le format standard : { success: boolean, data: any, error: any }.
Le champ data contient les données de la réponse, tandis que error contient les détails en cas d’erreur.
Liste des Messages d’un Expéditeur
POST /v1/sender/[id]/campaign // [id] est l'id de l'expéditeur
Content-Type: application/json
{
"apiKey": "YOUR_API_KEY", // Required
}Réponse
{
{
"success": true,
"data": [], // Liste des campagnes
"totalCount": 0,
"count": 0,
"error": null
}
}Documentation de l’API
POST /v1/sender/create
Crée un nouvel expéditeur avec les paramètres spécifiés.
| Nom | Description | Type | Facultatif | Valeur par défaut |
|---|---|---|---|---|
| apiKey | Clé API | String | Non | - |
| name | Nom de l’expéditeur | String | Non | - |
| description | Description de l’expéditeur | String | Non | - |
POST /v1/sender/list
Récupère la liste des expéditeurs avec pagination et tri.
| Nom | Description | Type | Facultatif | Valeur par défaut |
|---|---|---|---|---|
| apiKey | Clé API | String | Non | - |
| sort | Ordre de tri | ”asc” | “desc” | Oui | desc |
| orderBy | Champ de tri | ”name” | “createdAt” | Oui | createdAt |
| count | Nombre d’éléments par page | Number | Oui | 10 |
| page | Numéro de page | Number | Oui | 1 |
POST /v1/sender/[id]/campaign // [id] est l’id de l’expéditeur
Récupère la liste des campagnes d’un expéditeur.
| Nom | Description | Type | Facultatif | Valeur par défaut |
|---|---|---|---|---|
| apiKey | Clé API | String | Non | - |
Statuts possibles
- PENDING : En attente de validation
- SUBMITTED : Soumis pour validation
- ACCEPTED : Validé et actif
- REFUSED : Refusé
Exemple d’erreur
{
"success": false,
"data": null,
"error": "sender-not-found"
}Bonnes pratiques
- Nommage : Choisissez des noms clairs et professionnels
- Longueur : Respectez la limite de 3-11 caractères
- Caractères : Utilisez uniquement des caractères alphanumériques
- Sécurité : Protégez votre clé API
- Validation : Vérifiez le statut de vos expéditeurs
- Backup : Gardez plusieurs expéditeurs actifs
- Monitoring : Surveillez les taux de livraison
- Conformité : Respectez les règles d’envoi
Cas d’utilisation
- Communications marketing
- Notifications clients
- Alertes et rappels
- Service client
- Communications internes
- Rappels de rendez-vous
- Alertes de sécurité
FAQ
Comment créer un expéditeur ?
Utilisez l’endpoint /v1/sender/create avec les paramètres requis.
Quelles sont les règles de nommage ?
Le nom doit être entre 3 et 11 caractères et ne peut contenir que des caractères alphanumériques.
Comment lister mes expéditeurs ?
Utilisez l’endpoint /v1/sender/list pour obtenir la liste de vos expéditeurs.
Comment lister les campagnes d’un expéditeur ?
Utilisez l’endpoint /v1/sender/[id]/campaign pour obtenir la liste des campagnes associées à un expéditeur spécifique.
Comment vérifier le statut ?
Le statut est inclus dans la réponse de création et de liste.
Combien d’expéditeurs puis-je avoir ?
Le nombre d’expéditeurs dépend de votre forfait. Contactez-nous pour plus d’informations.
Comment modifier un expéditeur ?
Les expéditeurs ne peuvent pas être modifiés une fois créés. Créez-en un nouveau si nécessaire.