MultiTEL
Vývojáři

GET/tcr/v2/campaignBuilder/brand/{brand_id}

Zjistěte dostupné účely kampaní pro značku

Než zákazníka požádáte o nastavení kampaně, zjistěte, jaké účely kampaní registr nabízí pro existující značku na vašem účtu.

Na této stránce
  1. Vyberte existující značku na svém účtu
  2. Sestavte nabídku účelů kampaně podle tohoto výsledku
  3. Načtěte požadavky pro vybraný účel kampaně
  4. Ceny pro účet posuzujte samostatně
  5. Při změně značky nebo účelu kampaně údaje obnovte
  6. Požadavek
  7. Odpověď
  8. Chyby
  9. Dostupnost a vedlejší účinky

Vyberte existující značku na svém účtu

Začněte identifikátorem značky v registru, který je již přiřazen k vašemu účtu MultiTEL. Toto vyhledání nevytvoří značku ani k vašemu účtu nepřiřadí cizí značku. Současný zákaznický postup před vyžádáním údajů o způsobilosti ověřuje vlastnictví. Pokud vyhledání vrátí 404, ověřte vybraný účet a značku; nenahrazujte identifikátor značky identifikátorem řádku v místní databázi.

Sestavte nabídku účelů kampaně podle tohoto výsledku

Obecný katalog účelů kampaní popisuje možnosti registru. Toto vyhledání pro konkrétní značku poskytuje možnosti dostupné pro vybranou značku. Zachovejte každou vrácenou hodnotu pole usecase a doplňte ji zobrazovaným názvem a popisem z katalogu. Nenabízejte všechny položky obecného katalogu, jako by značka splňovala podmínky pro každou z nich.

Portál očekává tuto odpověď jako seznam ve formátu JSON. Pokud odpověď chybí, má nesprávný formát nebo obsahuje chybu, zachovejte zákazníkův formulář a zobrazte informaci, že údaje o způsobilosti nebylo možné načíst. Nepovažujte takovou odpověď bez upozornění za schválení výchozího účelu kampaně. Registr může vrátit i další pole, která zkrácený příklad neuvádí.

Načtěte požadavky pro vybraný účel kampaně

Jakmile zákazník vybere jednu z vrácených hodnot účelu kampaně, odešlete požadavek na /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} pro tutéž značku. Odpověď poskytuje omezení dílčích účelů kampaně a požadavky jednotlivých operátorů. Na jejím základě shromážděte ukázky zpráv, souhlas a další požadovaná prohlášení. Samotný seznam způsobilých účelů nestačí k sestavení úplné registrace kampaně.

Ceny pro účet posuzujte samostatně

Pole poskytovatele, například monthlyFee, quarterlyFee nebo annualFee, pokud jsou vrácena, obsahují metadata o poplatcích poskytovatele. Nenahrazují cenu platnou pro zákazníkův účet ani podmínky registrace. Současný portál načítá maloobchodní ceny kampaní samostatně a na obrazovce pro kontrolu je spojuje s údaji o způsobilosti. Neodvozujte poplatek pro zákazníka z cen pevně zadaných ve staré pomocné funkci pro výčtové typy.

Při změně značky nebo účelu kampaně údaje obnovte

Při přepnutí značky zahoďte možnosti předchozí značky a načtěte údaje o způsobilosti pro nově vybranou značku. Před odesláním obnovte požadavky vybraného účelu kampaně. Tyto požadavky GET neodesílají registraci, neaktivují kampaň ani nepřiřazují čísla.

Požadavek

Použijte aktivovaný účet API přes HTTPS z povolené zdrojové IP adresy. Současná cesta podporuje zásady autentizace účtu, včetně autentizace Basic a aktivovaných účtů API s autentizací pomocí tokenu bearer. Nepoužívejte přihlašovací údaje poskytovatele.

Požadavek GET s identifikátorem značky v cestě URL. Tělo požadavku není vyžadováno.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"
Parametry cesty
NázevTypPovinnéPopis
brand_idřetězecAnoIdentifikátor značky v registru přiřazený k vašemu autentizovanému účtu MultiTEL. Použijte identifikátor značky, nikoli identifikátor řádku v místní databázi, identifikátor kampaně nebo daňové identifikační číslo firmy. Zakódujte jej jako jeden segment cesty URL.

Odpověď

Současná cesta TCR vrací přímo tělo odpovědi registru ve formátu JSON a zachovává jeho stav HTTP. Nepřidává starší obálku status/response z verze v3. Zkrácený smyšlený příklad není aktuálním výsledkem ověření způsobilosti. Před použitím zkontrolujte stav HTTP a očekávanou strukturu JSON. Současný portál očekává seznam záznamů o způsobilosti, z nichž každý určuje hodnotu usecase. Tyto záznamy propojuje s katalogem usecase, aby získal zobrazované názvy, a maloobchodní ceny načítá samostatně. Mohou být přítomna i další pole poskytovatele.

Ukázková struktura odpovědi; nejde o aktuální údaje účtu ani o aktuální cenovou nabídku.

[
  {
    "usecase": "2FA"
  }
]

Chyby

  • 401: Autentizace účtu selhala. Zkontrolujte přihlašovací údaje API, zda je účet aktivovaný, a příslušná omezení zdrojových IP adres.
  • 404: Značka není přiřazena k autentizovanému účtu nebo poskytovatel nemůže požadovanou značku či vybranou možnost najít. Místní zamítnutí kvůli vlastnictví se vrací ještě před odesláním požadavku poskytovateli.
  • Ostatní chyby registru: Stav HTTP a tělo odpovědi nadřazené služby se zachovávají. Neplatný nebo nedostupný účel kampaně neznamená úspěšnou odpověď s prázdnou sadou požadavků.
  • 429: Byl dosažen limit požadavků účtu nebo sdílený limit poskytovatele. Dodržujte Retry-After.
  • 502/503: Selhání přenosu nebo nedostupnost poskytovatele či omezovače četnosti požadavků. Zachovejte formulář a opakujte pokus s postupným prodlužováním prodlevy.

Dostupnost a vedlejší účinky

  • Zkontrolovaný požadavek GET ověřuje vlastnictví existující značky, kontaktuje registr a zapisuje auditní záznamy požadavků. Nevytváří značku ani kampaň a neúčtuje registrační poplatek.
  • Metadata o poplatcích poskytovatele nejsou maloobchodní cenovou nabídkou pro zákazníka MultiTEL. Portál posuzuje ceny pro účet samostatně před pozdějším požadavkem na registraci.
  • Způsobilost a požadavky se mohou změnit. Před odesláním je obnovte pro vybranou značku a účel kampaně. Úspěšné vyhledání neznamená schválení kampaně, přiřazení čísel ani povolení začít odesílat zprávy.