Commande une eSIM pour l'un des numéros du compte et la débite sur votre crédit prépayé en priorité, puis sur votre carte enregistrée. La réponse renvoie l'eSIM avec le statut PROVISIONING. L'eSIM est en général prête 5 à 15 minutes plus tard, et Allo vous envoie alors le webhook partner.esim.ready.
Requête
phone_numberest requis. Ce doit être l'un des numéros du compte ou de ses membres, créé avecnumber_preference.esimàtrue(voir Créer un compte, Ajouter un numéro et Ajouter un membre). Tout autre numéro échoue avecPARTNER_ESIM_NUMBER_NOT_FOUNDouESIM_NOT_ELIGIBLE.tierest requis : uncoderenvoyé par Obtenir l'offre eSIM, par exempleESIM_20GB. Un code inconnu échoue avecINVALID_ESIM_TIER.holder_idest optionnel : l'utilisateur Allo auquel l'eSIM est rattachée. Omettez-le pour que le compte lui-même en soit le titulaire. Pour le numéro d'un membre, envoyez l'iddu membre renvoyé par Ajouter un membre ou Lister les membres. Cela vaut aussi pour un numéro que le membre a repris avecphone_number.identityest requis : l'entreprise à laquelle la ligne est enregistrée.corporate_name,postal_address,postal_code(5 chiffres) etcitysont requis.first_name,last_name,company_name,siret,nafetemailsont optionnels. Un champ requis manquant échoue avecESIM_IDENTITY_INCOMPLETE.
Facturation
- Les frais de mise en service et la première période du palier sont facturés sur l'abonnement que vous payez pour le compte, avec votre remise partenaire appliquée. Allo prélève d'abord votre crédit prépayé, puis débite le reste sur votre carte enregistrée. Allo ne facture jamais votre client.
- Si votre crédit prépayé ne couvre pas la commande et qu'aucune carte n'est enregistrée, la requête échoue avec
402 PARTNER_CREDIT_INSUFFICIENT. Rechargez votre crédit ou ajoutez une carte, puis réessayez avec une nouvelleIdempotency-Key. - Une carte qui exige 3D Secure est refusée avec
402 ESIM_PAYMENT_FAILED. Une carte refusée échoue de la même façon. Rien ne reste en attente : mettez à jour votre carte dans le portail partenaire, puis réessayez. - Un numéro dont l'eSIM a été révoquée peut recevoir une nouvelle eSIM. La nouvelle commande facture à nouveau les frais de mise en service. Si vous la passez juste après la révocation, elle reste
PROVISIONINGjusqu'à ce que le réseau mobile ait confirmé la révocation. - Si l'abonnement que vous payez pour le compte ne peut pas recevoir d'eSIM pour le moment, la requête échoue avec
ESIM_SUBSCRIPTION_CONFLICT. Si l'erreur indiqueretryable: true, réessayez dans quelques minutes.
Nouvelles tentatives
Envoyez un en-tête Idempotency-Key (8 à 100 lettres, chiffres, - ou _, par exemple un UUID) et réutilisez-le pour réessayer la même commande. Une nouvelle tentative avec la même clé ne vous débite pas deux fois. Une clé dans un autre format échoue avec INVALID_IDEMPOTENCY_KEY.
Erreurs propres au numéro
| Code | Signification |
|---|---|
ESIM_ALREADY_EXISTS | Le numéro a déjà une eSIM non révoquée. Consultez-la avec Obtenir une eSIM, ou révoquez-la pour en commander une nouvelle. |
ESIM_ORDER_IN_PROGRESS | Une commande pour ce numéro est encore en cours de provisionnement. Attendez partner.esim.ready ou partner.esim.failed. |
ESIM_ORDER_NEEDS_SUPPORT | Une précédente commande a été débitée sans aboutir, et le support Allo la traite. Écrivez à [email protected] avant de commander à nouveau. |
PARTNER_ESIM_HOLDER_NOT_FOUND | holder_id ne peut pas détenir d'eSIM pour ce numéro. Omettez-le pour utiliser le compte. |