Passer au contenu principal

​
Endpoint

GET /api/v1/instances

​
Authentification

x-api-key: <api_key>

​
Paramètres

Aucun paramètre path, query ou body.

​
Exemple de requête

curl https://srv.msgflash.com/api/v1/instances \
  -H "x-api-key: msgf_live_your_api_key_here"

​
Réponse succès 200

{
  "data": [
    {
      "id": "inst_uuid",
      "name": "boutique-principale",
      "waNumber": "+33612345678",
      "status": "connected",
      "webhook": null,
      "meta": null,
      "deletedAt": null,
      "createdAt": "2026-04-01T09:00:00.000Z",
      "updatedAt": "2026-04-01T09:10:00.000Z"
    }
  ]
}

​
Comment obtenir le bon instanceId

Pour tous les endpoints d’envoi MsgFlash, vous devez utiliser instanceId. Différence entre les champs :
ChampUsage
idIdentifiant technique à envoyer comme instanceId dans l’API
nameNom lisible pour l’utilisateur, utile pour l’UI
waNumberNuméro WhatsApp connecté, utile pour affichage/contrôle
Flow recommandé :
  1. appeler GET /api/v1/instances
  2. choisir une instance avec status = "connected"
  3. récupérer data[n].id
  4. utiliser cette valeur comme instanceId dans :
    • POST /api/v1/messages/send
    • POST /api/v1/messages/schedule
    • POST /api/v1/campaigns

​
Erreurs courantes

HTTPCodeQuand
401UNAUTHORIZEDClé API absente ou invalide
429API_RATE_LIMIT_EXCEEDEDTrop de requêtes par seconde