Allo

Révoquer une eSIM

Révoque immédiatement une eSIM : elle cesse définitivement de fonctionner sur son téléphone, par exemple quand le téléphone est perdu ou que son titulaire…

POST/v2/api/partner/esims/{id}/revoke

Révoque immédiatement une eSIM : elle cesse définitivement de fonctionner sur son téléphone, par exemple quand le téléphone est perdu ou que son titulaire part. La réponse renvoie l'eSIM avec le statut REVOKED.

Ce que devient le numéro

  • Le numéro reste sur le compte, avec le même titulaire et son historique d'appels et de messages.
  • Les appels vers le numéro sonnent sur les apps Allo au lieu de l'eSIM.
  • Le palier de données de l'eSIM s'arrête tout de suite et n'est plus facturé.
  • Une eSIM révoquée ne peut pas être réactivée. Pour remettre le numéro sur un téléphone, commandez une nouvelle eSIM pour ce numéro. La nouvelle commande facture les frais de mise en service.

Retirer un membre révoque les eSIM du membre pour vous : inutile d'appeler cet endpoint avant.

Idempotence

Révoquer une eSIM déjà REVOKED la renvoie telle quelle. Une eSIM remplacée par une eSIM plus récente sur le même numéro est aussi REVOKED, et la révoquer ne touche jamais la nouvelle.

Erreurs

CodeSignification
PARTNER_ESIM_NOT_REVOCABLEL'eSIM n'est pas active : elle est encore PROVISIONING, elle est FAILED, ou elle est en cours de bascule entre le réseau et l'eSIM (409). Seule une eSIM ACTIVE peut être révoquée. Vérifiez-la avec Obtenir une eSIM.
PARTNER_ESIM_MOVE_FAILEDLa bascule de l'eSIM entre le réseau et l'eSIM a échoué (409) : elle ne peut pas être révoquée avant d'être vérifiée. Contactez le support Allo. Rien n'a été modifié.
PARTNER_ESIM_NOT_FOUNDAucune eSIM avec cet id n'a été commandée sur un compte créé par votre API key (404).

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

idstringrequis

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

Réponses

200The revoked eSIM, with status REVOKED
dataobject
8 champs
idstring

The eSIM id (eso-*).

account_idstring

The account the eSIM was ordered for.

partner_client_refstring | null

Your own reference, set when the account was created.

phone_numberstring

The number the eSIM carries.

tierstring

The tier code that was ordered.

statusenum<string>

PROVISIONING: ordered, not ready yet. ACTIVE: ready, calls to the number ring the eSIM. FAILED: the order did not complete, see failure_code. REVOKED: the eSIM was revoked, or replaced by a later eSIM on the same number, and no longer works.

PROVISIONINGACTIVEFAILEDREVOKED

failure_codestring | null

Why the order failed. Set only when status is FAILED.

created_atstring<date-time>

When the eSIM was ordered.

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 live: it is still provisioning, it failed, or it is being moved between the network and the eSIM (PARTNER_ESIM_NOT_REVOCABLE). Only an ACTIVE eSIM can be revoked.
errorobject
429