Passer au contenu principal
Toutes les requêtes API nécessitent une authentification via une clé API. Incluez votre clé API dans l’en-tête Authorization :
Authorization: Api-Key VOTRE_CLE_API

Génération des clés API

Générez des clés API dans les paramètres de votre compte Allo.

Portées des clés API

Chaque clé API dispose de portées spécifiques qui déterminent les opérations autorisées :
PortéeDescription
WEBHOOKS_READ_WRITECréer, lire et mettre à jour les configurations de webhooks
CONVERSATIONS_READLire les enregistrements d’appels et l’historique
CONTACTS_READLire les informations de contact
SMS_SENDEnvoyer des SMS et MMS

Exemple de requête

curl -X GET "https://api.withallo.com/v1/api/contacts" \
  -H "Authorization: Api-Key VOTRE_CLE_API"

Réponses d’erreur

Si votre clé API est invalide ou manquante, vous recevrez une réponse 401 Unauthorized :
{
  "code": "API_KEY_INVALID",
  "details": null
}
Si votre clé API n’a pas la portée requise pour un point d’accès, vous recevrez une réponse 403 Forbidden :
{
  "code": "API_KEY_INSUFFICIENT_SCOPE",
  "details": [
    { "message": "required=CONTACTS_READ", "field": "scope" }
  ]
}