Poznámka
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Přehled
Jakmile uživatel dokončí tok aktivace na webovém portálu mobilního operátora, musí portál poskytnout signál, aby aplikace Mobile Plans věděla, že se tok dokončil. To se provádí tak, že aplikaci odešlete oznámení, které zahrnuje výsledek interakce uživatele s webovým portálem.
Transakce, které webový portál podporuje, zahrnují, ale nejsou omezeny na následující:
- Vydání nového profilu eSIM (pomocí aktivačního kódu)
- Přidružení zařízení k novému nebo existujícímu předplatnému
- Nákup nového datového balíčku (paušálního nebo předplaceného)
- Nákup dalších dat pro předplacený plán
- Zrušení předplatného
Poznámka
Oznámení o zpětném volání musí být vráceno z hostitele definovaného v konfiguraci služby služby mobilního operátora.
Stažení a připojení vloženého profilu
Metoda zpětného volání by se měla použít při provádění stahování profilu eSIM na pozadí a přitom zachovat uživatele na webovém portálu mobilního operátora. Portál tak může po dokončení stahování profilu zobrazit další obsah, například stránku pro správu účtu. Kromě toho se očekává, že profil umožní, aby se zařízení okamžitě po aktivaci zaregistrovalo v mobilní síti bez časového zpoždění.
Následující diagram znázorňuje tok volání pro zpětné volání pro stažení vloženého profilu:
Toto je revidovaná verze starší verze doručení vloženého profilu zpětné volání, kterou najdete v dodatku pro účely dokumentace. Doporučujeme, aby mobilní operátoři používali výše uvedenou revidovanou metodu zpětného volání.
MobilePlansInlineOperations.notifyProfileDownload(purchaseMetaData, activationCode)
Název parametru | Typ | Popis |
---|---|---|
metadata nákupu | Objekt | Tento objekt obsahuje metadata o nákupu uživatele. To zahrnuje podrobnosti o uživatelském účtu, metodě nákupu nebo instrumentu, podrobnosti o tom, jestli uživatel přidává nový řádek, a název plánu, který uživatel zakoupil. Používají se k vytváření obchodních sestav. |
aktivační kód | Řetězec | Aktivační kód, který se má použít ke stažení profilu eSIM |
Návratový typ hodnoty | Popis |
---|---|
KontextOperacíMobilníchTarifů | Objekt s identifikátory, které odpovídají této jedinečné operaci stahování. |
Stažení profilu eSIM začne po přijetí zpětného oznámení. Ovládací prvek se vrátí na webový portál hned po volání. Uživatelské rozhraní se zobrazí, aby ukázalo průběh stahování profilu jako vyskakovací okno nad webovým portálem. Během tohoto procesu můžete pokračovat v navigaci na webovém portálu.
Následující funkce JavaScriptu ukazuje příklad rozhraní API, který informuje aplikaci, že by se mělo zahájit stahování profilu:
var purchaseMetaData = MobilePlans.createPurchaseMetaData();
purchaseMetaData.userAccount = MobilePlansUserAccount.new;
purchaseMetaData.purchaseInstrument = MobilePlansPurchaseInstrument.new;
purchaseMetaData.lineType = MobilePlansLineType.new;
purchaseMetaData.modirectStatus = MobilePlansMoDirectStatus.complete;
purchaseMetaData.planName = "My Plan";
MobilePlansInlineOperations.registrationChangedScript = "onRegistrationChanged";
MobilePlansInlineOperations.profileActivationCompleteScript = "onActivationComplete";
MobilePlansInlineOperations.notifyProfileDownload(purchaseMetaData , "1$smdp.address$matchingID");
Podrobnosti o objektu purchaseMetadata najdete v základních vlastnostech metadat nákupu .
Sledování změn registrace sítě
Chcete-li naslouchat změnám registrace sítě, musí být MobilePlansInlineProfileDownload.registrationChangedScript
nastaven na řetězec, který je názvem javascriptové funkce, která přebírá řetězec pro registrationArgs
.
Argumenty registrace jsou ve formě řetězce, který představuje objekt JSON.
ArgumentyDokončeníRegistraceProfilu
Název vlastnosti | Typ | Popis |
---|---|---|
stav registrace sítě | Řetězec | Řetězec představující aktuální stav registrace sítě. Hodnoty této vlastnosti lze zobrazit v MobilePlansNetworkRegistrationState . |
iccid (Identifikátor integrované obvodové karty) | Řetězec | ICCID, pro který se změnil stav registrace sítě. |
Stav Registrace Síťových Mobilních Tarifů
Název vlastnosti | Typ | Popis |
---|---|---|
žádný | Řetězec | Žádné připojení. |
zrušení registrace | Řetězec | Zařízení není zaregistrované a nehledá poskytovatele sítě. |
vyhledávání | Řetězec | Zařízení není zaregistrované a hledá poskytovatele sítě. |
domov | Řetězec | Zařízení je na domovském poskytovateli sítě. |
potulování | Řetězec | Zařízení je na poskytovateli roamingové sítě. |
partner | Řetězec | Zařízení je na poskytovateli roamingových partnerských sítí. |
zamítnuto | Řetězec | Registrace zařízení byla zamítnuta. |
Následující příklad JavaScriptu ukazuje, jak implementovat posluchač pro události změny registrace sítě.
function onRegistrationChanged(registrationArgs) {
var registrationObj = JSON.parse(registrationArgs);
if(registrationObj.networkRegistrationState == MobilePlansNetworkRegistrationState.home ||
registrationObj.networkRegistrationState == MobilePlansNetworkRegistrationState.roaming ||
registrationObj.networkRegistrationState == MobilePlansNetworkRegistrationState.partner)
{
Log('Registration Successful!');
}
}
Sledování aktivace profilu
Pokud chcete naslouchat událostem aktivace profilu, musí být MobilePlansInlineProfileDownload.profileActivationCompleteScript
nastaven na řetězec, který je názvem JavaScriptové funkce, jež přijímá řetězec pro activationArgs
.
activationArgs
je řetězec, který představuje objekt JSON.
ArgumentyDokončeníAktivaceProfilu
Název vlastnosti | Typ | Popis |
---|---|---|
výsledek aktivace | Řetězec | Výsledek aktivace. Hodnoty této vlastnosti lze zobrazit v MobilePlansActivationError . |
ICCID | Řetězec | ICCID profilu, který byl aktivován. |
Chyba aktivace mobilních plánů
Název vlastnosti | Typ | Popis |
---|---|---|
úspěch | Řetězec | Označuje, že operace byla úspěšná. |
neautorizován | Řetězec | Označuje, že operace nebyla autorizovaná. |
nenalezeno | Řetězec | Označuje, že zadaný profil eSIM nebyl nalezen. |
porušení zásad | Řetězec | Označuje, že operace porušuje zásady. |
Nedostatek místa na kartě | Řetězec | Označuje, že na kartě není dostatek úložného prostoru pro dokončení operace. |
selhání serveru | Řetězec | Označuje, že během operace došlo k selhání serveru. |
Server nelze dosáhnout | Řetězec | Označuje, že během operace nebylo možné se připojit k serveru. |
časový limit čekání na souhlas uživatele | Řetězec | Označuje, že souhlas uživatele nebyl udělen během časového limitu operace. |
nesprávnýPotvrzovacíKód | Řetězec | Označuje, že během operace byl zadán nesprávný potvrzovací kód. |
kódPotvrzeníMaximálníPočetPokusůPřekročen | Řetězec | Označuje, že během operace byl zadán nesprávný potvrzovací kód a že nejsou povoleny žádné další opakování. |
karta odstraněna | Řetězec | Označuje, že sim karta byla odebrána. |
cardBusy | Řetězec | Označuje, že sim karta je zaneprázdněná. |
jiný | Řetězec | Označuje stav, který není zohledněný konkrétnějším stavem. |
obecná chyba karty | Řetězec | Označuje, že došlo k chybě karty, která zabránila úspěšnému dokončení stahování, instalace nebo jiné operace. |
chybí potvrzovací kód | Řetězec | Označuje, že ke stažení profilu eSIM je potřeba potvrzovací kód. |
invalidMatchingId | Řetězec | Označuje, že odpovídající ID z aktivačního kódu nebo zjištěné události bylo odmítnuto. |
Tento přístroj nemá žádný vhodný profil | Řetězec | Označuje, že se nepodařilo najít profil eSIM kompatibilní s tímto zařízením. Například byl nalezen profil, který vyžaduje podporu LTE, ale zařízení podporuje pouze 3G. |
operace zrušena | Řetězec | Označuje, že operace byla přerušena. |
eidMismatch | Řetězec | Označuje, že profil eSIM na serveru mobilního operátora je již přidělen pro jiné eSIM EID než zařízení má. |
Profil není k dispozici pro nové svázání | Řetězec | Označuje, že se uživatel pokouší stáhnout profil eSIM, který už byl deklarovaný nebo stažený. |
profilNeuvolněnOperátorem | Řetězec | Označuje, že profil eSIM je k dispozici, ale zatím není označený jako uvolněný ke stažení mobilním operátorem. Stáhnout je možné jenom vydané profily, takže mo musí profil označit jako uvolněný. |
operaceZakázánaProfilem | Řetězec | Označuje, že operace není povolena pro třídu profilu eSIM. |
profilNenalezen | Řetězec | Označuje, že profil eSIM nebyl nalezen. |
žádný odpovídající požadavek | Řetězec | Označuje, že nebyl nalezen žádný odpovídající požadavek. |
neznámáChyba | Řetězec | Označuje, že LPA vrátila chybu, která je neznámá. |
lpaInitializationError | Řetězec | Označuje, že při pokusu o inicializaci LPA došlo k chybě. |
modemNotFound | Řetězec | Označuje, že v zařízení nebyl nalezen žádný mobilní modem. |
Přístup k místním nastavením se nezdařil | Řetězec | Označuje, že přístup k místnímu nastavení aplikace selhal. |
neplatnýJson | Řetězec | Označuje, že portál MO při volání aplikace Mobile Plans zadal neplatný kód JSON. |
neplatný aktivační kód | Řetězec | Označuje, že portál MO udělil neplatný aktivační kód. |
neplatnýICCID | Řetězec | Označuje, že portál MO udělil neplatné ICCID. |
Následující příklad JavaScriptu ukazuje, jak implementovat naslouchací proces pro událost aktivace profilu.
function onActivationComplete(activationArgs) {
var activationObj = JSON.parse(activationArgs);
if(activationObj.activationResult == MobilePlansActivationError.success)
Log('Activation Success');
}
Stažení a aktivace zpožděného profilu eSIM
Následující diagram znázorňuje tok volání, jak aplikace Mobile Plans podporuje zpožděné stahování a aktivaci profilu eSIM. Tato možnost by se měla použít, pokud profil eSIM není dostupný k vydání serverem SM-DP+ a lze ho stáhnout pouze po určité době. Očekává se, že se zařízení bude moct po stažení a aktivaci profilu zaregistrovat v mobilní síti.
MobilePlansInlineOperations.notifyProfileDownload(purchaseMetaData, activationCode, downloadDelay)
Název parametru | Typ | Popis |
---|---|---|
metadata o nákupu | Objekt | Tento objekt obsahuje metadata o nákupu uživatele. To zahrnuje podrobnosti o uživatelském účtu, metodě nákupu nebo instrumentu, podrobnosti o tom, jestli uživatel přidává nový řádek, a název plánu, který uživatel zakoupil. Všechny se používají k reportování. |
aktivační kód | Řetězec | Aktivační kód nebo adresa SM-DP+, kde je umístěn profil |
zpoždění stahování | uint | Počet minut čekání před pokusem o stažení profilu eSIM |
Návratový typ hodnoty | Popis |
---|---|
MobilePlansOperationContext | Objekt s identifikátory, které odpovídají této jedinečné operaci stahování. |
Řízení se vrátí na Portal mobilního operátora hned po hovoru. Uživatelské rozhraní se zobrazí, aby uživatele informovalo, že se profil nainstaluje později. Po downloadDelay
minutách se uživateli zobrazí oznámení s pozváním, aby zahájil proces stahování profilu.
Následující funkce JavaScriptu ukazuje příklad rozhraní API, který informuje aplikaci, že by se mělo zahájit stahování profilu se zpožděním.
var purchaseMetaData = MobilePlans.createPurchaseMetaData();
purchaseMetaData.userAccount = MobilePlansUserAccount.new;
purchaseMetaData.purchaseInstrument = MobilePlansPurchaseInstrument.new;
purchaseMetaData.lineType = MobilePlansLineType.new;
purchaseMetaData.modirectStatus = MobilePlansMoDirectStatus.complete;
purchaseMetaData.planName = "My Plan";
MobilePlansInlineOperations.registrationChangedScript = "onRegistrationChanged";
MobilePlansInlineOperations.profileActivationCompleteScript = "onActivationComplete";
MobilePlansInlineOperations.notifyProfileDownload(purchaseMetaData , "1$smdp.address$matchingID", 15);
Podrobnosti o objektu purchaseMetadata najdete v tématu metadatové vlastnosti nákupu.
Viz naslouchání změnám registrace sítě části výše.
Viz výše uvedenou část o naslouchání aktivace profilu.
Zrušení stahování profilu eSIM
To platí i pro scénář stahování odloženého profilu eSIM, ale dá se použít i pro budoucí případy použití.
Následující diagram znázorňuje vysokou úroveň toku, jak program Mobilní plány podporuje zrušení stahování profilu eSIM, aniž by kontrola opustila portál MODirect.
MobilePlansInlineOperations.notifyOperationCancel(MobilePlansOperationContext)
Název parametru | Typ | Popis |
---|---|---|
operationContext | Objekt | Tento objekt obsahuje informace, které jednoznačně identifikují předchozí operaci. |
Tuto operaci můžete zrušit, než se uživateli zobrazí informační zpráva s oznámením, že stahování je připravené začít.
Následující funkce JavaScriptu ukazuje příklad rozhraní API pro zrušení asynchronní akce.
var purchaseMetaData = MobilePlans.createPurchaseMetaData();
purchaseMetaData.userAccount = MobilePlansUserAccount.new;
purchaseMetaData.purchaseInstrument = MobilePlansPurchaseInstrument.new;
purchaseMetaData.lineType = MobilePlansLineType.new;
purchaseMetaData.modirectStatus = MobilePlansMoDirectStatus.complete;
purchaseMetaData.planName = "My Plan";
MobilePlansInlineOperations.registrationChangedScript = "onRegistrationChanged";
MobilePlansInlineOperations.profileActivationCompleteScript = "onActivationComplete";
var op = MobilePlansInlineOperations.notifyProfileDownload(purchaseMetaData , "1$smdp.address$matchingID", 15);
MobilePlansInlineOperations.notifyOperationCancel(op);
Asynchronní připojení
Následující diagram znázorňuje základní tok, jak aplikace Mobile Plans podporuje zpožděné připojení. Tato metoda zpětného volání by se měla použít, pokud je profil eSIM již k dispozici pro vydání serverem SM-DP+ , ale zařízení musí chvíli počkat, než se pokusí zaregistrovat v mobilní síti.
Jakmile uživatel úspěšně dokončí tok aktivace, webový portál informuje aplikaci Mobile Plans, že by měla aktivovat zpožděný tok připojení pomocí rozhraní MobilePlans.notifyPurchaseWithProfileDownload
API.
MobilePlány.oznamKup sStaženímProfilu
Název parametru | Typ | Popis |
---|---|---|
metadata nákupu | Objekt | Tento objekt obsahuje metadata o nákupu uživatele. To zahrnuje podrobnosti o uživatelském účtu, metodě nákupu nebo instrumentu, podrobnosti o tom, jestli uživatel přidává nový řádek, a název plánu, který uživatel zakoupil. Všechny se používají pro hlášení. |
aktivační kód | Řetězec | Aktivační kód pro stažení profilu eSIM. ICCID profilu se odvodí z metadat profilu. |
networkRegistrationInterval | Celé číslo bez znaménka | Doba potřebná pro mobilní operátora pro zřízení připojení k uživateli. Aplikace Mobile Plans se pokusí zaregistrovat do sítě v zadaném časovém intervalu v minutách. Poznámka Tento čas se zaokrouhlí na nejbližší 15minutový interval. Pokud je například nastavená hodnota 5 minut, aplikace se pokusí znovu zaregistrovat do sítě po přibližně 15 minutách (ale může to trvat déle). pokud je nastavená hodnota 0, zařízení se pokusí zaregistrovat okamžitě. |
Následující funkce JavaScriptu ukazuje příklad rozhraní API, které informuje aplikaci, že nákup uživatele vyžaduje zpožděné zřizování připojení.
function finishPurchaseWithDownload() {
var metadata = MobilePlans.createPurchaseMetaData();
metadata.userAccount = MobilePlansUserAccount.new;
metadata.purchaseInstrument = MobilePlansPurchaseInstrument.new;
metadata.moDirectStatus = MobilePlansMoDirectStatus.complete;
metadata.line = MobilePlansLineType.new;
metadata.planName = "2GB Monthly";
MobilePlans.notifyPurchaseWithProfileDownload(metadata, "1$smdp.address$matchingID", 15);
}
Podrobnosti o objektu purchaseMetadata najdete v tématu vlastnosti nákupních metadat.
Přidání zůstatku
Když uživatel dokončí nákup na webovém portálu tím, že zvýší zůstatek na existujícím účtu, měl by webový portál vyvolat API MobilePlansInlineOperations.notifyBalanceAddition
a převést řízení zpět do aplikace Mobile Plans. Můžete to použít pro fyzickou SIM kartu nebo profil eSIM, které jsou již v zařízení nainstalované.
Následující diagram znázorňuje základní tok toho, jak aplikace Mobile Plans podporuje přidání zůstatku.
MobilePlansInlineOperations.notifyBalanceAddition(purchaseMetaData)
Název parametru | Typ | Popis |
---|---|---|
metadata nákupu | Objekt | Tento objekt obsahuje metadata o nákupu uživatele. To zahrnuje podrobnosti o uživatelském účtu, metodě nákupu nebo instrumentu, podrobnosti o tom, jestli uživatel přidává nový řádek, a název plánu, který uživatel zakoupil. Všechny se používají k reportování. |
Návratový typ hodnoty | Popis |
---|---|
KontextOperacíMobilníchPlánů | Objekt s identifikátory, které odpovídají této jedinečné operaci stahování. |
Pokud chce mobilní operátor přidat zůstatek k danému účtu, webový portál by měl volat rozhraní API MobilePlansInlineOperations.notifyBalanceAddition
.
Následující funkce JavaScriptu ukazuje příklad rozhraní API pro informování aplikace, že bylo provedeno přidání zůstatku.
function NotifyMobilePlans() {
var purchaseMetaData = MobilePlans.createPurchaseMetaData();
purchaseMetaData.userAccount = MobilePlansUserAccount.new;
purchaseMetaData.purchaseInstrument = MobilePlansPurchaseInstrument.new;
purchaseMetaData.lineType = MobilePlansLineType.new;
purchaseMetaData.modirectStatus = MobilePlansMoDirectStatus.complete;
purchaseMetaData.planName = "My Plan";
MobilePlansInlineOperations.notifyBalanceAddition(purchaseMetaData);
}
Podívejte se na vlastnosti metadat nákupu pro podrobnosti o objektu puchaseMetadata
.
Přidání zůstatku a aktivace profilu eSIM
Když uživatel dokončí nákup na webovém portálu přidáním dalších dat ke stávajícímu účtu, webový portál by měl vyvolat API MobilePlansInlineOperations.notifyBalanceAddition
k navrácení kontroly zpět do aplikace Mobile Plans. To se dá použít pro profil eSIM, který je už v zařízení nainstalovaný. Parametr ICCID označuje, který profil eSIM se má aktivovat.
Následující diagram ukazuje, jak aplikace Mobile Plans podporuje přidání zůstatku pomocí informací o iccid.
MobilePlansInlineOperations.notifyBalanceAddition(purchaseMetaData, iccid)
Název parametru | Typ | Popis |
---|---|---|
metadata nákupu | Objekt | Tento objekt obsahuje metadata o nákupu uživatele. To zahrnuje podrobnosti o uživatelském účtu, metodě nákupu nebo instrumentu, podrobnosti o tom, jestli uživatel přidává nový řádek, a název plánu, který uživatel zakoupil. Všechny se používají pro hlášení. |
iccid (identifikátor integrované obvodové karty) | Řetězec | ICCID, který by měl být aktivní po přidání kreditu |
Návratový typ hodnoty | Popis |
---|---|
cs-CZ: KontextOperacíMobilníchPlánů | Objekt s identifikátory, které odpovídají této jedinečné operaci stahování. |
Pokud je identifikátor ICCID profilu známý, je možné do neaktivního profilu provést také přidání zůstatku. Použití MobilePlansInlineOperations.notifyBalanceAddition
s ICCID informuje aplikaci o přidání zůstatku a také přepne aktivní profil na profil odpovídající zadanému ICCID.
Následující funkce JavaScriptu ukazuje příklad rozhraní API pro informování aplikace, že bylo provedeno přidání zůstatku.
function NotifyMobilePlans() {
var purchaseMetaData = MobilePlans.createPurchaseMetaData();
purchaseMetaData.userAccount = MobilePlansUserAccount.new;
purchaseMetaData.purchaseInstrument = MobilePlansPurchaseInstrument.new;
purchaseMetaData.lineType = MobilePlansLineType.new;
purchaseMetaData.modirectStatus = MobilePlansMoDirectStatus.complete;
purchaseMetaData.planName = "My Plan";
MobilePlansInlineOperations.notifyBalanceAddition(purchaseMetaData, "8900000000000000001");
}
Podrobné informace o objektu puchaseMetadata
viz vlastnosti metadat nákupu .
Zrušení toku nákupu
Pokud uživatel zruší tok aktivace na webovém portálu, musí portál vyvolat rozhraní API MobilePlans.notifyCancelledPurchase
a vrátit řízení zpět do aplikace Mobile Plans.
MobilePlány.oznámitZrušeníNákupu
Název parametru | Typ | Popis |
---|---|---|
purchaseMetadata | Objekt | Tento objekt obsahuje metadata o nákupu uživatele. To zahrnuje podrobnosti o uživatelském účtu, metodě nákupu nebo instrumentu, podrobnosti o tom, jestli uživatel přidává nový řádek, a název plánu, který uživatel zakoupil. Všechny se používají pro vykazování. |
Následující funkce JavaScriptu ukazuje příklad rozhraní API, který informuje aplikaci, že uživatel zrušil nákup.
function finishPurchaseWithCancellation() {
var metadata = MobilePlans.createPurchaseMetaData();
metadata.userAccount = MobilePlansUserAccount.new;
metadata.purchaseInstrument = MobilePlansPurchaseInstrument.new;
metadata.moDirectStatus = MobilePlansMoDirectStatus.cancelled;
metadata.line = MobilePlansLineType.bailed;
metadata.planName = "";
MobilePlans.notifyCancelledPurchase(metadata);
}
Podrobnosti o objektu puchaseMetadata
najdete v části věnované vlastnostem metadat nákupu.
Podrobnosti o metadatových vlastnostech nákupu
Následující tabulka popisuje podrobnosti použité v metadatech nákupu.
Název vlastnosti | Typ | Popis | Příklad | Povinné nebo volitelné |
---|---|---|---|---|
uživatelský účet | Řetězec | Možné hodnoty:
|
"userAccount":"Nový" | Volitelný |
purchaseInstrument | Řetězec | Možné hodnoty:
|
"purchaseInstrument":"Nový" | Volitelný |
řádek | Řetězec | Možné hodnoty:
|
"line":"Nový" | Volitelný |
moDirectStatus | Řetězec | Možné hodnoty:
|
"moDirectStatus":"Dokončeno" | Požadovaný |
název plánu | Řetězec | Pro úspěšnou transakci nesmí být toto pole prázdné a musí obsahovat popisný název plánu. Pro neúspěšnou transakci musí být toto pole prázdné. | "planName":"2GB Měsíčně" | Neprázdný řetězec Povinný |
Podrobnosti o MobilePlansOperationContext
Následující tabulka popisuje vlastnosti MobilePlansOperationContext.
Název vlastnosti | Typ | Popis |
---|---|---|
Id | řetězec | jedinečné ID vytvořené aplikací pro operaci |
Oznámení o zpětných voláních staršího typu
Podívejte se na konkrétní stránku, kde jsou všechny starší zpětná volání zdokumentovaná.