Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://help.withallo.com/llms.txt

Use this file to discover all available pages before exploring further.

L’API Allo permet aux developpeurs d’integrer directement les capacites de communication d’Allo dans leurs applications. Creez des integrations CRM, automatisez les workflows post-appel, synchronisez les donnees de conversation et alimentez des agents IA avec l’historique des appels et SMS de votre equipe.

​
Pour commencer

Avant d’utiliser l’API, assurez-vous d’avoir :
  • Un abonnement Allo actif
  • Les permissions Admin ou Manager sur votre workspace
  • Une API key generee depuis Parametres > API

​
Documentation de l’API

Authentification

Configuration des API keys et scopes

Rate limits

Limites de requetes et headers

Pagination

Resultats pagines avec totaux

Gestion des erreurs

Format des erreurs et resolution

​
Fonctionnalites principales

L’API donne acces a :
  • Conversations — consultez l’historique des appels et SMS dans une timeline unifiee, avec recherche par mots-cles dans les transcriptions et le contenu des messages
  • Webhooks — recevez des notifications en temps reel lorsque des appels se terminent, des messages arrivent, des tags sont ajoutes et des contacts changent
  • Numeros de telephone — listez vos numeros Allo avec leurs capacites, le statut du sender ID et les acces des membres
  • Utilisateurs — accedez a la liste de votre equipe avec les roles et les numeros assignes
  • Tags — decouvrez les tags d’appels disponibles pour le filtrage et le reporting

​
Authentification

Les API keys sont generees depuis les parametres de votre workspace. Incluez la cle dans le header Authorization de chaque requete : 
curl -X GET "https://api.withallo.com/v2/api/conversations" \
  -H "Authorization: Api-Key ak_live_your_key_here"
Stockez votre API key de maniere securisee. Ne l’exposez pas dans du code cote client ou des depots publics.

​
Rate limiting

Les rate limits varient selon le type de requete :
OperationLimite
Requetes de lecture (GET)20 requetes/seconde
Requetes d’ecriture (POST, PUT, PATCH, DELETE)5 requetes/seconde
Chaque reponse inclut les headers X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset pour que vous puissiez surveiller votre utilisation. Voir Rate limits pour les details.

​
Exemple rapide

Obtenez vos conversations recentes : 
curl -X GET "https://api.withallo.com/v2/api/conversations?size=5" \
  -H "Authorization: Api-Key ak_live_your_key_here"

{
  "data": [
    {
      "contact_number": "+14155551234",
      "contacts": [{ "id": "cnt-abc", "name": "Sarah Johnson", "company": { "name": "Acme Corp" } }],
      "last_activity": "2026-04-21T14:30:00Z",
      "last_item": { "id": "cll-abc123", "type": "CALL", "direction": "INBOUND", "result": "ANSWERED", "summary": "Customer called about upgrading their plan.", "duration": 145 }
    }
  ],
  "pagination": { "page": 1, "size": 5, "total_count": 156, "has_more": true }
}

​
Endpoints

https://mintcdn.com/themobilefirstcompany/RgYoir1kmfhXIZ06/media/allo-icons/Phone.svg?fit=max&auto=format&n=RgYoir1kmfhXIZ06&q=85&s=83bbcaf90dae5f30887cdfbc503d97b2

Conversations

Timeline unifiee appels + SMS avec filtrage par date, recherche par mots-cles et donnees de contact enrichies
https://mintcdn.com/themobilefirstcompany/0w3bVWjKfZPY4i7y/media/integrations/Webhooks.svg?fit=max&auto=format&n=0w3bVWjKfZPY4i7y&q=85&s=d2fc254143963c5ea1caa09b613bd22e

Webhooks

Notifications d’evenements en temps reel avec signatures HMAC et tentatives automatiques
https://mintcdn.com/themobilefirstcompany/RgYoir1kmfhXIZ06/media/allo-icons/Phone.svg?fit=max&auto=format&n=RgYoir1kmfhXIZ06&q=85&s=83bbcaf90dae5f30887cdfbc503d97b2

Numeros de telephone

Vos numeros Allo avec leurs capacites, le statut du sender ID et les acces des membres
https://mintcdn.com/themobilefirstcompany/RgYoir1kmfhXIZ06/media/allo-icons/Contacts.svg?fit=max&auto=format&n=RgYoir1kmfhXIZ06&q=85&s=21e8763f48b29af6190da3bcc331ba89

Utilisateurs

Liste de l’equipe avec roles et numeros assignes
https://mintcdn.com/themobilefirstcompany/yN5XCm7zDDPr0-yn/media/allo-icons/chat-bubble.svg?fit=max&auto=format&n=yN5XCm7zDDPr0-yn&q=85&s=d1817ba8f8b3a0d440cf67199eb899cd

Tags

Tags d’appels disponibles pour filtrer les conversations