Mbajini markën dhe rastin e përdorimit së bashku
Përdorni ID-në e markës në llogarinë tuaj dhe një vlerë rasti përdorimi të kthyer nga lista e kualifikimit e po asaj marke. Rrjedha e punës së klientit kontrollon pronësinë përpara kërkesës drejt ofruesit. Konfirmoni që fusha usecase e objektit të kthyer përputhet me vlerën e zgjedhur. Një kërkim për një markë ose rast përdorimi nuk përcakton kërkesat për një tjetër.
Lexoni kërkesat aktuale
| Fusha | Si e përdor portali |
|---|---|
| minSubUsecases / maxSubUsecases | Numri minimal dhe maksimal i nën-rasteve të përdorimit për këtë zgjedhje. Zgjidhni vlera nga katalogu i vlefshëm i nën-rasteve të përdorimit dhe jo tekst të lirë. |
| mnoMetadata | Kërkesa specifike për operatorin, të indeksuara sipas ID-së së operatorit. Përdorni ID-të e pranishme në përgjigjen aktuale për zgjedhjen e operatorëve. |
| mnoSupport / qualify | Mbështetja dhe kualifikimi i operatorit. Portali përjashton operatorët e shënuar shprehimisht false për cilëndo nga të dyja fushat dhe kërkon të paktën një operator të zgjedhur të përshtatshëm. |
| minMsgSamples | Numri i kërkuar i mostrave për një operator. Portali kërkon të paktën një mostër jo të zbrazët dhe plotëson minimumin më të lartë midis operatorëve të zgjedhur të përshtatshëm. |
| reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp | Deklaratat e kërkuara të abonentit. Kur kërkohen, deklarata përkatëse duhet të jetë true. Deklaratat e aktivizuara kanë nevojë gjithashtu për fushat e tyre të fjalëve kyçe dhe të mesazhit të përgjigjes. |
| noEmbeddedLink / noEmbeddedPhone | Kufizime për lidhjet ose numrat e telefonit të përfshirë në mesazh. Portali refuzon një veçori të deklaruar nëse një operator i zgjedhur i përshtatshëm e ndalon atë. |
Zbatoni së bashku kërkesat e operatorëve të zgjedhur
Kërkesat e operatorëve mund të ndryshojnë. Kur nuk jepet një listë e shprehur operatorësh, portali merr parasysh të gjitha metadatat e operatorëve në përgjigje; një listë jo e zbrazët i kufizon kontrollet vetëm te ID-të e zgjedhura. Mos përdorni vetëm numrin e mostrave ose deklaratat e operatorit të parë. Zgjidhni operatorët nga përgjigja, kontrolloni mbështetjen dhe kualifikimin, plotësoni minimumin më të lartë të zbatueshëm të mostrave dhe përmbushni deklaratat e kërkuara të pranimit (opt-in), të çregjistrimit (opt-out) dhe të ndihmës në të gjithë atë zgjedhje. Portali refuzon ID-të e operatorëve të zgjedhur që mungojnë në përgjigjen aktuale dhe refuzon një zgjedhje pa asnjë operator të përshtatshëm.
Kërkesat përshkruajnë se çfarë duhet dhënë; ato nuk vërtetojnë se procesi i pëlqimit i klientit ose përmbajtja e fushatës i plotëson ato kërkesa. Mblidhni mostra dhe deklarata të vërteta dhe përfaqësuese. Mos i aktivizoni automatikisht deklaratat vetëm që një formular të kalojë.
Përgatitni mostrat dhe përgjigjet për abonentët
Formulari aktual i fushatës përdor nga sample1 deri te sample5 për mostrat e mesazheve. Nëse kërkesat nuk mund të plotësohen brenda formularit të disponueshëm, ndaloni dhe zgjidheni përzgjedhjen me ekipin e mbështetjes. Për një deklaratë abonenti të aktivizuar, jepni fjalët kyçe dhe tekstin e përgjigjes përkatëse: optinKeywords/optinMessage, optoutKeywords/optoutMessage dhe helpKeywords/helpMessage. Mbajini mostrat në përputhje me rastin e zgjedhur të përdorimit dhe me mesazhet reale që u dërgohen klientëve.
Rishikoni përpara çdo kërkese regjistrimi
Rifreskoni kërkesat kur ndryshon marka, rasti i përdorimit ose zgjedhja e operatorëve. Portali rivalidon rastin e zgjedhur të përdorimit, numrin e nën-rasteve të përdorimit, përshtatshmërinë e operatorëve, mostrat dhe deklaratat përpara krijimit. Rishikoni veçmas çmimet e llogarisë dhe kushtet e regjistrimit. Kjo kërkesë GET nuk regjistron apo miraton një fushatë, nuk e ndan atë me operatorin e mesazheve dhe nuk cakton një numër telefoni. Krijimi dhe provizionimi janë operacione të veçanta.
Trajtoni një kërkim të dështuar të kërkesave
Nëse kërkesa dështon, kthen JSON të papritur ose nuk përputhet me rastin e zgjedhur të përdorimit, mbajeni formularin të paplotësuar dhe lejoni klientin të riprovojë pasi gabimi të jetë zgjidhur. Mos i zëvendësoni kërkesat e padisponueshme me një objekt të zbrazët dhe mos supozoni se mungesa e të dhënave do të thotë se nuk ka kërkesa. Respektoni Retry-After dhe përdorni rritje graduale të pritjes (backoff) për kufizimet e shpejtësisë dhe dështimet e disponueshmërisë.
Kërkesa
Përdorni një llogari API të aktivizuar përmes HTTPS nga një adresë IP burimi e lejuar. Rruga aktuale mbështet politikën e autentikimit të llogarisë, duke përfshirë autentikimin Basic dhe llogaritë API bearer të aktivizuara. Mos përdorni kredencialet e ofruesit.
GET me ID-në e markës dhe vlerën e zgjedhur të rastit të përdorimit në shtegun e URL-së. Nuk kërkohet asnjë trup kërkese.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"| Emri | Lloji | I detyrueshëm | Përshkrimi |
|---|---|---|---|
brand_id | string | Po | ID-ja e markës në regjistër, e lidhur me llogarinë tuaj të autentikuar MultiTEL. Përdorni ID-në e markës, jo një ID rreshti të bazës lokale të të dhënave, një ID fushate apo një numër tatimor biznesi. Kodojeni si një segment të vetëm të shtegut të URL-së. |
usecase | string | Po | Vlera usecase e lexueshme nga makina, e zgjedhur nga lista e kualifikimit e po kësaj marke. Ruani shkronjat e mëdha dhe të vogla të saj; mos dërgoni një etiketë shfaqjeje të përkthyer. Kodojeni si një segment të vetëm të shtegut të URL-së. |
Përgjigja
Rruga aktuale TCR e kthen drejtpërdrejt trupin JSON të regjistrit dhe ruan statusin e tij HTTP. Ajo nuk shton mbështjellësin e trashëguar v3 status/response. Shembulli i shkurtuar fiktiv nuk është një rezultat kualifikimi i drejtpërdrejtë. Kontrolloni statusin HTTP dhe formën e pritur të JSON-it përpara se ta përdorni. Portali pret një objekt, usecase i të cilit përputhet me rastin e zgjedhur të përdorimit. Kërkesat e operatorëve gjenden nën mnoMetadata, të indeksuara sipas ID-së së operatorit. ID-ja e operatorit dhe kërkesat në shembull janë fiktive. Mund të kthehen edhe fusha të tjera të ofruesit.
Formë ilustruese e përgjigjes; jo të dhëna reale llogarie apo një kuotim aktual.
{
"usecase": "2FA",
"minSubUsecases": 0,
"maxSubUsecases": 0,
"mnoMetadata": {
"12345": {
"mnoSupport": true,
"qualify": true,
"minMsgSamples": 1,
"reqSubscriberOptin": true,
"reqSubscriberOptout": true,
"reqSubscriberHelp": true,
"noEmbeddedLink": false,
"noEmbeddedPhone": false
}
}
}Gabimet
- 401: Autentikimi i llogarisë dështoi. Kontrolloni kredencialet e API-t, gjendjen e aktivizimit dhe kufizimet e zbatueshme të IP-së burimore.
- 404: Marka nuk është e lidhur me llogarinë e autentikuar, ose ofruesi nuk mund të gjejë markën ose zgjedhjen e kërkuar. Një refuzim lokal i pronësisë kthehet përpara se të bëhet një kërkesë drejt ofruesit.
- Gabime të tjera të regjistrit: Statusi HTTP dhe trupi i përgjigjes nga burimi ruhen të pandryshuara. Një rast përdorimi i pavlefshëm ose i padisponueshëm nuk është një grup kërkesash i zbrazët i suksesshëm.
- 429: Është arritur kufiri i kërkesave të llogarisë ose i ofruesit të përbashkët. Respektoni Retry-After.
- 502/503: Dështim i disponueshmërisë së transportit, ofruesit ose kufizuesit të shpejtësisë. Ruajeni formularin dhe riprovoni me rritje graduale të pritjes.
Disponueshmëria dhe efektet anësore
- Kërkesa GET e rishikuar kontrollon pronësinë ekzistuese të markës, kontakton regjistrin dhe shkruan regjistrime auditimi të kërkesës. Ajo nuk krijon një markë ose fushatë dhe nuk ngarkon një tarifë regjistrimi.
- Metadatat e tarifave të ofruesit nuk janë një kuotim me pakicë për klientin e MultiTEL. Portali i rishikon veçmas çmimet e llogarisë përpara një kërkese të mëvonshme regjistrimi.
- Kualifikimi dhe kërkesat mund të ndryshojnë. Rifreskojini ato për markën dhe rastin e zgjedhur të përdorimit përpara dorëzimit. Një kërkim i suksesshëm nuk është një miratim fushate, një caktim numri apo një leje për të filluar dërgimin e mesazheve.