Parandage kampaaniat uut registreeringut loomata
Kasutage seda marsruuti olemasoleva kampaania kirjelduse, näidissõnumite, nõusoleku selgituse või toetatud sisuomaduste muutmiseks. Säilitage kampaania ID ning selle praegune kaubamärk ja kasutusjuht. Uus registreering ei ole olemasoleva kampaania parandamise korduskatse mehhanism.
Autentige lubatud lähte-IP-aadressilt lubatud API kontoga, kasutades HTTPS ühendust. Saadaval on ainult sellele kontole kuuluv kampaania. Enne muudatuste ettevalmistamist lugege selle praegust olekut; aegunud kampaaniaid ei saa selle töövoo kaudu uuendada.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Valige väljad, mis tegelikult muutusid
Valmistage ette toetatud muudatusi sisaldav fail campaign-update.json. Praegune portaal saadab ainult muudetud kampaaniaväljad ega saada välju brandId, usecase, campaignId ega ainult vastusesse kuuluvat olekuteavet. Ka otsesed API uuendused kasutavad väljadest koosnevat JSON objekti, mitte portaali changes/version ümbrist.
| Väljad | Esitatav teave |
|---|---|
| description, messageFlow | Täpne teenusekirjeldus ning selgitus, kuidas inimesed annavad nõusoleku, saavad sõnumeid ja võtavad nõusoleku tagasi. Kumbki väli lubab 40–4096 märki. |
| sample1–sample5 | Selle kampaania realistlikud näited, iga mittetühi näide pikkusega 20–1024 märki. Säilitage kvalifitseeritud kasutusjuhu jaoks nõutud näidete arv; ärge saatke asjassepuutumatuid sõnumeid. |
| helpMessage, optinMessage, optoutMessage | Asjakohased adressaatidele mõeldud vastused, kuni 1024 märki. Kui see on nõutud, järgige 20 märgi alampiiri ja selgitage tegelikku teenust. Enne välja tühjendamist vaadake üle kehtivad nõusolekunõuded. |
| optinKeywords, optoutKeywords, helpKeywords | Komadega eraldatud märksõnad ilma tühikuteta, kuni 255 märki. Hoidke vastused ja märksõnade tegelik töötlus omavahel kooskõlas. |
| privacyPolicyLink, termsAndConditionsLink | Asjakohased avalikud URL-id, kuni 2048 märki, mis kirjeldavad selle teenuse tegelikke tavasid. |
| embeddedLinkSample | Tüüpiline sõnumitesse lisatav link, kuni 255 märki. |
| numberPool, embeddedLink, embeddedPhone, ageGated, directLending | Kampaania tegelikud omadused JSON tõeväärtustena. Omaduse keelamiseks kasutage väärtust false, mitte stringi "false". |
| autoRenewal | Avalik API skeem toetab seda JSON tõeväärtust, kuigi portaali tavaline kampaaniasisu redaktor seda ei paku. Pikendamise keelamine ei tühista olemasolevat minimaalset lepingulist kohustust ega kustuta juba tasumisele kuuluvaid summasid. |
| resellerId | Skeem võimaldab ka edasimüüjaga seostamist. See jääb portaali tavalisest sisuparandusvormist väljapoole. Ärge kasutage seda välja kampaania teisaldamiseks ühelt kliendilt teisele ega eeldage, et API seadistab operaatoriteenuse teisele edasimüüjale. |
Uuendamisskeem ei paku välju brandId, usecase, subscriberOptin, subscriberOptout ega subscriberHelp muudetavate väljadena. Ärge kopeerige kampaania loomise kogu päringusisu uuendamispäringusse. Vaadake kehtivat kvalifikatsiooni sõnuminõuete ülevaatamisel.
Esitage konkreetne parandus
See näide kirjeldab näitlikku broneeritud aegade meeldetuletusteenust. Enne kasutamist kohandage see kampaania tegeliku teenuse ja nõusoleku saamise protsessiga.
{
"description": "Appointment reminders requested by customers of the registered business.",
"sample1": "Example business: Your requested appointment reminder is ready. Reply STOP to opt out."
}curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
--request PUT \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--data-binary @campaign-update.json \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Sama kavandatud esituse kordamisel säilitage sama võti ning meetodi, tee, päringuparameetrite ja keha täpselt samad baidid. Muudetud sisu nõuab eraldi üle vaadatud päringut; ärge vahetage pärast ajalõppu võtmeid pimesi. Lõpetatud päring võib uuesti tagastada vahemällu salvestatud vea ning töödeldava päringu duplikaat võib tagastada 409 koos päisega Retry-After.
Lugege kampaania uuesti
HTTP 200 tagastab kampaania JSON objekti otse, ilma ümbriseta. Kontrollige välja campaignId, seejärel lugege sama kampaania päringuga GET ja võrrelge kavandatud välju. Edukas salvestamine iseenesest ei taotle uut operaatori ülevaatust, ei muuda numbrite seoseid, ei aktiveeri saatmist ega saada sõnumit.
Portaal kontrollib enne salvestamist vormi versiooni ja loeb seejärel kampaania uuesti. Avalik PUT lõpp-punkt ei nõua selle portaali versiooni järgimist: kooskõlastage samaaegsed muudatused. Idempotentsusvõti ei tuvasta teise muutja tehtud uuendust.
Kui portaal näitab veel lahendamata ülevaatusest keeldumist, parandage esmalt sisu ja kasutage seejärel eraldi ülevaatuse taotlemise toimingut, kui see on saadaval. See toiming kontrollib praegust tootmiskeskkonna kampaaniat ja jagamise olekut. Üksnes sisu salvestamine seda toimingut ei käivita ning kampaania ID olemasolu ei tõenda heakskiitu.
Tavalised kampaania PUT uuendused ei käivita praeguses teenuses eraldi kampaania registreerimistasu debiteerimist. Olemasolevad kuutasud, minimaalsed lepingulised kohustused, numbrirent ja sõnumikasutuse tasud kehtivad endiselt. Praegu seadistatud kampaaniatariifid leiate jaotisest kampaaniatasud.
Piirangute ja ebaselgete tulemuste käsitlemine
Vastuse HTTP 400 korral lugege väljakohast veateadet ning kontrollige pikkusi, nõusolekuteksti ja kampaania olekut. Vastuse 401, 403 või 404 korral kontrollige API autentimisandmeid, lubatud lähte-IP-aadressi ja omandiõigust. Vastuse 429 korral järgige päist Retry-After. Vastuse 500, 502 või katkenud päringu korral säilitage kampaania ID ja iga olemasolev requestId, seejärel kontrollige enne uut esitamist olemasoleva kirje vastavust kavandatud tulemusele.
Kohalik hetkeseis sõltub tagastatud vastusekehast. Mittetühjast osalisest vastusest võivad puududa varasemad väljad, sealhulgas pikendamise metaandmed; tühi vastus võib jätta alles aegunud väärtused. Kontrollige täielikku GET tulemust, selle asemel et pidada pelgalt õnnestumist tõendiks kõigi väljade säilimise kohta. Teatage lahendamata erinevustest kasutajatoele. See marsruut ei uuenda operaatoriseoseid atomaarse toiminguna ega paku üldist operaatoriteenuse aktiveerimise taastamistoimingut.