Lasīt zīmola kampaņas prasības

Turiet zīmolu un lietošanas gadījumu kopā

Izmantojiet sava konta zīmola ID un lietošanas gadījuma vērtību, ko atgriezis tā paša zīmola kvalifikācijas saraksts. Klienta darbplūsma pārbauda īpašumtiesības pirms pieprasījuma pakalpojumu sniedzējam. Pārliecinieties, ka atgrieztā objekta usecase atbilst izvēlētajai vērtībai. Viena zīmola vai lietošanas gadījuma uzmeklēšana nenosaka prasības citam.

Nolasiet pašreizējās prasības

Prasības, ko izmanto pašreizējā kampaņas veidlapa
Lauks	Kā portāls to izmanto
minSubUsecases / maxSubUsecases	Minimālais un maksimālais apakšlietošanas gadījumu skaits šai izvēlei. Izvēlieties vērtības no derīgo apakšlietošanas gadījumu kataloga, nevis brīvu tekstu.
mnoMetadata	Operatoriem specifiskas prasības, kas sakārtotas pēc operatora ID. Operatoru izvēlei izmantojiet ID, kas ir pašreizējā atbildē.
mnoSupport / qualify	Operatora atbalsts un kvalifikācija. Portāls izslēdz operatorus, kuriem kāds no šiem laukiem ir skaidri atzīmēts kā false, un pieprasa vismaz vienu atbilstošu izvēlētu operatoru.
minMsgSamples	Operatoram nepieciešamais paraugu skaits. Portāls pieprasa vismaz vienu netukšu paraugu un izpilda augstāko minimumu starp atbilstošajiem izvēlētajiem operatoriem.
reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp	Nepieciešamās abonentu deklarācijas. Kur tās ir nepieciešamas, atbilstošajai deklarācijai jābūt true. Iespējotajām deklarācijām ir nepieciešami arī to atslēgvārdu un atbildes ziņojuma lauki.
noEmbeddedLink / noEmbeddedPhone	Ierobežojumi iegultām saitēm vai tālruņa numuriem. Portāls noraida deklarētu funkciju, ja atbilstošs izvēlēts operators to aizliedz.

Piemērojiet izvēlēto operatoru prasības kopā

Operatoru prasības var atšķirties. Ja nav norādīts skaidrs operatoru saraksts, portāls ņem vērā visus operatoru metadatus atbildē; netukšs saraksts ierobežo pārbaudes līdz šiem izvēlētajiem ID. Neizmantojiet tikai pirmā operatora paraugu skaitu vai deklarācijas. Izvēlieties operatorus no atbildes, pārbaudiet atbalstu un kvalifikāciju, izpildiet augstāko piemērojamo paraugu minimumu un izpildiet nepieciešamās pieteikšanās, atteikšanās un palīdzības deklarācijas visā šajā izvēlē. Portāls noraida izvēlētos operatoru ID, kuru nav pašreizējā atbildē, un noraida izvēli bez neviena atbilstoša operatora.

Prasības apraksta, kas ir jāiesniedz; tās nepierāda, ka klienta piekrišanas process vai kampaņas saturs atbilst šīm prasībām. Apkopojiet patiesus, reprezentatīvus paraugus un deklarācijas. Automātiski neieslēdziet deklarācijas, lai veidlapa tiktu pieņemta.

Sagatavojiet paraugus un abonentu atbildes

Pašreizējā kampaņas veidlapa izmanto sample1 līdz sample5 ziņojumu paraugiem. Ja prasības nevar izpildīt pieejamajā veidlapā, apstājieties un atrisiniet izvēli ar atbalsta dienestu. Iespējotai abonenta deklarācijai norādiet tai atbilstošos atslēgvārdus un atbildes tekstu: optinKeywords/optinMessage, optoutKeywords/optoutMessage un helpKeywords/helpMessage. Nodrošiniet, lai paraugi atbilstu izvēlētajam lietošanas gadījumam un faktiskajai klienta ziņapmaiņai.

Pārskatiet pirms jebkura reģistrācijas pieprasījuma

Atjaunojiet prasības, kad mainās zīmols, lietošanas gadījums vai operatoru izvēle. Portāls pirms izveides atkārtoti validē izvēlēto lietošanas gadījumu, apakšlietošanas gadījumu skaitu, operatoru atbilstību, paraugus un deklarācijas. Konta cenas un reģistrācijas noteikumus pārskatiet atsevišķi. Šis GET nereģistrē un neapstiprina kampaņu, nekopīgo to ar ziņapmaiņas operatoru un nepiešķir tālruņa numuru. Izveide un nodrošināšana ir atsevišķas darbības.

