Allo

Obtenir le code d'activation d'une eSIM

Renvoie ce dont votre client a besoin pour installer une eSIM prête sur son téléphone : le code d'activation complet ( lpa ), ses deux parties ( smdp address…

GET/v2/api/partner/esims/{id}/activation_code

Renvoie ce dont votre client a besoin pour installer une eSIM prête sur son téléphone : le code d'activation complet (lpa), ses deux parties (smdp_address et matching_id) et un QR code. Tant que l'eSIM n'est pas prête, la requête échoue avec 409 ESIM_NOT_READY. Attendez le webhook partner.esim.ready, ou le statut ACTIVE sur Obtenir une eSIM.

Le code d'activation n'est jamais envoyé dans un webhook. Récupérez-le au moment de remettre l'eSIM à votre client.

Champs de la réponse

ChampDescription
lpaLe code d'activation complet, au format LPA:1$<smdp_address>$<matching_id>
smdp_addressL'adresse SM-DP+, pour la saisie manuelle
matching_idLe code d'activation, pour la saisie manuelle
qr_codeUne data URI PNG d'un QR code qui encode lpa. Utilisez-la comme src d'une balise <img>.

Comment remettre l'eSIM à votre client

Donnez à votre client l'une de ces options, selon son téléphone :

  • QR code : affichez qr_code. Votre client le scanne depuis les réglages eSIM de son téléphone.
  • Android, saisie manuelle : donnez smdp_address et matching_id. Votre client les saisit dans les réglages eSIM de son téléphone.
  • iPhone (iOS 17.4 et versions ultérieures), lien d'installation : construisez un lien à partir de lpa. Votre client l'ouvre sur l'iPhone et l'eSIM s'installe en un geste.

Le lien iPhone est https://esimsetup.apple.com/esim_qrcode_provisioning?carddata= suivi de lpa encodé pour une URL. Les caractères $ et : doivent être encodés.

const { lpa } = activationCode;
const link =
  "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=" +
  encodeURIComponent(lpa);

Votre client doit se trouver en France au moment d'activer l'eSIM. Consultez eSIM (France) pour les étapes d'installation sur chaque téléphone.

Allo ne détecte pas l'installation de l'eSIM sur le téléphone. La ligne sonne déjà sur l'eSIM dès qu'elle est prête.

Erreurs

CodeSignification
ESIM_NOT_READYL'eSIM n'est pas encore prête à installer. Toujours retryable: true.
PARTNER_ESIM_REVOKEDL'eSIM a été révoquée (409) : son code d'activation n'est plus disponible.
PARTNER_ESIM_NOT_FOUNDAucune eSIM avec cet id n'a été commandée sur un compte créé par votre clé API.
ESIM_UNAVAILABLELe code d'activation ne peut pas être lu pour le moment. Réessayez plus tard.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

idstringrequis

The eSIM id returned by Order eSIM (eso-*).

Réponses

200Activation code
dataobject
4 champs
lpastring

Full activation code, LPA:1$<smdp_address>$<matching_id>.

smdp_addressstring

SM-DP+ address, for manual entry on Android.

matching_idstring

Matching id (activation code), for manual entry on Android.

qr_codestring

PNG data URI of a QR code that encodes lpa.

401
403The API key lacks the PARTNER scope.
errorobject
404No eSIM with this id was ordered on an account your API key provisioned (PARTNER_ESIM_NOT_FOUND).
errorobject
409The eSIM is not ready to install yet (ESIM_NOT_READY). Wait for the partner.esim.ready webhook.
errorobject
429
500The activation code cannot be read right now (ESIM_UNAVAILABLE).
errorobject