Instances WhatsApp

Endpoints

Méthode	Endpoint	Description
`GET`	`/api/v1/instances`	Lister les instances de votre compte
`GET`	`/api/v1/instances/{id}`	Détail d’une instance
`GET`	`/api/v1/instances/{id}/state`	État live depuis le provider
`GET`	`/api/v1/instances/{id}/health`	Warmup / santé d’envoi de l’instance

Authentification : x-api-key: <api_key>

Qu’est-ce qu’une instance ?

Une instance est un numéro WhatsApp connecté à MsgFlash. Vous créez et connectez les instances depuis le dashboard. L’API publique permet ensuite de lire leur détail et leur état live.

États possibles

Statut	Description
`disconnected`	Instance existante mais non connectée
`connecting`	Connexion en cours
`connected`	Instance prête à envoyer

Lister les instances

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

Paramètres

Cette route n’accepte ni query params ni body.

Réponse succès

{
  "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"
    }
  ]
}

Utilisez data[].id comme vraie valeur instanceId dans /api/v1/messages/send, /api/v1/messages/schedule, /api/v1/campaigns et les autres endpoints d’envoi.

name et waNumber ne remplacent pas instanceId.

id = identifiant technique à envoyer à MsgFlash
name = libellé lisible pour l’utilisateur
waNumber = numéro connecté affiché à l’écran

Erreurs courantes

Code	HTTP	Quand
`UNAUTHORIZED`	401	Clé API manquante ou invalide
`API_RATE_LIMIT_EXCEEDED`	429	Plus de 10 req/s sur la même clé

Détail d’une instance

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

Paramètres path

Paramètre	Type	Requis	Description
`id`	UUID	oui	ID de l’instance

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

Erreurs courantes

Code	HTTP	Quand
`NOT_FOUND`	404	Instance inexistante ou hors de votre compte

État live

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

Paramètres path

Paramètre	Type	Requis	Description
`id`	UUID	oui	ID de l’instance

{
  "data": {
    "instanceId": "inst_uuid",
    "status": "connected",
    "providerState": "open"
  }
}

Erreurs courantes

Code	HTTP	Quand
`NOT_FOUND`	404	Instance inexistante ou hors de votre compte

Santé d’instance

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

Cette route retourne :

safetyState
safetyScore
warmupPolicy
usageWindowSummary
recommendations

La V1 du warmup renvoie de la guidance uniquement. Elle ne bloque pas encore directement les envois via cette route.

Webhooks Billing public

Pour commencer

Guides

Référence API · Équipes

Référence API · Instances

Référence API · Messages

Référence API · Campagnes

Référence API · Modèles

Référence API · Contacts

Référence API · Groupes

Référence API · Number lookups

Référence API · Webhooks

Référence API · Facturation

Ressources

Instances WhatsApp

Endpoints

Qu’est-ce qu’une instance ?

États possibles

Lister les instances

Paramètres

Réponse succès

Erreurs courantes

Détail d’une instance

Paramètres path

Erreurs courantes

État live

Paramètres path

Erreurs courantes

Santé d’instance

​Endpoints

​Qu’est-ce qu’une instance ?

​États possibles

​Lister les instances

​Paramètres

​Réponse succès

​Erreurs courantes

​Détail d’une instance

​Paramètres path

​Erreurs courantes

​État live

​Paramètres path

​Erreurs courantes

​Santé d’instance

Endpoints

Qu’est-ce qu’une instance ?

États possibles

Lister les instances

Paramètres

Réponse succès

Erreurs courantes

Détail d’une instance

Paramètres path

Erreurs courantes

État live

Paramètres path

Erreurs courantes

Santé d’instance