Allo

Retirer un membre

Retire un membre de l'un de vos comptes, par exemple quand un collaborateur quitte l'entreprise de votre client. Les numéros du membre restent sur le compte…

DELETE/v2/api/partner/accounts/{id}/members/{member_id}

Retire un membre de l'un de vos comptes, par exemple quand un collaborateur quitte l'entreprise de votre client. Les numéros du membre restent sur le compte avec leur historique, pour que vous puissiez les donner au collaborateur qui le remplace. La réponse est 204, sans corps.

Ce que fait Allo

Révoque les eSIM du membre

Allo révoque toutes les eSIM du membre, et toutes les eSIM de ses numéros (y compris une eSIM commandée sans holder_id), avant toute autre étape, pour que son téléphone cesse de sonner immédiatement, même si une étape suivante échoue. Le palier de données de chaque eSIM s'arrête tout de suite.

Retire le membre du workspace

Le membre perd l'accès au workspace du compte. Ses numéros passent au compte lui-même, avec leur historique d'appels et de messages, et sonnent sur les apps Allo.

Remplace le siège par des numéros supplémentaires

Le siège du membre reste payé jusqu'à la fin de la période de facturation en cours. À partir de la facture suivante, l'abonnement du compte facture les numéros conservés comme numéros supplémentaires à la place du siège, sans prorata. Allo n'ajoute que les numéros supplémentaires que le compte ne paie pas déjà.

Si le compte est en cours de désactivation à la fin de sa période de facturation, Allo ne facture rien de plus pour les numéros conservés.

Comment donner le numéro à un nouveau collaborateur

Appelez Ajouter un membre avec le numéro conservé comme phone_number. Le nouveau membre le reprend avec son historique. Voir Comment remplacer un collaborateur qui part pour le parcours complet, nouvelle eSIM comprise.

Erreurs

CodeSignification
PARTNER_ACCOUNT_OWNER_NOT_REMOVABLEmember_id est le compte lui-même, qui n'est pas un membre (400). Pour mettre fin au compte, utilisez Désactiver un compte.
PARTNER_ACCOUNT_MEMBER_NOT_FOUNDAucun membre avec cet id dans le workspace du compte (404). Listez-les avec Lister les membres.
PARTNER_ACCOUNT_NOT_FOUNDVotre API key n'a pas créé ce compte, ou le compte est désactivé (404).
PARTNER_ESIM_MOVE_IN_PROGRESSL'une des eSIM du membre est en cours de bascule entre le réseau et l'eSIM (409). Toujours retryable: true : réessayez dans quelques minutes. Rien n'a été modifié.
PARTNER_ESIM_MOVE_FAILEDLa bascule de l'une des eSIM du membre entre le réseau et l'eSIM a échoué (409). Contactez le support Allo. Rien n'a été modifié.
PARTNER_ACCOUNT_BUSYUn autre membre ou numéro est en cours de modification sur ce compte (409). Toujours retryable: true : réessayez dans quelques secondes.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

idstringrequis

The account id returned by Create account (usr-*).

member_idstringrequis

The member's id (usr-*), from Add member or List members.

Réponses

204Member removed
400The member_id is the account itself, which is not a member (PARTNER_ACCOUNT_OWNER_NOT_REMOVABLE). To end the account, use DELETE /v2/api/partner/accounts/{id}.
errorobject
401
403The API key lacks the PARTNER scope.
errorobject
404No account with this id was provisioned by your API key, or the account is deactivated (PARTNER_ACCOUNT_NOT_FOUND), or no member with this id is in the account's workspace (PARTNER_ACCOUNT_MEMBER_NOT_FOUND).
errorobject
409One of the member's eSIMs is being moved between the network and the eSIM right now (PARTNER_ESIM_MOVE_IN_PROGRESS), or another member or number is being changed on this account (PARTNER_ACCOUNT_BUSY). Both are retryable: true: retry in a few minutes for the first, a few seconds for the second.
errorobject
429