Gestion des Contacts SMS
La gestion des contacts est une fonctionnalité essentielle pour organiser efficacement vos campagnes SMS. Notre SDK vous permet de créer, mettre à jour et gérer facilement votre carnet d’adresses SMS, facilitant ainsi l’envoi de messages à vos destinataires.
Structure des contacts
Chaque contact dans votre carnet d’adresses suit une structure standardisée :
type Contact = {
phone: string; // Numéro de téléphone
name: string; // Nom complet
firstName?: string; // Prénom (optionnel)
lastName?: string; // Nom de famille (optionnel)
sex: "M" | "F"; // Genre
};
Important : Incluez l’indicatif du pays sans le symbole (+) avant le numéro de téléphone. Exemple : “22500000000” pour un numéro ivoirien.
Fonctionnalités
- Création de contacts individuels ou en masse
- Mise à jour des informations de contact
- Suppression de contacts
- Liste complète des contacts
- Gestion des informations détaillées (nom, prénom, genre)
Utilisation
Après avoir initialisé votre bibliothèque, vous pouvez utiliser la propriété contact
pour gérer vos contacts.
Création de contacts
import { sms } from "@/libs/sms";
const createContact = async () => {
try {
const res = await sms.contact.create({
contacts: [
{ phone: "22500000000", name: "John Doe" },
{ phone: "22500000001", name: "Jane Doe" },
],
});
console.log(res);
} catch (error) {
console.error(error);
}
};
const listContacts = async () => {
try {
const res = await sms.contact.list();
console.log(res);
} catch (error) {
console.error(error);
}
};
const deleteContact = async () => {
try {
const res = await sms.contact.delete({
contactIds: ["contact_id_1", "contact_id_2"],
});
console.log(res);
} catch (error) {
console.error(error);
}
};
const updateContact = async () => {
try {
const res = await sms.contact.update({
phone: "2250000000000",
});
console.log(res);
} catch (error) {
console.error(error);
}
};
La variable sms
est l’instance initialisée de notre SDK. Elle fournit quatre
méthodes principales pour la gestion des contacts : create
pour la création,
list
pour la liste, update
pour la mise à jour et delete
pour la
suppression.
Documentation de l’API
sms.contact.create
Crée un ou plusieurs nouveaux contacts dans votre carnet d’adresses.
Nom | Description | Type | Facultatif | Valeur par défaut |
---|---|---|---|---|
phone | Numéro de téléphone du contact | Texte | Non | |
name | Nom complet du contact | Texte | Non | |
firstName | Prénom du contact | Texte | Oui | |
lastName | Nom de famille du contact | Texte | Oui | |
sex | Genre du contact | ”M”, “F” | Oui | M |
sms.contact.delete
Supprime un ou plusieurs contacts de votre carnet d’adresses.
Nom | Description | Type | Facultatif | Valeur par défaut |
---|---|---|---|---|
contactIds | Liste des identifiants des contacts à supprimer | Array de Texte | Non |
sms.contact.update
Met à jour les informations d’un contact existant.
Nom | Description | Type | Facultatif | Valeur par défaut |
---|---|---|---|---|
name | Nom complet du contact | Texte | Oui | |
firstName | Prénom du contact | Texte | Oui | |
lastName | Nom de famille du contact | Texte | Oui | |
phone | Numéro de téléphone du contact | Texte | Oui | |
sex | Genre du contact | ”M”, “F” | Oui | M |
sms.contact.list
Récupère la liste complète de tous vos contacts.
Cette méthode ne reçoit aucun argument.
Bonnes pratiques
- Format des numéros : Utilisez toujours le format international sans le ”+”
- Données complètes : Remplissez autant d’informations que possible pour chaque contact
- Mise à jour régulière : Maintenez vos contacts à jour pour des campagnes plus efficaces
- Vérification : Validez les numéros avant de les ajouter
- Organisation : Utilisez des noms cohérents pour faciliter la recherche
Cas d’utilisation
- Gestion de listes de diffusion
- Campagnes marketing ciblées
- Notifications clients
- Service client
- Rappels et alertes