Vývojáři

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

Přečtěte si požadavky na kampaň pro značku

Před přípravou registrace kampaně si přečtěte meze dílčích případů užití, způsobilost operátorů a požadavky na zprávy pro vybraný případ užití.

Na této stránce
  1. Udržujte značku a případ užití pohromadě
  2. Přečtěte si aktuální požadavky
  3. Uplatněte požadavky vybraných operátorů společně
  4. Připravte ukázky a odpovědi odběratelům
  5. Kontrola před jakýmkoli požadavkem na registraci
  6. Řešení neúspěšného vyhledání požadavků
  7. Požadavek
  8. Odpověď
  9. Chyby
  10. Dostupnost a vedlejší účinky

Udržujte značku a případ užití pohromadě

Použijte ID značky na svém účtu a hodnotu případu užití vrácenou kvalifikačním seznamem téže značky. Zákaznický pracovní postup kontroluje vlastnictví před požadavkem na poskytovatele. Ověřte, že hodnota usecase ve vráceném objektu odpovídá vybrané hodnotě. Vyhledání pro jednu značku nebo případ užití nestanovuje požadavky pro jinou značku ani jiný případ užití.

Přečtěte si aktuální požadavky

Požadavky používané aktuálním formulářem kampaně
PoleJak jej portál používá
minSubUsecases / maxSubUsecasesMinimální a maximální počet dílčích případů užití pro tento výběr. Vybírejte hodnoty z katalogu platných dílčích případů užití, nikoli volný text.
mnoMetadataPožadavky specifické pro operátora, indexované podle ID operátora. Pro výběr operátorů používejte ID přítomná v aktuální odpovědi.
mnoSupport / qualifyPodpora a kvalifikace operátora. Portál vylučuje operátory, kteří mají u kteréhokoli z těchto polí výslovně nastaveno false, a vyžaduje alespoň jednoho způsobilého vybraného operátora.
minMsgSamplesPožadovaný počet ukázek pro operátora. Portál vyžaduje alespoň jednu neprázdnou ukázku a splňuje nejvyšší minimum mezi způsobilými vybranými operátory.
reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelpPožadovaná prohlášení o odběratelích. Tam, kde jsou vyžadována, musí mít odpovídající prohlášení hodnotu true. Povolená prohlášení navíc potřebují svá pole s klíčovými slovy a textem odpovědi.
noEmbeddedLink / noEmbeddedPhoneOmezení vložených odkazů nebo telefonních čísel. Portál odmítne deklarovanou funkci, pokud ji způsobilý vybraný operátor zakazuje.

Uplatněte požadavky vybraných operátorů společně

Požadavky operátorů se mohou lišit. Pokud není zadán explicitní seznam operátorů, portál zohledňuje všechna metadata operátorů v odpovědi; neprázdný seznam omezuje kontroly na vybraná ID. Nepoužívejte pouze počet ukázek nebo prohlášení prvního operátora. Vyberte operátory z odpovědi, zkontrolujte podporu a kvalifikaci, splňte nejvyšší platné minimum ukázek a splňte požadovaná prohlášení o přihlášení (opt-in), odhlášení (opt-out) a nápovědě napříč tímto výběrem. Portál odmítne vybraná ID operátorů, která v aktuální odpovědi chybí, a odmítne výběr bez způsobilého operátora.

Požadavky popisují, co je třeba dodat; neprokazují, že proces získávání souhlasu zákazníka nebo obsah kampaně tyto požadavky splňuje. Shromážděte pravdivé, reprezentativní ukázky a prohlášení. Nezapínejte prohlášení automaticky jen proto, aby formulář prošel.

Připravte ukázky a odpovědi odběratelům

Aktuální formulář kampaně používá pro ukázky zpráv pole sample1 až sample5. Pokud požadavky nelze splnit v rámci dostupného formuláře, zastavte se a vyřešte výběr s podporou. Pro povolené prohlášení o odběratelích zadejte jeho odpovídající klíčová slova a text odpovědi: optinKeywords/optinMessage, optoutKeywords/optoutMessage a helpKeywords/helpMessage. Udržujte ukázky v souladu se zvoleným případem užití a skutečnou komunikací se zákazníky.

Kontrola před jakýmkoli požadavkem na registraci

