Allo

Créer un compte

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…

POST/v2/api/partner/accounts

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.

  • interval est requis : MONTHLY ou YEARLY. Il fixe la périodicité de facturation de l'abonnement du compte.
  • number_preference.country est requis (code pays ISO, ex. FR) ; number_preference.prefix est optionnel (ex. +337).
  • number_preference.esim est optionnel, false par défaut. Passez-le à true pour 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 un country autre que FR, la requête échoue avec ESIM_NOT_AVAILABLE_IN_COUNTRY. prefix s'applique toujours, par exemple 7 ou +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_AVAILABLE et 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_INSUFFICIENT et rien n'est créé.
  • Si votre carte est refusée, la requête échoue avec 402 PARTNER_BILLING_FAILED et 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 avec PARTNER_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 :

ScopeCe que la clé peut faire sur le compte
CRM_READLire et rechercher les personnes, entreprises et deals, et lister les champs personnalisés
CRM_WRITECréer et modifier les personnes et entreprises, et créer des champs personnalisés
WEBHOOKS_READ_WRITECréer et gérer les endpoints webhook du compte
CONVERSATIONS_READLire les appels, SMS, transcriptions et résumés du compte
PHONE_NUMBERS_READLister les numéros du compte, et lire le flux d'appel publié d'un numéro et son brouillon
PHONE_NUMBERS_WRITEEnregistrer 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_READLire la réceptionniste IA d'un numéro, et lister les calendriers connectés et les voix disponibles
AGENTS_WRITEConfigurer 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_READLister et lire les modèles de résumé d'appel du compte
SUMMARY_TEMPLATES_WRITECré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_READLister les tags du compte avec GET /v2/api/tags
TAGS_WRITECré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_READLister les membres du compte, et en lire un, avec GET /v2/api/users
SMS_SENDEnvoyer 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.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Corps

emailstringrequis

Becomes the account's login.

namestringrequis
intervalenum<string>requis

Billing interval of the account's own subscription, billed to you.

MONTHLYYEARLY

personal_mobilestring | null

Optional. An existing mobile the new number can attach to.

partner_client_refstring

Your own reference for this customer. Echoed back and on the activation webhook.

number_preferenceobjectrequis
3 champs
countrystringrequis

ISO country code.

prefixstring | null

Optional. Digits the number should start with, after the country code, for example +337 or 7.

esimboolean | null

Optional, default false. Set to true to get a French mobile number that can carry an eSIM, which you can then order with POST /v2/api/partner/accounts/{account_id}/esims. eSIM numbers are only available with country set to FR, otherwise the request fails with ESIM_NOT_AVAILABLE_IN_COUNTRY.

Réponses

201Account created
dataobject
6 champs
idstring
api_keystring | null

Scoped API key for the new account, with the scopes CRM_READ, CRM_WRITE, WEBHOOKS_READ_WRITE, CONVERSATIONS_READ, PHONE_NUMBERS_READ, PHONE_NUMBERS_WRITE, AGENTS_READ, AGENTS_WRITE, SUMMARY_TEMPLATES_READ and SUMMARY_TEMPLATES_WRITE (no SMS_SEND). Returned only on create.

phone_numbersstring[]
statusstring
activatedboolean

True once the customer has signed in on a device.

partner_client_refstring | null
400Validation error: a required field is missing (MISSING_FIELD), or number_preference.esim is true with a country other than FR (ESIM_NOT_AVAILABLE_IN_COUNTRY).
errorobject
401
402Billing error, nothing is created. PARTNER_CREDIT_INSUFFICIENT: your prepaid credit does not cover the first period and your billing account has no card on file. PARTNER_BILLING_FAILED: your card was declined. PARTNER_SUBSCRIPTION_NOT_BILLABLE: you have no billing account Allo can charge.
errorobject
403The API key lacks the PARTNER scope, your account is not an enabled partner (PARTNER_ACCESS_REQUIRED), or your partner contract cannot create accounts (PARTNER_CONTRACT_CANNOT_PROVISION). Only Discounted licence (reseller) partners can create accounts.
errorobject
409An account already exists (PARTNER_ACCOUNT_ALREADY_EXISTS) or no number is available (NO_NUMBER_AVAILABLE).
errorobject
429