Perskaitykite prekės ženklo kampanijos reikalavimus

Laikykite prekės ženklą ir naudojimo atvejį kartu

Naudokite savo paskyros prekės ženklo ID ir naudojimo atvejo reikšmę, grąžintą to paties prekės ženklo kvalifikacijos sąraše. Kliento darbo eiga patikrina nuosavybę prieš užklausą tiekėjui. Įsitikinkite, kad grąžinto objekto usecase atitinka pasirinktą reikšmę. Vieno prekės ženklo ar naudojimo atvejo paieška nenustato reikalavimų kitam.

Perskaitykite dabartinius reikalavimus

Dabartinėje kampanijos formoje naudojami reikalavimai
Laukas	Kaip portalas jį naudoja
minSubUsecases / maxSubUsecases	Mažiausias ir didžiausias papildomų naudojimo atvejų skaičius šiam pasirinkimui. Rinkitės reikšmes iš galiojančio papildomų naudojimo atvejų katalogo, o ne laisvą tekstą.
mnoMetadata	Konkrečių operatorių reikalavimai, indeksuoti pagal operatoriaus ID. Operatoriams pasirinkti naudokite dabartiniame atsakyme esančius ID.
mnoSupport / qualify	Operatoriaus palaikymas ir kvalifikacija. Portalas neįtraukia operatorių, kurių bet kuris iš šių laukų aiškiai pažymėtas false, ir reikalauja bent vieno tinkamo pasirinkto operatoriaus.
minMsgSamples	Operatoriui reikalingas pavyzdžių skaičius. Portalas reikalauja bent vieno netuščio pavyzdžio ir tenkina didžiausią minimumą tarp tinkamų pasirinktų operatorių.
reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp	Privalomos abonento deklaracijos. Kai jos privalomos, atitinkama deklaracija turi būti true. Įjungtoms deklaracijoms taip pat reikia jų raktažodžių ir atsakymo pranešimo laukų.
noEmbeddedLink / noEmbeddedPhone	Įterptų nuorodų ar telefono numerių apribojimai. Portalas atmeta deklaruotą funkciją, jei tinkamas pasirinktas operatorius ją draudžia.

Taikykite pasirinktų operatorių reikalavimus kartu

Operatorių reikalavimai gali skirtis. Kai aiškus operatorių sąrašas nepateikiamas, portalas atsižvelgia į visus atsakyme esančius operatorių metaduomenis; netuščias sąrašas apriboja patikrinimus tais pasirinktais ID. Nenaudokite tik pirmojo operatoriaus pavyzdžių skaičiaus ar deklaracijų. Pasirinkite operatorius iš atsakymo, patikrinkite palaikymą ir kvalifikaciją, tenkinkite didžiausią taikomą pavyzdžių minimumą ir įvykdykite privalomas sutikimo (opt-in), atsisakymo (opt-out) ir pagalbos deklaracijas visame tame pasirinkime. Portalas atmeta pasirinktus operatorių ID, kurių nėra dabartiniame atsakyme, ir atmeta pasirinkimą be tinkamo operatoriaus.

Reikalavimai aprašo, ką reikia pateikti; jie neįrodo, kad kliento sutikimo procesas ar kampanijos turinys atitinka tuos reikalavimus. Surinkite teisingus, reprezentatyvius pavyzdžius ir deklaracijas. Neįjunkite deklaracijų automatiškai vien tam, kad forma būtų priimta.

Parenkite pavyzdžius ir atsakymus abonentams

Dabartinė kampanijos forma naudoja laukus nuo sample1 iki sample5 pranešimų pavyzdžiams. Jei reikalavimų negalima įvykdyti turimoje formoje, sustokite ir išspręskite pasirinkimą su palaikymo tarnyba. Įjungtai abonento deklaracijai pateikite atitinkamus raktažodžius ir atsakymo tekstą: optinKeywords/optinMessage, optoutKeywords/optoutMessage ir helpKeywords/helpMessage. Pavyzdžiai turi atitikti pasirinktą naudojimo atvejį ir faktinius kliento pranešimus.

Peržiūrėkite prieš bet kokią registracijos užklausą

Atnaujinkite reikalavimus, kai pasikeičia prekės ženklas, naudojimo atvejis ar operatorių pasirinkimas. Prieš kūrimą portalas iš naujo patikrina pasirinktą naudojimo atvejį, papildomų naudojimo atvejų skaičių, operatorių tinkamumą, pavyzdžius ir deklaracijas. Paskyros kainodarą ir registracijos sąlygas peržiūrėkite atskirai. Ši GET užklausa neregistruoja ir nepatvirtina kampanijos, nesidalija ja su pranešimų operatoriumi ir nepriskiria telefono numerio. Kūrimas ir aprūpinimas yra atskiros operacijos.

