Référence

Providers (numéros WhatsApp)

Un provider correspond à une instance WhatsApp (channel_providers) connectée à votre compte. Il doit être en statut connecté pour envoyer des messages.

Base URL : https://sandbox-api.reachflow.me/api/v1

Modèle de données

Champs

NomTypeDescription
idstring (uuid)Identifiant du channel_provider.
namestringNom affiché du numéro.
phoneNumberstring | nullNuméro WhatsApp connecté.
statusstringÉtat de connexion (ex. connected, disconnected).
warmupDayintegerJour de warm-up anti-ban (0–14).
riskScoreintegerScore de risque courant (0–100).
GET/api/v1/providers

Lister tous les providers

Retourne la liste des numéros WhatsApp de votre organisation accessibles via l’API.

Scope requis : providers:read

Requête

curl --request GET \
  --get "https://sandbox-api.reachflow.me/api/v1/providers" \
  --header "X-API-Key: rfl_live_VOTRE_CLE" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json"

Réponse

JSON
{
  "providers": [
    {
      "id": "a3f1b2c4-1234-4abc-9def-000011112222",
      "name": "Support client",
      "phoneNumber": "22997000000",
      "status": "connected",
      "warmupDay": 14,
      "riskScore": 12
    }
  ]
}
GET/api/v1/providers/{id}

Afficher un provider

Détail d’un provider avec statistiques journalières.

Scope requis : providers:read

Paramètres

NomTypeEmplacementDescription
id*string (uuid)pathIdentifiant du provider.

Requête

curl --request GET \
  --get "https://sandbox-api.reachflow.me/api/v1/providers/7f9e1234-abcd-4ef0-8765-aabbccddeeff" \
  --header "X-API-Key: rfl_live_VOTRE_CLE" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json"

Réponse

JSON
{
  "id": "a3f1b2c4-1234-4abc-9def-000011112222",
  "name": "Support client",
  "phoneNumber": "22997000000",
  "status": "connected",
  "warmupDay": 14,
  "riskScore": 12,
  "dailyStats": {
    "sent": 42,
    "delivered": 40,
    "failed": 2,
    "messagesLimit": 200,
    "newContactsLimit": 50
  }
}