Obnovte požadavky, kdykoli se změní značka, případ užití nebo výběr operátorů. Portál před vytvořením znovu ověřuje vybraný případ užití, počet dílčích případů užití, způsobilost operátorů, ukázky a prohlášení. Ceník účtu a podmínky registrace zkontrolujte samostatně. Tento GET kampaň neregistruje ani neschvaluje, nesdílí ji s operátorem zpráv ani nepřiřazuje telefonní číslo. Vytvoření a zprovoznění jsou samostatné operace.

Řešení neúspěšného vyhledání požadavků

Pokud požadavek selže, vrátí neočekávaný JSON nebo neodpovídá vybranému případu užití, ponechte formulář nedokončený a umožněte zákazníkovi opakovat pokus po vyřešení chyby. Nenahrazujte nedostupné požadavky prázdným objektem a nepředpokládejte, že chybějící data znamenají žádné požadavky. Respektujte hlavičku Retry-After a pro limity požadavků a výpadky dostupnosti používejte odstup mezi opakováními (backoff).

Požadavek

Použijte povolený účet API přes HTTPS z povolené zdrojové IP adresy. Aktuální cesta podporuje zásady ověřování účtu, včetně ověřování Basic a povolených účtů API s tokenem bearer. Nepoužívejte přihlašovací údaje poskytovatele.

GET s ID značky a vybranou hodnotou případu užití 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/usecase/$USECASE"
Parametry cesty
NázevTypPovinnéPopis
brand_idstringAnoID značky v registru spojené s vaším ověřeným účtem MultiTEL. Použijte ID značky, nikoli ID řádku v místní databázi, ID kampaně ani daňové identifikační číslo firmy. Zakódujte je jako jeden segment cesty URL.
usecasestringAnoStrojově čitelná hodnota usecase vybraná z kvalifikačního seznamu téže značky. Zachovejte velikost písmen; neodesílejte přeložený zobrazovaný popisek. Zakódujte ji jako jeden segment cesty URL.

Odpověď

Aktuální cesta TCR vrací tělo JSON z registru přímo a zachovává jeho stav HTTP. Nepřidává starší obálku status/response z verze v3. Zkrácený smyšlený příklad není živý výsledek kvalifikace. Před použitím zkontrolujte stav HTTP a očekávaný tvar JSON. Portál očekává objekt, jehož usecase odpovídá vybranému případu užití. Požadavky operátorů jsou pod mnoMetadata, indexované podle ID operátora. Ukázkové ID operátora a požadavky jsou smyšlené. Mohou být vrácena i další pole poskytovatele.

Ilustrativní tvar odpovědi; nejde o živá data účtu ani aktuální cenovou nabídku.

{
  "usecase": "2FA",
  "minSubUsecases": 0,
  "maxSubUsecases": 0,
  "mnoMetadata": {
    "12345": {
      "mnoSupport": true,
      "qualify": true,
      "minMsgSamples": 1,
      "reqSubscriberOptin": true,
      "reqSubscriberOptout": true,
      "reqSubscriberHelp": true,
      "noEmbeddedLink": false,
      "noEmbeddedPhone": false
    }
  }
}

Chyby

  • 401: Ověření účtu selhalo. Zkontrolujte přihlašovací údaje API, stav povolení a platná omezení zdrojových IP adres.
  • 404: Značka není spojena s ověřeným účtem, nebo poskytovatel nemůže najít požadovanou značku či výběr. Místní zamítnutí vlastnictví je vráceno před požadavkem na poskytovatele.
  • Ostatní chyby registru: Stav HTTP a tělo z nadřazeného systému jsou zachovány. Neplatný nebo nedostupný případ užití není úspěšná prázdná sada požadavků.
  • 429: Byl dosažen limit požadavků účtu nebo sdílený limit poskytovatele. Respektujte Retry-After.
  • 502/503: Výpadek dostupnosti přenosu, poskytovatele nebo omezovače požadavků. Zachovejte formulář a opakujte pokus s odstupem (backoff).

Dostupnost a vedlejší účinky

  • Zkontrolovaný GET ověřuje stávající vlastnictví 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í cenová nabídka pro zákazníky MultiTEL. Portál před pozdějším požadavkem na registraci kontroluje ceník účtu samostatně.
  • Kvalifikace a požadavky se mohou změnit. Před odesláním je obnovte pro vybranou značku a případ užití. Úspěšné vyhledání není schválení kampaně, přiřazení čísla ani povolení zahájit odesílání zpráv.