Válasszon ki egy meglévő márkát a fiókjában
A MultiTEL-fiókjához már hozzárendelt nyilvántartási márkaazonosítóból induljon ki. Ez a lekérdezés nem hoz létre márkát, és nem rendel más tulajdonában lévő márkát a fiókjához. A jelenlegi ügyfélfolyamat a jogosultságok lekérése előtt ellenőrzi a tulajdonjogot. Ha a lekérdezés 404 választ ad, ellenőrizze a kiválasztott fiókot és márkát ahelyett, hogy helyi sorazonosítót használna.
Az eredmény alapján állítsa össze a választható felhasználási eseteket
Az általános felhasználásieset-katalógus a nyilvántartásban elérhető lehetőségeket ismerteti. Ez a márkaspecifikus lekérdezés a kiválasztott márkához biztosítja a választható lehetőségeket. Őrizzen meg minden visszaadott usecase értéket, és társítsa hozzá a katalógusban szereplő megjelenítési címkét és leírást. Ne kínálja fel az általános katalógus összes bejegyzését úgy, mintha a márka mindegyikre jogosult lenne.
A portál ezt a választ JSON-listaként várja. Ha a válasz hiányzik, hibás formátumú vagy hibát jelez, őrizze meg az ügyfél űrlapját, és jelezze, hogy a jogosultsági adatokat nem sikerült betölteni. Ne tekintse ezt jelzés nélkül egy alapértelmezett felhasználási eset jóváhagyásának. A nyilvántartás a rövidített példában szereplőkön kívül további mezőket is visszaadhat.
Töltse be a kiválasztott felhasználási eset követelményeit
Miután az ügyfél kiválasztott egyet a visszaadott felhasználásieset-értékek közül, kérje le a következő végpontot: /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} ugyanahhoz a márkához. Ez a válasz tartalmazza az alárendelt felhasználási esetek korlátait és a mobilszolgáltató-specifikus követelményeket. Ennek alapján gyűjtse be az üzenetmintákat, a hozzájárulást és az egyéb kötelező nyilatkozatokat. A jogosultsági lista önmagában nem elegendő egy teljes kampányregisztráció összeállításához.
Külön tekintse át a fiókhoz tartozó árakat
Az olyan szolgáltatói mezők, mint a monthlyFee, quarterlyFee vagy az annualFee, ha szerepelnek a válaszban, a szolgáltatói díjak metaadatait írják le. Nem helyettesítik az ügyfél fiókjához tartozó árat vagy a regisztráció feltételeit. A jelenlegi portál külön olvassa be a kampányok ügyfélárait, és az áttekintő képernyőhöz összekapcsolja őket a jogosultsági adatokkal. Ne következtessen az ügyfélnek felszámítandó díjra a régi felsorolástípus-segéd kódba rögzített áraiból.
Frissítse az adatokat a márka vagy a felhasználási eset megváltozásakor
Márkaváltáskor törölje az előző márkához tartozó választási lehetőségeket, és töltse be az újonnan kiválasztott márka jogosultsági adatait. Beküldés előtt frissítse a kiválasztott felhasználási eset követelményeit. Ezek a GET kérések nem küldenek be regisztrációt, nem aktiválnak kampányt, és nem rendelnek hozzá telefonszámokat.
Kérés
Használjon engedélyezett API-fiókot HTTPS kapcsolaton keresztül, engedélyezett forrás IP-címről. A jelenlegi útvonal támogatja a fiók hitelesítési szabályzatát, beleértve a Basic hitelesítést és az engedélyezett, bearer tokennel hitelesített API-fiókokat. Ne használja a szolgáltató hitelesítő adatait.
GET kérés, az URL útvonalában megadott márkaazonosítóval. Kéréstörzs nem szükséges.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Név | Típus | Kötelező | Leírás |
|---|---|---|---|
brand_id | karakterlánc | Igen | A hitelesített MultiTEL-fiókjához hozzárendelt nyilvántartási márkaazonosító. A márkaazonosítót használja, ne helyi adatbázissor-azonosítót, kampányazonosítót vagy vállalkozási adószámot. Egyetlen URL-útvonalszegmensként kódolja. |
Válasz
A jelenlegi TCR útvonal közvetlenül adja vissza a nyilvántartás JSON törzsét, és megőrzi annak HTTP állapotkódját. Nem adja hozzá a régi v3 status/response burkolót. A rövidített, kitalált példa nem élő jogosultsági eredmény. Felhasználás előtt ellenőrizze a HTTP állapotkódot és az elvárt JSON struktúrát. A jelenlegi portál jogosultsági rekordok listáját várja, amelyek mindegyike egy usecase értéket azonosít. A megjelenítési címkékhez ezeket a rekordokat a usecase katalógussal kapcsolja össze, az ügyfélárakat pedig külön olvassa be. További szolgáltatói mezők is jelen lehetnek.
Szemléltető válaszstruktúra; nem élő fiókadat és nem aktuális árajánlat.
[
{
"usecase": "2FA"
}
]Hibák
- 401: A fiók hitelesítése sikertelen. Ellenőrizze az API hitelesítő adatait, a fiók engedélyezett állapotát és az érvényes forrás-IP-korlátozásokat.
- 404: A márka nincs hozzárendelve a hitelesített fiókhoz, vagy a szolgáltató nem találja a kért márkát vagy kiválasztott lehetőséget. A helyi tulajdonjog-ellenőrzés miatti elutasítás a szolgáltatói kérés elküldése előtt érkezik vissza.
- Egyéb nyilvántartási hibák: A háttérszolgáltatás HTTP állapotkódja és választörzse változatlan marad. Az érvénytelen vagy nem elérhető felhasználási eset nem jelent sikeresen lekért, üres követelményhalmazt.
- 429: A fiókhoz tartozó vagy a megosztott szolgáltatói kérési korlát elérve. Tartsa be a Retry-After fejlécben megadott várakozási időt.
- 502/503: Átviteli hiba, illetve a szolgáltató vagy a kérésgyakoriság-korlátozó elérhetőségi hibája. Őrizze meg az űrlapot, és növekvő várakozási időkkel próbálkozzon újra.
Elérhetőség és mellékhatások
- A felülvizsgált GET kérés ellenőrzi a meglévő márka tulajdonjogát, kapcsolatba lép a nyilvántartással, és kérésaudit-bejegyzéseket ír. Nem hoz létre márkát vagy kampányt, és nem számít fel regisztrációs díjat.
- A szolgáltatói díjak metaadatai nem minősülnek a MultiTEL ügyfelének szóló kiskereskedelmi árajánlatnak. A portál egy későbbi regisztrációs kérés előtt külön tekinti át a fiókhoz tartozó árakat.
- A jogosultság és a követelmények változhatnak. Beküldés előtt frissítse őket a kiválasztott márkához és felhasználási esethez. A sikeres lekérdezés nem jelent kampányjóváhagyást, telefonszám-hozzárendelést vagy engedélyt az üzenetküldés megkezdésére.