Présentation
L'API Google Mobile Data Plan Sharing permet également à un opérateur d'envoyer des notifications à un utilisateur en envoyant un PlanStatus.
L'API est actuellement compatible avec sept types de notifications.
- Solde faible : lorsque PlanModule.coarseBalanceLevel est défini sur LOW_QUOTA
- Données indisponibles : lorsque PlanModule.coarseBalanceLevel est défini sur OUT_OF_DATA. Si, en plus de cela, PlanModule.overUsagePolicy est défini sur PAY_AS_YOU_GO, l'utilisateur sera averti qu'il est sur le point de passer en mode paiement à l'usage.
- Avertissement d'expiration des données : lorsque PlanModule.planModuleState est défini sur EXPIRING_SOON
- Activation du forfait : lorsque PlanModule.planModuleState est défini sur NEWLY_ACTIVE
- Paiement à l'utilisation : lorsque AccountInfo.payAsYouGoCharge est renseigné avec le montant dépensé par l'utilisateur.
- Recharge du compte : lorsque AccountInfo.accountTopUp et AccountInfo.accountBalance sont renseignés. Ces deux champs sont obligatoires pour envoyer à l'utilisateur une notification de recharge du compte. Si les unités et les nanos dans AccountInfo.accountTopUp sont définis sur zéro, le montant de la recharge ne figure pas dans la notification.
- Expiration des données : lorsque PlanModule.planModuleState est défini sur EXPIRED. Cette option concerne les forfaits qui ont déjà expiré.
Une notification est envoyée à l'utilisateur pour chaque ensemble de champs. Si plusieurs champs coarseBalanceLevel
ou planModuleState
sont définis dans un même PlanStatus
, un nombre égal de notifications sera envoyé à l'utilisateur.
Conditions requises
Une notification PlanStatus DOIT contenir autant d'informations que possible sur le forfait mobile de l'utilisateur. Pour chaque type de notification, l'API Data Plan Sharing définit également un ensemble minimal de champs requis pour créer le texte de la notification. L'opérateur DOIT inclure ces champs dans un PlanStatus de notification.
Notification | Champs obligatoires |
---|---|
Solde faible | PlanModule.moduleName, PlanModule.byteBalance.remainingBytes |
Forfait de données épuisé | PlanModule.moduleName |
Avertissement d'expiration des données | PlanModule.moduleName, PlanModule.expirationTime |
Activation du forfait | PlanModule.moduleName |
Expiration des données | PlanModule.moduleName |