Držite brend i slučaj upotrebe zajedno
Koristite ID brenda na svom računu i vrijednost slučaja upotrebe vraćenu popisom kvalifikacija tog istog brenda. Korisnički tijek rada provjerava vlasništvo prije zahtjeva prema pružatelju. Potvrdite da vrijednost usecase vraćenog objekta odgovara odabranoj vrijednosti. Dohvaćanje za jedan brend ili slučaj upotrebe ne utvrđuje zahtjeve za drugi.
Pročitajte trenutačne zahtjeve
| Polje | Kako ga portal koristi |
|---|---|
| minSubUsecases / maxSubUsecases | Najmanji i najveći broj pod-slučajeva upotrebe za ovaj odabir. Birajte vrijednosti iz valjanog kataloga pod-slučajeva upotrebe, a ne slobodan tekst. |
| mnoMetadata | Zahtjevi specifični za operatera, indeksirani prema ID-u operatera. Za odabir operatera koristite ID-ove prisutne u trenutačnom odgovoru. |
| mnoSupport / qualify | Podrška i kvalifikacija operatera. Portal isključuje operatere izričito označene kao false za bilo koje od ta dva polja i zahtijeva barem jednog prihvatljivog odabranog operatera. |
| minMsgSamples | Potreban broj uzoraka za operatera. Portal zahtijeva barem jedan neprazan uzorak i ispunjava najviši minimum među prihvatljivim odabranim operaterima. |
| reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp | Obvezne izjave za pretplatnike. Gdje je to obvezno, odgovarajuća izjava mora biti true. Omogućene izjave također trebaju svoja polja ključnih riječi i poruke odgovora. |
| noEmbeddedLink / noEmbeddedPhone | Ograničenja za ugrađene poveznice ili telefonske brojeve. Portal odbija deklariranu značajku ako je prihvatljivi odabrani operater zabranjuje. |
Primijenite zahtjeve odabranih operatera zajedno
Zahtjevi operatera mogu se razlikovati. Kada nije naveden izričit popis operatera, portal uzima u obzir sve metapodatke operatera u odgovoru; neprazan popis ograničava provjere na te odabrane ID-ove. Nemojte koristiti samo broj uzoraka ili izjave prvog operatera. Odaberite operatere iz odgovora, provjerite podršku i kvalifikaciju, ispunite najviši primjenjivi minimum uzoraka te zadovoljite obvezne izjave o prijavi (opt-in), odjavi (opt-out) i pomoći za cijeli taj odabir. Portal odbija odabrane ID-ove operatera kojih nema u trenutačnom odgovoru i odbija odabir bez prihvatljivog operatera.
Zahtjevi opisuju što se mora dostaviti; oni ne dokazuju da korisnikov postupak pristanka ili sadržaj kampanje ispunjava te zahtjeve. Prikupite istinite, reprezentativne uzorke i izjave. Nemojte automatski uključivati izjave kako bi obrazac prošao.
Pripremite uzorke i odgovore pretplatnicima
Trenutačni obrazac kampanje koristi polja sample1 do sample5 za uzorke poruka. Ako se zahtjevi ne mogu ispuniti unutar dostupnog obrasca, zaustavite se i riješite odabir s podrškom. Za omogućenu izjavu za pretplatnike navedite odgovarajuće ključne riječi i tekst odgovora: optinKeywords/optinMessage, optoutKeywords/optoutMessage i helpKeywords/helpMessage. Uzorci moraju biti u skladu s odabranim slučajem upotrebe i stvarnim porukama koje korisnik šalje.
Pregledajte prije svakog zahtjeva za registraciju
Osvježite zahtjeve kada se promijeni brend, slučaj upotrebe ili odabir operatera. Portal ponovno provjerava odabrani slučaj upotrebe, broj pod-slučajeva upotrebe, prihvatljivost operatera, uzorke i izjave prije kreiranja. Cijene računa i uvjete registracije pregledajte zasebno. Ovaj GET ne registrira niti odobrava kampanju, ne dijeli je s operaterom za slanje poruka i ne dodjeljuje telefonski broj. Kreiranje i provizioniranje zasebne su operacije.
Postupanje s neuspjelim dohvaćanjem zahtjeva
Ako zahtjev ne uspije, vrati neočekivani JSON ili ne odgovara odabranom slučaju upotrebe, ostavite obrazac nepotpunim i omogućite korisniku ponovni pokušaj nakon što se pogreška riješi. Nemojte nedostupne zahtjeve zamjenjivati praznim objektom niti pretpostavljati da nedostajući podaci znače da zahtjeva nema. Poštujte zaglavlje Retry-After i koristite postupno odgađanje (backoff) za ograničenja broja zahtjeva i neuspjehe dostupnosti.
Zahtjev
Koristite omogućeni API račun putem HTTPS-a s dopuštene izvorne IP adrese. Trenutačna ruta podržava politiku autentifikacije računa, uključujući Basic autentifikaciju i omogućene API račune s bearer tokenom. Nemojte koristiti vjerodajnice pružatelja.
GET s ID-om brenda i odabranom vrijednošću slučaja upotrebe u URL putanji. Tijelo zahtjeva nije potrebno.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"| Naziv | Tip | Obvezno | Opis |
|---|---|---|---|
brand_id | string | Da | ID brenda u registru povezan s vašim autentificiranim MultiTEL računom. Koristite ID brenda, a ne ID retka lokalne baze podataka, ID kampanje ili porezni broj tvrtke. Kodirajte ga kao jedan segment URL putanje. |
usecase | string | Da | Strojno čitljiva vrijednost usecase odabrana s popisa kvalifikacija tog istog brenda. Zadržite velika i mala slova; nemojte slati prevedenu oznaku za prikaz. Kodirajte je kao jedan segment URL putanje. |
Odgovor
Trenutačna TCR ruta izravno vraća JSON tijelo registra i čuva njegov HTTP status. Ne dodaje naslijeđenu v3 ovojnicu status/response. Skraćeni izmišljeni primjer nije stvarni rezultat kvalifikacije. Prije upotrebe provjerite HTTP status i očekivani oblik JSON-a. Portal očekuje objekt čiji usecase odgovara odabranom slučaju upotrebe. Zahtjevi operatera nalaze se pod mnoMetadata, indeksirani prema ID-u operatera. ID operatera i zahtjevi u primjeru su izmišljeni. Mogu biti vraćena i druga polja pružatelja.
Ilustrativni oblik odgovora; nisu stvarni podaci računa ni trenutačna ponuda.
{
"usecase": "2FA",
"minSubUsecases": 0,
"maxSubUsecases": 0,
"mnoMetadata": {
"12345": {
"mnoSupport": true,
"qualify": true,
"minMsgSamples": 1,
"reqSubscriberOptin": true,
"reqSubscriberOptout": true,
"reqSubscriberHelp": true,
"noEmbeddedLink": false,
"noEmbeddedPhone": false
}
}
}Pogreške
- 401: Autentifikacija računa nije uspjela. Provjerite API vjerodajnice, stanje omogućenosti i primjenjiva ograničenja izvorne IP adrese.
- 404: Brend nije povezan s autentificiranim računom ili pružatelj ne može pronaći traženi brend ili odabir. Lokalno odbijanje zbog vlasništva vraća se prije zahtjeva prema pružatelju.
- Ostale pogreške registra: uzvodni HTTP status i tijelo se čuvaju. Nevaljan ili nedostupan slučaj upotrebe nije uspješan prazan skup zahtjeva.
- 429: Dosegnuto je ograničenje broja zahtjeva računa ili zajedničkog pružatelja. Poštujte Retry-After.
- 502/503: Neuspjeh dostupnosti transporta, pružatelja ili ograničivača broja zahtjeva. Sačuvajte obrazac i pokušajte ponovno uz postupno odgađanje.
Dostupnost i popratni učinci
- Pregledani GET provjerava postojeće vlasništvo nad brendom, kontaktira registar i zapisuje revizijske zapise zahtjeva. Ne kreira brend ni kampanju i ne naplaćuje naknadu za registraciju.
- Metapodaci o naknadama pružatelja nisu MultiTEL maloprodajna ponuda za korisnika. Portal zasebno pregledava cijene računa prije kasnijeg zahtjeva za registraciju.
- Kvalifikacija i zahtjevi mogu se promijeniti. Osvježite ih za odabrani brend i slučaj upotrebe prije slanja. Uspješno dohvaćanje nije odobrenje kampanje, dodjela broja ni dopuštenje za početak slanja poruka.