AccueilDocumentationPour Commencer

Pour Commencer

Authentifiez-vous et effectuez votre premier appel API en moins de 5 minutes.

Introduction

InboundFlow propose une API REST et des Webhooks en temps réel pour intégrer vos données d'assistant vocal IA à n'importe quel système. Utilisez l'API pour extraire des appels, des contacts, des prospects et des rendez-vous. Utilisez les webhooks pour recevoir des notifications en temps réel lorsque des événements se produisent.

URL de Base

https://api.inboundflow.app

Authentification

Toutes les requêtes API nécessitent une clé API dans l'en-tête Authorization :

Header
Authorization: Bearer sk_live_your_key_here

Comment obtenir votre clé API

  1. Connectez-vous à votre tableau de bord InboundFlow sur secure.inboundflow.app
  2. Allez dans Paramètres → API (Settings → API)
  3. Cliquez sur "Générer la Clé API"
  4. Copiez et stockez votre clé en toute sécurité — elle ne sera plus affichée

Remarque : Les clés API sont limitées à votre organisation. Toutes les données renvoyées sont limitées uniquement à votre organisation.

Limites de Temps

  • 60 requêtes par minute par clé API
  • En-têtes de limite de taux inclus dans chaque réponse :
Response Headers
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58

Pagination

Les points de terminaison de liste prennent en charge la pagination basée sur les curseurs :

  • limit — résultats par page (défaut : 50, max : 100)
  • cursor — curseur pour la page suivante (à partir de next_cursor dans la réponse)
  • since — ISO datetime, ne retourner que les enregistrements créés après cette heure

Format de Réponse

Toutes les réponses suivent un format constant :

JSON
{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-24T00:00:00Z"
  }
}

Les points de terminaison de liste incluent des infos sur la pagination :

JSON
{
  "data": [...],
  "has_more": true,
  "next_cursor": "eyJjcmVhdGVkX2F0Ijo...",
  "meta": { ... }
}

Démarrage Rapide : Obtenez vos Appels Récents

cURL
curl -X GET   "https://api.inboundflow.app/v1/calls?limit=5"   -H "Authorization: Bearer sk_live_your_key_here"   -H "Content-Type: application/json"

Réponse

JSON
{
  "data": [
    {
      "id": "uuid",
      "caller_phone": "+1234567890",
      "caller_name": "Dave",
      "status": "completed",
      "duration_seconds": 55,
      "summary": "Called about auto repair appointment...",
      "started_at": "2026-02-24T20:59:00Z",
      "ended_at": "2026-02-24T21:00:00Z",
      "recording_url": "https://..."
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "meta": {
    "request_id": "req_abc123def456",
    "timestamp": "2026-02-24T00:00:00Z"
  }
}

Démarrage Rapide : Obtenez vos Contacts

cURL
curl -X GET   "https://api.inboundflow.app/v1/contacts?limit=5"   -H "Authorization: Bearer sk_live_your_key_here"

Gestion des Erreurs

Toutes les erreurs renvoient un format JSON cohérent :

JSON
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key",
    "status": 401
  },
  "meta": {
    "request_id": "req_abc123def456",
    "timestamp": "2026-02-24T00:00:00Z"
  }
}

Codes d'Erreur

CodeSignification
401unauthorized
Clé API manquante, invalide, révoquée ou expirée
400bad_request
Paramètres invalides ou champs obligatoires manquants
404not_found
Ressource non trouvée
429rate_limited
Limite de taux dépassée (vérifiez l'en-tête Retry-After)
500internal_error
Erreur Serveur

Prochaines Étapes