Crée un compte Allo pour l'un de vos clients et lui provisionne un numéro de téléphone. La réponse renvoie une clé API dédiée au nouveau compte (affichée une seule fois), avec le(s) numéro(s) provisionné(s) et le statut.
intervalest requis :MONTHLYouYEARLY. Il fixe la périodicité de facturation de l'abonnement du compte.number_preference.countryest requis (code pays ISO, ex.FR) ;number_preference.prefixest optionnel (ex.+337).number_preference.esimest optionnel,falsepar défaut. Passez-le àtruepour obtenir un numéro mobile français qui peut porter une eSIM, à commander ensuite avec Commander une eSIM. Les numéros eSIM ne sont disponibles qu'en France : avec uncountryautre queFR, la requête échoue avecESIM_NOT_AVAILABLE_IN_COUNTRY.prefixs'applique toujours, par exemple7ou+337.- Un numéro est réservé avant la création du compte. Si aucun ne peut être attribué ou acheté, la requête échoue avec
NO_NUMBER_AVAILABLEet rien n'est créé. - Le compte a son propre abonnement au plan Business, qui vous est facturé avec votre remise partenaire appliquée. La période complète est débitée à la création du compte. Aucun débit n'est effectué sur votre client. Appelez d'abord Obtenir le prix d'un compte pour connaître le montant.
- Allo prélève d'abord votre crédit prépayé, puis débite le reste sur votre carte enregistrée.
- Si votre crédit prépayé ne couvre pas la première période et qu'aucune carte n'est enregistrée, la requête échoue avec
402 PARTNER_CREDIT_INSUFFICIENTet rien n'est créé. - Si votre carte est refusée, la requête échoue avec
402 PARTNER_BILLING_FAILEDet rien n'est créé. - Si l'email ou le mobile personnel appartient déjà à un compte Allo, la requête échoue avec
PARTNER_ACCOUNT_ALREADY_EXISTS. - Si votre compte n'est pas un partenaire activé, la requête échoue avec
PARTNER_ACCESS_REQUIRED. Si votre contrat partenaire ne permet pas de créer des comptes, elle échoue avecPARTNER_CONTRACT_CANNOT_PROVISION. Seuls les partenaires Licence à prix réduit (revendeurs) peuvent créer des comptes.
Le portail partenaire crée les comptes de la même façon, sans code.
Les numéros et les collaborateurs s'ajoutent ensuite dans l'application Allo. Les partenaires en marque blanche les ajoutent par l'API avec Ajouter un numéro et Ajouter un membre.
La clé API du compte
La api_key de la réponse agit sur le nouveau compte, pas sur le vôtre. Conservez-la tout de suite : Allo ne la renvoie qu'une fois, et GET /v2/api/partner/accounts/{id} ne la renvoie pas. La clé a ces 14 scopes :
| Scope | Ce que la clé peut faire sur le compte |
|---|---|
CRM_READ | Lire et rechercher les personnes, entreprises et deals, et lister les champs personnalisés |
CRM_WRITE | Créer et modifier les personnes et entreprises, et créer des champs personnalisés |
WEBHOOKS_READ_WRITE | Créer et gérer les endpoints webhook du compte |
CONVERSATIONS_READ | Lire les appels, SMS, transcriptions et résumés du compte |
PHONE_NUMBERS_READ | Lister les numéros du compte, et lire le flux d'appel publié d'un numéro et son brouillon |
PHONE_NUMBERS_WRITE | Enregistrer et publier le brouillon du flux d'appel d'un numéro. La clé ne peut ni acheter ni libérer de numéro |
AGENTS_READ | Lire la réceptionniste IA d'un numéro, et lister les calendriers connectés et les voix disponibles |
AGENTS_WRITE | Configurer la réceptionniste IA : ses réglages, son prompt, son activation, et ses connaissances (ajouter, modifier et retirer des sites web, retirer des fichiers) |
SUMMARY_TEMPLATES_READ | Lister et lire les modèles de résumé d'appel du compte |
SUMMARY_TEMPLATES_WRITE | Créer, modifier et supprimer des modèles de résumé, et définir le modèle par défaut d'un numéro avec PUT /v2/api/numbers/{number}/default_summary_template |
TAGS_READ | Lister les tags du compte avec GET /v2/api/tags |
TAGS_WRITE | Créer et supprimer des tags, et ajouter ou retirer un tag sur un appel avec POST et DELETE /v2/api/conversations/items/{id}/tags |
USERS_READ | Lister les membres du compte, et en lire un, avec GET /v2/api/users |
SMS_SEND | Envoyer un SMS avec POST /v1/api/sms |
La réglementation française interdit les SMS automatisés depuis un numéro mobile : un envoi depuis le numéro mobile français du compte échoue avec A2P_NOT_ENABLED. Envoyez plutôt depuis un Sender ID validé, avec le paramètre sender_id.
Les clés émises avant l'ajout de ces scopes les reçoivent automatiquement. Le secret ne change pas : vous n'avez rien à mettre à jour.
Voir Scopes des API keys pour les endpoints couverts par chaque scope.