MultiTEL
Vývojáři

GET/tcr/v2/enum/{type}

Načtení katalogů pro registraci zasílání zpráv

Načtěte aktuální možnosti pro značky a kampaně pro zasílání zpráv, včetně typů podniků, odvětví a případů použití. Tyto katalogy poskytují hodnoty pro formuláře; neregistrují ani neschvalují kampaň.

Na této stránce
  1. Načtěte možnosti před sestavením registračního formuláře
  2. Vyberte katalog
  3. Zpracujte odpověď TCR přímo
  4. Rozlišujte možnosti katalogu, způsobilost a ceny
  5. Ošetřete nedostupné katalogy
  6. Požadavek
  7. Odpověď
  8. Chyby
  9. Dostupnost a vedlejší účinky

Načtěte možnosti před sestavením registračního formuláře

Možnosti vyplňujte z aktuálního katalogu pro registraci zasílání zpráv namísto pevného zadávání hodnot registru do kódu. Pro formulář značky portál načítá katalogy typů podniků, odvětví, typů alternativních identifikátorů podniku, vztahů ke značce, zemí, států USA a burz. Pro formulář kampaně načítá případy použití, platné dílčí případy použití a partnery zajišťující konektivitu. Každou vrácenou strojovou hodnotu uchovejte společně s jejím zobrazovaným popiskem; při sestavování pozdějšího požadavku použijte hodnotu, nikoli přeložený popisek.

Vyberte katalog

Katalogy používané portálem
NázevÚčel
usecaseDefinice případů použití kampaní. Při načítání možností dílčích případů použití přidejte validSubUsecase=true.
entityTypeTyp podniku nebo organizace pro značku.
verticalMožnosti odvětví pro značku.
altBusinessIdTypeKategorie alternativních identifikátorů podniku.
brandRelationshipMožnosti vztahu používané v registračním formuláři.
countryMožnosti zemí v registru; jsou oddělené od zemí, ve kterých jsou dostupná telefonní čísla.
usStateMožnosti států USA pro registrační adresy.
stockExchangeMožnosti burz pro případy, kdy je vyžaduje typ podniku značky.
cnpIdentifikátory partnerů zajišťujících konektivitu. Vyberte partnera, kterého podporuje pracovní postup kampaní vašeho účtu.

Zpracujte odpověď TCR přímo

Tělo odpovědi pochází přímo z TCR API. Na rozdíl od mnoha starších koncových bodů /v3 nemá přidanou obálku status/response. Před interpretací těla zkontrolujte stav HTTP. Katalog může obsahovat textové popisky nebo strukturované definice, proto nepředpokládejte, že každá hodnota má stejná pole. Pokud požadavek HTTP uspěje, ale tělo není platný JSON s očekávanou strukturou, ohlaste neúspěšné načtení namísto tichého nahrazení prázdným seznamem.

Rozlišujte možnosti katalogu, způsobilost a ceny

Obecný katalog případů použití neuvádí, pro které případy použití je konkrétní značka způsobilá. Současný portál před vytvořením kampaně ověřuje způsobilost konkrétní značky a kontroluje požadavky vybraného operátora. Stejně tak metadata poplatků dodavatele nejsou konečnou maloobchodní cenou pro účet. Příslušnou cenu pro účet a podmínky registrace posuďte samostatně. Načtení katalogu neznamená schválení značky, kampaně ani čísla pro zasílání zpráv.

Ošetřete nedostupné katalogy

Pokud načtení selže, zachovejte údaje, které zákazník zadal do formuláře. Zobrazte chybu, respektujte Retry-After při jeho vrácení a postupně prodlužujte intervaly mezi opakovanými pokusy. Nenačítejte opakovaně všechny katalogy a nepovažujte chybu omezení četnosti požadavků ani chybu přenosu za prázdný platný katalog. Tento požadavek GET nevyžaduje klíč idempotence a nepřehrává se z úložiště idempotence změnových operací.

Požadavek

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

Použijte GET s podporovaným názvem katalogu v cestě. Příslušné filtry katalogu předejte v řetězci dotazu. Tělo požadavku není potřeba.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"
Parametry cesty
NázevTypPovinnýPopis
typeřetězecAnoNázev katalogu s původní velikostí písmen. Portál používá usecase, entityType, vertical, altBusinessIdType, brandRelationship, country, usState, stockExchange a cnp. Jde o názvy katalogů, nikoli o identifikátory značek nebo kampaní.
Parametry dotazu
NázevTypPovinnýPopis
validSubUsecaselogická hodnotaNeU katalogu usecase portál požaduje hodnotu true, aby načetl možnosti platných dílčích případů použití. Při načítání běžného katalogu případů použití tento parametr vynechte. Dostupnost a definice poskytuje registr.

Odpověď

Tato trasa TCR vrací přímo tělo odpovědi registru s jeho stavem HTTP. Nepoužívá starší obálku v3 ve tvaru status.code/status.msg/response. Struktury katalogů se liší: některé mapují hodnoty na popisné objekty, jiné na řetězce. Při pozdějším odesílání formuláře zachovejte strojově čitelné klíče. Zkrácený fiktivní příklad usecase znázorňuje mapu s objektovými hodnotami, nikoli aktuální katalog ani zaručeně úplné schéma. Kontrolujte stav HTTP i očekávanou strukturu JSON.

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

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Chyby

  • 401: Autentizace účtu selhala. Zkontrolujte přihlašovací údaj API, zda je účet aktivovaný, a příslušná omezení zdrojových IP adres.
  • 400/404 a další chyby registru: Neplatný nebo nedostupný katalog či filtr. Současná trasa zachovává stav HTTP a tělo odpovědi nadřazené služby; neexistuje univerzální obálka chyb v3.
  • 429: Byl dosažen limit požadavků účtu nebo sdílený limit poskytovatele. Respektujte Retry-After a při opakování postupně prodlužujte intervaly mezi pokusy.
  • 502: Nepodařilo se spojit s registrem. Dostupnost není známa; nenahrazujte výsledek prázdnými možnostmi vydávanými za úspěšný výsledek.
  • 503: Omezovač požadavků nebo nadřazená služba je nedostupná. Před opakováním zkontrolujte tělo odpovědi a případnou hlavičku Retry-After.

Dostupnost a vedlejší účinky

  • Tento katalogový požadavek GET v prověřené cestě nevytváří značku ani kampaň, neodesílá registraci, nerezervuje prostředek ani neúčtuje registrační poplatek. Kontaktuje poskytovatele a zapisuje auditní záznamy požadavků.
  • Definice katalogů ani případná metadata poplatků dodavatele nejsou maloobchodní cenovou nabídkou pro zákazníka. Současný portál získává maloobchodní ceny kampaní samostatně; starší pomocná funkce getCampaignPrice ani staré cenové anotace výčtových typů se nesmějí považovat za závazné vymezení cen této trasy.
  • Podporovaná položka katalogu není důkazem, že je konkrétní značka pro daný případ použití způsobilá. Před pozdějším požadavkem na registraci dokončete ověření způsobilosti konkrétní značky, prohlášení, souhlas a kontrolu cen pro účet.