Loe brändi kampaanianõudeid

Hoia bränd ja kasutusjuht koos

Kasuta oma konto brändi ID-d ja kasutusjuhu väärtust, mille tagastas sama brändi kvalifitseerimisloend. Kliendi töövoog kontrollib omandit enne pakkuja päringut. Veendu, et tagastatud objekti usecase vastab valitud väärtusele. Ühe brändi või kasutusjuhu päring ei määra nõudeid teise jaoks.

Loe kehtivaid nõudeid

Praeguse kampaaniavormi kasutatavad nõuded
Väli	Kuidas portaal seda kasutab
minSubUsecases / maxSubUsecases	Selle valiku alamkasutusjuhtude minimaalne ja maksimaalne arv. Vali väärtused kehtivast alamkasutusjuhtude kataloogist, mitte vaba tekstina.
mnoMetadata	Operaatoripõhised nõuded, mille võtmeks on operaatori ID. Kasuta operaatori valikuks praeguses vastuses olevaid ID-sid.
mnoSupport / qualify	Operaatori tugi ja kvalifikatsioon. Portaal välistab operaatorid, mille vähemalt ühe nimetatud välja väärtuseks on selgesõnaliselt märgitud false, ja nõuab vähemalt ühte sobivat valitud operaatorit.
minMsgSamples	Operaatori nõutav näidiste arv. Portaal nõuab vähemalt ühte mittetühja näidist ja täidab sobivate valitud operaatorite kõrgeima miinimumi.
reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp	Nõutavad tellija deklaratsioonid. Kui need on nõutavad, peab vastav deklaratsioon olema true. Lubatud deklaratsioonid vajavad ka oma märksõna ja vastussõnumi välju.
noEmbeddedLink / noEmbeddedPhone	Manustatud linkide või telefoninumbrite piirangud. Portaal lükkab deklareeritud funktsiooni tagasi, kui sobiv valitud operaator selle keelab.

Rakenda valitud operaatorite nõudeid koos

Operaatorite nõuded võivad erineda. Kui selgesõnalist operaatorite loendit ei esitata, arvestab portaal kõiki vastuses olevaid operaatorite metaandmeid; mittetühi loend piirab kontrollid nende valitud ID-dega. Ära kasuta ainult esimese operaatori näidiste arvu või deklaratsioone. Vali operaatorid vastusest, kontrolli tuge ja kvalifikatsiooni, täida kõrgeim kohalduv näidiste miinimum ning täida nõutavad liitumise, loobumise ja abi deklaratsioonid kogu selle valiku ulatuses. Portaal lükkab tagasi valitud operaatori ID-d, mis praeguses vastuses puuduvad, ja lükkab tagasi valiku, milles pole ühtegi sobivat operaatorit.

Nõuded kirjeldavad, mida tuleb esitada; need ei tõenda, et kliendi nõusolekuprotsess või kampaania sisu vastab neile nõuetele. Kogu tõesed ja representatiivsed näidised ning deklaratsioonid. Ära lülita deklaratsioone automaatselt sisse, et vormi läbimist saavutada.

Valmista ette näidised ja tellija vastused

Praegune kampaaniavorm kasutab välju sample1 kuni sample5 sõnuminäidiste jaoks. Kui nõudeid ei ole võimalik saadaoleva vormi piires täita, peatu ja lahenda valik koos toega. Lubatud tellija deklaratsiooni jaoks esita selle vastavad märksõnad ja vastustekst: optinKeywords/optinMessage, optoutKeywords/optoutMessage ja helpKeywords/helpMessage. Hoia näidised kooskõlas valitud kasutusjuhu ja tegeliku kliendisuhtlusega.

Vaata üle enne mis tahes registreerimispäringut

Värskenda nõudeid, kui bränd, kasutusjuht või operaatorite valik muutub. Portaal valideerib enne loomist uuesti valitud kasutusjuhu, alamkasutusjuhtude arvu, operaatorite sobivuse, näidised ja deklaratsioonid. Vaata konto hinnakiri ja registreerimistingimused eraldi üle. See GET ei registreeri ega kinnita kampaaniat, ei jaga seda sõnumsideoperaatoriga ega määra telefoninumbrit. Loomine ja provisjoneerimine on eraldi toimingud.

