Skip to main content
POST
Create account
Scope requis : PARTNER
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, facturé sur votre moyen de paiement 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.
  • Si votre moyen de paiement est absent ou refusé, la requête échoue avec 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.

Autorisations

Authorization
string
header
requis

Corps

application/json
email
string
requis

Becomes the account's login.

name
string
requis
Exemple:

"Jane Doe"

interval
enum<string>
requis

Billing interval of the account's own subscription, billed to your payment method.

Options disponibles:
MONTHLY,
YEARLY
Exemple:

"MONTHLY"

number_preference
object
requis
personal_mobile
string | null

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

Exemple:

"+33612345678"

partner_client_ref
string

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

Exemple:

"crm-12345"

Réponse

Account created

data
object