Gestion des Groupes SMS

La gestion des groupes est une fonctionnalité essentielle pour organiser efficacement vos contacts et optimiser vos campagnes SMS. Notre SDK vous permet de créer, mettre à jour et gérer facilement vos groupes de contacts, facilitant ainsi l’envoi de messages ciblés à vos destinataires.

Structure des groupes

Chaque groupe dans votre système suit une structure standardisée :


type Group = {
  name: string; // Nom du groupe
  description?: string; // Description du groupe (optionnel)
  contacts: Array<{
    id?: string; // Identifiant du contact if exists
    phone: string; // Numéro de téléphone
    name?: string; // Nom complet (optionnel)
    firstName?: string; // Prénom (optionnel)
    lastName?: string; // Nom de famille (optionnel)
    sex?: "M" | "F"; // Genre (optionnel)
  }>;
};

Fonctionnalités

Création de groupes avec description
Ajout de contacts existants aux groupes
Liste complète des groupes
Récupération des détails d’un groupe spécifique
Organisation des contacts par catégories

Utilisation

Après avoir initialisé votre bibliothèque, vous pouvez utiliser la propriété group pour gérer vos groupes.

Création d’un groupe

/api/group


import { sms } from "@/libs/sms";
 
const createGroup = async () => {
  try {
    const res = await sms.group.create({
      name: "Clients Premium",
      description: "Groupe des clients premium avec abonnement actif",
      contacts: [
        {
          phone: "22500000000",
          name: "John Doe",
        },
        {
          id: "contact_2",
          phone: "22500000001",
          name: "Jane Doe",
          firstName: "Jane",
          lastName: "Doe",
        },
      ],
    });
 
    console.log(res);
  } catch (error) {
    console.error(error);
  }
};

Liste des groupes

/api/group/list


import { sms } from "@/libs/sms";
 
const listGroups = async () => {
  try {
    const res = await sms.group.list();
 
    console.log(res);
  } catch (error) {
    console.error(error);
  }
};

Détails d’un groupe

/api/group/details


import { sms } from "@/libs/sms";
 
const getGroupDetails = async () => {
  try {
    const res = await sms.group.get({
      id: "group_id",
    });
 
    console.log(res);
  } catch (error) {
    console.error(error);
  }
};

Suppression d’un groupe

/api/group/delete


import { sms } from "@/libs/sms";
 
const deleteGroup = async () => {
  try {
    const res = await sms.group.delete({
      id: "group_id",
    });
 
    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 groupes : create pour la création, list pour la liste, get pour les détails et delete pour la suppression.

Le companyId est automatiquement injecté depuis la configuration du SDK. Vous n’avez pas besoin de le passer manuellement dans les appels de méthodes.

Documentation de l’API

sms.group.create

Crée un nouveau groupe de contacts.

Nom	Description	Type	Facultatif
name	Nom du groupe	Texte	Non
description	Description du groupe	Texte	Oui
contacts	Liste des contacts du groupe	Array de Contact Object	Non

sms.group.list

Récupère la liste de tous vos groupes.

Nom	Description	Type	Facultatif	Valeur par défaut
orderBy	Critère de tri	”name” \| “createdAt”	Oui	createdAt
page	Numéro de page	Nombre	Oui	1
limit	Nombre d’éléments par page	Nombre	Oui	10

sms.group.get

Récupère les détails d’un groupe spécifique.

Nom	Description	Type	Facultatif	Valeur par défaut
id	Identifiant du groupe	Texte	Non

sms.group.delete

Supprime un groupe spécifique.

Nom	Description	Type	Facultatif	Valeur par défaut
id	Identifiant du groupe à supprimer	Texte	Non

Bonnes pratiques

Nommage : Utilisez des noms de groupes clairs et descriptifs
Description : Ajoutez des descriptions détaillées pour faciliter l’organisation
Contacts : Vérifiez que les contacts existent avant de les ajouter
Organisation : Créez une structure logique de groupes
Maintenance : Mettez régulièrement à jour vos groupes

Cas d’utilisation

Segmentation des clients
Campagnes marketing ciblées
Notifications par catégorie
Service client personnalisé
Rappels et alertes spécifiques
Gestion des abonnements
Communication interne