Käsitle ebaõnnestunud nõuete päringut

Kui päring ebaõnnestub, tagastab ootamatu JSON-i või ei vasta valitud kasutusjuhule, jäta vorm lõpetamata ja lase kliendil pärast vea lahendamist uuesti proovida. Ära asenda kättesaamatuid nõudeid tühja objektiga ega eelda, et puuduvad andmed tähendavad nõuete puudumist. Järgi päist Retry-After ja kasuta päringupiirangute ning saadavustõrgete korral viivitusega kordamist.

Päring

Kasuta lubatud API kontot HTTPS-i kaudu lubatud lähte-IP-aadressilt. Praegune marsruut toetab konto autentimispoliitikat, sealhulgas Basic autentimist ja lubatud bearer-API-kontosid. Ära kasuta pakkuja mandaate.

GET brändi ID ja valitud kasutusjuhu väärtusega URL-i teel. Päringu keha ei ole nõutav.

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

Tee parameetrid
Nimi	Tüüp	Nõutav	Kirjeldus
`brand_id`	string	Jah	Sinu autenditud MultiTEL kontoga seotud registri brändi ID. Kasuta brändi ID-d, mitte kohaliku andmebaasi rea ID-d, kampaania ID-d ega ettevõtte maksunumbrit. Kodeeri see ühe URL-i tee segmendina.
`usecase`	string	Jah	Sama brändi kvalifitseerimisloendist valitud masinloetav usecase väärtus. Säilita selle tähesuurus; ära saada tõlgitud kuvasilti. Kodeeri see ühe URL-i tee segmendina.

Vastus

Praegune TCR marsruut tagastab registri JSON-keha otse ja säilitab selle HTTP oleku. See ei lisa pärand-v3 status/response ümbrist. Lühendatud väljamõeldud näide ei ole reaalajas kvalifitseerimistulemus. Kontrolli HTTP olekut ja eeldatavat JSON-i kuju enne selle kasutamist. Portaal eeldab objekti, mille usecase vastab valitud kasutusjuhule. Operaatorite nõuded on mnoMetadata all, võtmeks on operaatori ID. Näites olev operaatori ID ja nõuded on väljamõeldud. Tagastada võidakse ka muid pakkuja välju.

Illustreeriv vastuse kuju; mitte reaalajas kontoandmed ega kehtiv hinnapakkumine.

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

Vead

401: Konto autentimine ebaõnnestus. Kontrolli API mandaate, lubatud olekut ja kohalduvaid lähte-IP piiranguid.
404: Bränd ei ole autenditud kontoga seotud või pakkuja ei leia soovitud brändi või valikut. Kohalik omandi keeldumine tagastatakse enne pakkuja päringut.
Muud registri vead: ülesvoolu HTTP olek ja keha säilitatakse. Kehtetu või kättesaamatu kasutusjuht ei ole edukas tühi nõuete kogum.
429: Konto või jagatud pakkuja päringupiirang on saavutatud. Järgi päist Retry-After.
502/503: Transpordi, pakkuja või päringupiiraja saadavustõrge. Säilita vorm ja proovi viivitusega uuesti.

Saadavus ja kõrvalmõjud

Üle vaadatud GET kontrollib olemasoleva brändi omandit, võtab ühendust registriga ja kirjutab päringu auditikirjeid. See ei loo brändi ega kampaaniat ega võta registreerimistasu.
Pakkuja tasude metaandmed ei ole MultiTEL kliendi jaehinnapakkumine. Portaal vaatab konto hinnakirja eraldi üle enne hilisemat registreerimispäringut.
Kvalifikatsioon ja nõuded võivad muutuda. Värskenda neid valitud brändi ja kasutusjuhu jaoks enne esitamist. Edukas päring ei ole kampaania kinnitus, numbri määramine ega luba sõnumite saatmist alustada.