Gestion des Contacts

Les contacts sont les destinataires de vos campagnes SMS. Notre API REST vous permet de gérer facilement votre carnet d’adresses avec des fonctionnalités complètes de création, listing et suppression.

Fonctionnalités

• Création de contacts
• Listing des contacts
• Suppression de contacts
• Détails des contacts
• Gestion des informations personnelles
• Support multilingue (nom, prénom, etc.)

Utilisation

Après avoir initialisé votre API, vous pouvez utiliser les endpoints suivants pour gérer vos contacts.

Création d’un contact

POST /v1/contact/create
Content-Type: application/json
 
{
  "apiKey": "YOUR_API_KEY",
  "contacts": [
      {
          "name": "Freddy Dro", // Optional: Name of the contact
          "phone": "2250708517414", // Required: Phone number of the contact
          "sex": "M" // Optional: Sex of the contact
      },
      {
          "phone": "2250505050505", // Required: Phone number of the contact
      },
  ]
}

Réponse

{
  "success": true,
  "data": [
    {
      "id": "6829f8169df4397112837d23",
      "name": "Freddy Dro",
      "firstName": null,
      "lastName": null,
      "phone": "2250708517414",
      "sex": "M",
      "createdAt": "2025-05-18T15:09:10.032Z"
    },
    {
      "id": "6829f8169df4397112837d24",
      "name": "2250505050505",
      "firstName": null,
      "lastName": null,
      "phone": "2250505050505",
      "sex": null,
      "createdAt": "2025-05-18T15:09:10.292Z"
    }
  ],
  "error": null
}

Liste des contacts

POST /v1/contact/list
Content-Type: application/json
 
{
  "apiKey": "YOUR_API_KEY",
}

Réponse

{
  "success": true,
  "data": [
    {
      "id": "6829f8169df4397112837d24",
      "name": "2250505050505",
      "firstName": null,
      "lastName": null,
      "phone": "2250505050505",
      "sex": null,
      "createdAt": "2025-05-18T15:09:10.292Z"
    },
    {
      "id": "6829f8169df4397112837d23",
      "name": "Freddy Dro",
      "firstName": null,
      "lastName": null,
      "phone": "2250708517414",
      "sex": "M",
      "createdAt": "2025-05-18T15:09:10.032Z"
    }
  ],
  "totalCount": 2,
  "count": 2,
  "page": 1,
  "totalPage": 1
}

Détails d’un contact

POST /v1/contact/[id] // [id] est l'id du contact
Content-Type: application/json
 
{
  "apiKey": "YOUR_API_KEY",
  "id": "6829f8169df4397112837d24"
}

Réponse

{
  "success": true,
  "data": {
    "id": "6829f8169df4397112837d24",
    "name": "2250505050505",
    "firstName": null,
    "lastName": null,
    "phone": "2250505050505",
    "sex": null,
    "createdAt": "2025-05-18T15:09:10.292Z"
  }
}

Modification d’un contact

POST /v1/contact/[id]/update // [id] est l'id du contact
Content-Type: application/json
 
{
  "apiKey": "YOUR_API_KEY",
  "firstName": "John",
  "lastName": "Doe",
  "sex": "M"
}

Réponse

{
  "success": true,
  "data": {
    "id": "6829f8169df4397112837d24",
    "name": "John Doe",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "2250505050505",
    "sex": "M",
    "updatedAt": "2025-05-18T15:09:10.292Z"
  }
}

Suppression d’un contact ou de plusieurs contacts

POST /v1/contact/delete
Content-Type: application/json
 
{
  "apiKey": "YOUR_API_KEY",
  "contactsIds": ["6829f8169df4397112837d24", "6829f8169df4397112837d23"]
}

Réponse

{
  "success": true,
  "data": {
    "count": 2
  }
}

Documentation de l’API

POST /v1/contact/create

Crée un nouveau contact avec les informations spécifiées.

Structure d’un contact

POST /v1/contact/list

Récupère la liste des contacts avec pagination et tri.

POST /v1/contact/[id]

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

POST /v1/contact/[id]/update

Modifie les informations d’un contact existant.

POST /v1/contact/delete

Supprime un ou plusieurs contacts.

Bonnes pratiques

1. Numéros de téléphone : Utilisez toujours le format international sans le symbole +. Le numéro de téléphone est le seul champ obligatoire pour créer un contact.
2. Informations personnelles : Utilisez les champs firstName et lastName pour une meilleure organisation des contacts.
3. Nom complet : Le champ name est optionnel et peut être utilisé comme alias ou nom d’affichage.
4. Genre : Utilisez le champ sex avec les valeurs “M” ou “F” pour une meilleure segmentation.
5. Validation : Vérifiez la validité des numéros de téléphone avant l’envoi.
6. Doublons : Le système vérifie automatiquement les doublons basés sur le numéro de téléphone.
7. Sécurité : Protégez les informations personnelles de vos contacts.
8. Mise à jour : Maintenez vos contacts à jour en utilisant l’endpoint de mise à jour.

Cas d’utilisation

• Gestion de carnet d’adresses avec informations personnelles complètes
• Segmentation de clientèle par genre et nom
• Campagnes marketing personnalisées
• Notifications clients avec nom personnalisé
• Service client avec historique des contacts
• Rappels et alertes nominatifs
• Communications internes avec profils complets

FAQ

Quels sont les champs obligatoires pour créer un contact ?

Seul le numéro de téléphone (phone) est obligatoire. Tous les autres champs (name, firstName, lastName, sex) sont optionnels.

Comment formater les numéros de téléphone ?

Les numéros doivent être au format international sans le symbole +. Exemple : “22500000000” pour un numéro ivoirien.

Puis-je importer des contacts en masse ?

Oui, vous pouvez créer plusieurs contacts en une seule requête en utilisant un tableau de contacts. Chaque contact doit avoir au minimum un numéro de téléphone.

Comment gérer les doublons ?

Le système vérifie automatiquement les doublons basés sur le numéro de téléphone. Si un contact existe déjà, il sera mis à jour avec les nouvelles informations.

Comment mettre à jour les informations d’un contact ?

Utilisez l’endpoint /v1/contact/[id]/update avec les champs que vous souhaitez modifier (name, firstName, lastName, sex).

Comment supprimer un contact ?

Utilisez l’endpoint /v1/contact/delete avec l’ID du contact à supprimer.

Comment récupérer les détails d’un contact ?

Utilisez l’endpoint /v1/contact/[id] avec l’ID du contact pour obtenir ses informations complètes, y compris tous les champs personnels.

Référence API Interactive