Skip to Content
Votre documentation est en cours de développement.
BibliothèquesJavaScriptGestion des Contacts 👥

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

/api/contact
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.

NomDescriptionTypeFacultatifValeur par défaut
phoneNuméro de téléphone du contactTexteNon
nameNom complet du contactTexteNon
firstNamePrénom du contactTexteOui
lastNameNom de famille du contactTexteOui
sexGenre du contact”M”, “F”OuiM

sms.contact.delete

Supprime un ou plusieurs contacts de votre carnet d’adresses.

NomDescriptionTypeFacultatifValeur par défaut
contactIdsListe des identifiants des contacts à supprimerArray de TexteNon

sms.contact.update

Met à jour les informations d’un contact existant.

NomDescriptionTypeFacultatifValeur par défaut
nameNom complet du contactTexteOui
firstNamePrénom du contactTexteOui
lastNameNom de famille du contactTexteOui
phoneNuméro de téléphone du contactTexteOui
sexGenre du contact”M”, “F”OuiM

sms.contact.list

Récupère la liste complète de tous vos contacts.
Cette méthode ne reçoit aucun argument.

Bonnes pratiques

  1. Format des numéros : Utilisez toujours le format international sans le ”+”
  2. Données complètes : Remplissez autant d’informations que possible pour chaque contact
  3. Mise à jour régulière : Maintenez vos contacts à jour pour des campagnes plus efficaces
  4. Vérification : Validez les numéros avant de les ajouter
  5. 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
Last updated on