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.

Toutes les requetes API necessitent une API key transmise dans le header Authorization.

​
Format du header

Authorization: Api-Key ak_live_your_key_here

​
Generer des API keys

  1. Allez dans Parametres Allo > API
  2. Cliquez sur Create API Key
  3. Selectionnez les scopes dont votre integration a besoin
  4. Copiez la cle — elle ne sera plus affichee

​
Scopes des API keys

Chaque API key possede des scopes specifiques qui determinent les operations qu’elle peut effectuer.
ScopeDescription
CONVERSATIONS_READLire les appels, SMS et l’historique des conversations
CONTACTS_READLire les informations de contact
CONTACTS_READ_WRITELire et modifier les informations de contact
SMS_SENDEnvoyer des SMS et MMS
WEBHOOKS_READ_WRITECreer et gerer les configurations de webhooks
PHONE_NUMBERS_READLister les numeros de telephone et leurs capacites
USERS_READLister les membres de l’equipe et leurs roles
TAGS_READLister les tags disponibles
TAGS_WRITEAjouter et supprimer des tags sur les elements de conversation
BILLINGAcceder aux informations de facturation et d’abonnement
DIALING_QUEUE_READ_WRITEGerer les files d’attente de composition

​
Correspondance scopes-endpoints

EndpointMethodeScope requis
/v2/api/conversationsGETCONVERSATIONS_READ
/v2/api/conversations/items/searchPOSTCONVERSATIONS_READ
/v2/api/conversations/items/{id}GETCONVERSATIONS_READ
/v2/api/conversations/items/batchPOSTCONVERSATIONS_READ
/v2/api/conversations/{contact_number}/actionPUTCONVERSATIONS_READ
/v2/api/conversations/items/{id}/tagsPOSTTAGS_WRITE
/v2/api/conversations/items/{id}/tags/{tag}DELETETAGS_WRITE
/v2/api/usersGETUSERS_READ
/v2/api/users/{id}GETUSERS_READ
/v2/api/tagsGETTAGS_READ
/v2/api/numbersGETPHONE_NUMBERS_READ

​
Exemple de requete

curl -X GET "https://api.withallo.com/v2/api/conversations" \
  -H "Authorization: Api-Key ak_live_abc123def456"

​
Reponses d’erreur

Cle invalide ou manquante — 401 
{
  "error": {
    "type": "authentication_error",
    "code": "API_KEY_INVALID",
    "message": "The API key provided is invalid or has been revoked.",
    "retryable": false,
    "request_id": "req_a1b2c3d4e5f6",
    "doc_url": "https://help.withallo.com/en/v2/api-reference/guides/error-codes#API_KEY_INVALID"
  }
}
Scope insuffisant — 403 
{
  "error": {
    "type": "permission_error",
    "code": "API_KEY_INSUFFICIENT_SCOPE",
    "message": "This API key lacks the 'CONVERSATIONS_READ' scope required for this endpoint.",
    "retryable": false,
    "request_id": "req_a1b2c3d4e5f6",
    "suggestion": "Create a new API key with the required scope at https://web.withallo.com/settings/api"
  }
}

​
Securite

  • Les API keys sont limitees a une seule equipe
  • Les cles peuvent etre revoquees a tout moment depuis les parametres
  • N’exposez jamais les cles dans du code cote client ou des depots publics
  • Utilisez des variables d’environnement pour stocker les cles dans votre application