Apdorokite nepavykusią reikalavimų paiešką

Jei užklausa nepavyksta, grąžina netikėtą JSON arba neatitinka pasirinkto naudojimo atvejo, palikite formą neužbaigtą ir leiskite klientui bandyti dar kartą, kai klaida bus pašalinta. Nekeiskite neprieinamų reikalavimų tuščiu objektu ir nemanykite, kad trūkstami duomenys reiškia, jog reikalavimų nėra. Laikykitės Retry-After antraštės ir, esant užklausų limitų ar prieinamumo klaidoms, naudokite atidėjimą (backoff).

Užklausa

Naudokite įjungtą API paskyrą per HTTPS iš leidžiamo šaltinio IP adreso. Dabartinis maršrutas palaiko paskyros autentifikavimo politiką, įskaitant Basic autentifikavimą ir įjungtas „bearer“ API paskyras. Nenaudokite tiekėjo prisijungimo duomenų.

GET užklausa su prekės ženklo ID ir pasirinkto naudojimo atvejo reikšme URL kelyje. Užklausos turinys nereikalingas.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"

Kelio parametrai
Pavadinimas	Tipas	Privalomas	Aprašymas
`brand_id`	string	Taip	Registro prekės ženklo ID, susietas su jūsų autentifikuota MultiTEL paskyra. Naudokite prekės ženklo ID, o ne vietinės duomenų bazės eilutės ID, kampanijos ID ar įmonės mokesčių mokėtojo numerį. Užkoduokite jį kaip vieną URL kelio segmentą.
`usecase`	string	Taip	Mašininiu būdu nuskaitoma usecase reikšmė, pasirinkta iš to paties prekės ženklo kvalifikacijos sąrašo. Išsaugokite jos raidžių registrą; nesiųskite išverstos rodomos etiketės. Užkoduokite ją kaip vieną URL kelio segmentą.

Atsakymas

Dabartinis TCR maršrutas tiesiogiai grąžina registro JSON turinį ir išsaugo jo HTTP būseną. Jis neprideda senojo v3 status/response apvalkalo. Sutrumpintas išgalvotas pavyzdys nėra tikras kvalifikacijos rezultatas. Prieš naudodami patikrinkite HTTP būseną ir laukiamą JSON struktūrą. Portalas tikisi objekto, kurio usecase atitinka pasirinktą naudojimo atvejį. Operatorių reikalavimai yra po mnoMetadata, indeksuoti pagal operatoriaus ID. Pavyzdinis operatoriaus ID ir reikalavimai yra išgalvoti. Gali būti grąžinti ir kiti tiekėjo laukai.

Iliustracinė atsakymo struktūra; tai nėra tikri paskyros duomenys ar dabartinė kainos pasiūla.

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

Klaidos

401: Paskyros autentifikavimas nepavyko. Patikrinkite API prisijungimo duomenis, įjungimo būseną ir taikomus šaltinio IP apribojimus.
404: Prekės ženklas nesusietas su autentifikuota paskyra arba tiekėjas neranda prašomo prekės ženklo ar pasirinkimo. Vietinis nuosavybės atmetimas grąžinamas prieš užklausą tiekėjui.
Kitos registro klaidos: išsaugoma aukštesnio lygio HTTP būsena ir turinys. Negaliojantis arba neprieinamas naudojimo atvejis nėra sėkmingas tuščias reikalavimų rinkinys.
429: Pasiektas paskyros arba bendras tiekėjo užklausų limitas. Laikykitės Retry-After.
502/503: Transporto, tiekėjo arba užklausų ribotuvo prieinamumo klaida. Išsaugokite formą ir bandykite dar kartą naudodami atidėjimą.

Prieinamumas ir šalutiniai poveikiai

Peržiūrėta GET užklausa patikrina esamo prekės ženklo nuosavybę, kreipiasi į registrą ir įrašo užklausų audito įrašus. Ji nesukuria prekės ženklo ar kampanijos ir neapmokestina registracijos mokesčiu.
Tiekėjo mokesčių metaduomenys nėra MultiTEL kliento mažmeninė kainos pasiūla. Portalas paskyros kainodarą peržiūri atskirai prieš vėlesnę registracijos užklausą.
Kvalifikacija ir reikalavimai gali keistis. Prieš pateikdami atnaujinkite juos pasirinktam prekės ženklui ir naudojimo atvejui. Sėkminga paieška nėra kampanijos patvirtinimas, numerio priskyrimas ar leidimas pradėti siųsti pranešimus.