Apstrādājiet neveiksmīgu prasību uzmeklēšanu

Ja pieprasījums neizdodas, atgriež negaidītu JSON vai neatbilst izvēlētajam lietošanas gadījumam, atstājiet veidlapu nepabeigtu un ļaujiet klientam mēģināt vēlreiz pēc kļūdas novēršanas. Neaizstājiet nepieejamās prasības ar tukšu objektu un nepieņemiet, ka trūkstoši dati nozīmē, ka prasību nav. Ievērojiet Retry-After un izmantojiet atkāpšanos (backoff) ātruma ierobežojumu un pieejamības kļūmju gadījumā.

Pieprasījums

Izmantojiet iespējotu API kontu, izmantojot HTTPS, no atļautas avota IP adreses. Pašreizējais maršruts atbalsta konta autentifikācijas politiku, tostarp Basic autentifikāciju un iespējotus nesēja (bearer) API kontus. Neizmantojiet pakalpojumu sniedzēja akreditācijas datus.

GET ar zīmola ID un izvēlēto lietošanas gadījuma vērtību URL ceļā. Pieprasījuma pamatteksts nav nepieciešams.

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

Ceļa parametri
Nosaukums	Tips	Obligāts	Apraksts
`brand_id`	string	Jā	Reģistra zīmola ID, kas saistīts ar jūsu autentificēto MultiTEL kontu. Izmantojiet zīmola ID, nevis lokālās datubāzes rindas ID, kampaņas ID vai uzņēmuma nodokļu maksātāja numuru. Kodējiet to kā vienu URL ceļa segmentu.
`usecase`	string	Jā	Mašīnlasāmā usecase vērtība, kas izvēlēta no šī paša zīmola kvalifikācijas saraksta. Saglabājiet tās burtu reģistru; nesūtiet tulkotu attēlojuma etiķeti. Kodējiet to kā vienu URL ceļa segmentu.

Atbilde

Pašreizējais TCR maršruts atgriež reģistra JSON pamattekstu tieši un saglabā tā HTTP statusu. Tas nepievieno mantoto v3 status/response aploksni. Saīsinātais izdomātais piemērs nav reāls kvalifikācijas rezultāts. Pirms izmantošanas pārbaudiet HTTP statusu un gaidīto JSON formu. Portāls sagaida objektu, kura usecase atbilst izvēlētajam lietošanas gadījumam. Operatoru prasības atrodas zem mnoMetadata, sakārtotas pēc operatora ID. Piemēra operatora ID un prasības ir izdomātas. Var tikt atgriezti arī citi pakalpojumu sniedzēja lauki.

Ilustratīva atbildes forma; nav reāli konta dati vai pašreizējs cenu piedāvājums.

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

Kļūdas

401: Konta autentifikācija neizdevās. Pārbaudiet API akreditācijas datus, iespējoto stāvokli un piemērojamos avota IP ierobežojumus.
404: Zīmols nav saistīts ar autentificēto kontu, vai pakalpojumu sniedzējs nevar atrast pieprasīto zīmolu vai izvēli. Lokāls īpašumtiesību atteikums tiek atgriezts pirms pieprasījuma pakalpojumu sniedzējam.
Citas reģistra kļūdas: augšupējais HTTP statuss un pamatteksts tiek saglabāti. Nederīgs vai nepieejams lietošanas gadījums nav veiksmīga tukša prasību kopa.
429: Sasniegts konta vai koplietotā pakalpojumu sniedzēja pieprasījumu limits. Ievērojiet Retry-After.
502/503: Transporta, pakalpojumu sniedzēja vai ātruma ierobežotāja pieejamības kļūme. Saglabājiet veidlapu un mēģiniet vēlreiz ar atkāpšanos.

Pieejamība un blakusefekti

Pārskatītais GET pārbauda esošās zīmola īpašumtiesības, sazinās ar reģistru un ieraksta pieprasījumu audita ierakstus. Tas neizveido zīmolu vai kampaņu un neiekasē reģistrācijas maksu.
Pakalpojumu sniedzēja maksas metadati nav MultiTEL klienta mazumtirdzniecības cenu piedāvājums. Portāls konta cenas pārskata atsevišķi pirms vēlāka reģistrācijas pieprasījuma.
Kvalifikācija un prasības var mainīties. Atjaunojiet tās izvēlētajam zīmolam un lietošanas gadījumam pirms iesniegšanas. Veiksmīga uzmeklēšana nav kampaņas apstiprinājums, numura piešķiršana vai atļauja sākt ziņapmaiņu.