Korjaa kampanja luomatta uutta rekisteröintiä
Tällä reitillä voit muokata olemassa olevan kampanjan kuvausta, viestiesimerkkejä, suostumuksen kuvausta tai tuettuja sisältöominaisuuksia. Säilytä kampanjan tunnus sekä sen nykyinen brändi ja käyttötapaus. Uutta rekisteröintiä ei käytetä olemassa olevan kampanjan korjauksen uudelleenyritykseen.
Tunnistaudu käytössä olevalla API-tilillä HTTPS-yhteyden kautta sallitusta lähde-IP-osoitteesta. Vain kyseiselle tilille kuuluva kampanja on käytettävissä. Lue sen nykyinen tila ennen muutosten valmistelua; vanhentuneita kampanjoita ei voi päivittää tällä työnkululla.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Valitse vain muuttuneet kentät
Valmistele campaign-update.json-tiedosto, joka sisältää tuetut muutokset. Nykyinen portaali lähettää vain muuttuneet kampanjakentät eikä lähetä kenttiä brandId, usecase tai campaignId eikä pelkästään vastauksissa esiintyviä tilatietoja. Myös suorat API-päivitykset käyttävät kentät sisältävää JSON-objektia, eivät portaalin changes/version-käärettä.
| Kentät | Annettavat tiedot |
|---|---|
| description, messageFlow | Täsmällinen palvelukuvaus sekä kuvaus siitä, miten ihmiset antavat suostumuksensa, vastaanottavat viestejä ja peruuttavat suostumuksensa. Kummankin kentän sallittu pituus on 40–4096 merkkiä. |
| sample1–sample5 | Tämän kampanjan todellisuutta vastaavat esimerkit, 20–1024 merkkiä kutakin muuta kuin tyhjää esimerkkiä kohti. Säilytä käyttötapauksen kelpoisuusmäärityksen edellyttämä esimerkkimäärä; älä lähetä asiaankuulumattomia viestejä. |
| helpMessage, optinMessage, optoutMessage | Soveltuvat vastaanottajalle näytettävät vastaukset, enintään 1024 merkkiä. Täytä tarvittaessa 20 merkin vähimmäisvaatimus ja kuvaa todellinen palvelu. Tarkista nykyiset suostumusvaatimukset ennen kentän tyhjentämistä. |
| optinKeywords, optoutKeywords, helpKeywords | Pilkuilla erotetut avainsanat ilman välilyöntejä, enintään 255 merkkiä. Varmista, että vastaukset ja avainsanojen todellinen käsittely ovat keskenään johdonmukaisia. |
| privacyPolicyLink, termsAndConditionsLink | Asiaankuuluvat julkiset verkko-osoitteet, enintään 2048 merkkiä, jotka kuvaavat tämän palvelun todellisia käytäntöjä. |
| embeddedLinkSample | Edustava esimerkki viesteihin sisältyvästä linkistä, enintään 255 merkkiä. |
| numberPool, embeddedLink, embeddedPhone, ageGated, directLending | Kampanjan todelliset ominaisuudet JSON-totuusarvoina. Kun poistat ominaisuuden käytöstä, käytä arvoa false, älä merkkijonoa "false". |
| autoRenewal | Julkinen API-skeema tukee tätä JSON-totuusarvoa, vaikka portaalin tavallinen kampanjasisällön muokkain ei tarjoa sitä. Uusimisen poistaminen käytöstä ei peruuta olemassa olevaa vähimmäissitoumusta eikä poista jo maksettavaksi tulleita maksuja. |
| resellerId | Skeema tarjoaa myös mahdollisuuden liittää kampanja jälleenmyyjään. Tämä ei kuulu portaalin tavalliseen sisällönkorjauslomakkeeseen. Älä käytä tätä kenttää kampanjan siirtämiseen asiakkaalta toiselle äläkä oleta, että API määrittää operaattoripalvelun toiselle jälleenmyyjälle. |
Päivitysskeema ei tarjoa kenttiä brandId, usecase, subscriberOptin, subscriberOptout tai subscriberHelp muokattavina kenttinä. Älä kopioi koko kampanjan luomisen tietosisältöä päivitykseen. Katso nykyinen kelpoisuusmääritys tarkistaessasi viestivaatimuksia.
Lähetä rajattu korjaus
Tämä esimerkki havainnollistaa ajanvarausmuistutuspalvelua. Mukauta se kampanjan todelliseen palveluun ja suostumusprosessiin ennen käyttöä.
{
"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"Säilytä sama avain sekä täsmälleen sama menetelmä, polku, kysely ja rungon tavut, kun kyse on samasta tarkoitetusta lähetyksestä. Muuttunut sisältö edellyttää erikseen tarkistettua pyyntöä; älä vaihda avaimia harkitsematta aikakatkaisun jälkeen. Valmis pyyntö voi palauttaa välimuistiin tallennetun virheen uudelleen, ja käsiteltävänä olevan pyynnön kaksoiskappale voi palauttaa koodin 409 ja Retry-After-otsakkeen.
Lue kampanja uudelleen
HTTP 200 palauttaa kampanjan suoraan JSON-objektina. Tarkista campaignId, hae sitten sama kampanja GET-pyynnöllä ja vertaa aiottuja kenttiä. Onnistunut tallennus ei itsessään pyydä uutta operaattorin tarkistusta, muuta numeroiden määrityksiä, aktivoi lähettämistä eikä lähetä viestiä.
Portaali tarkistaa lomakkeen version ennen tallentamista ja lukee kampanjan uudelleen sen jälkeen. Julkinen PUT-päätepiste ei valvo kyseistä portaalin versiota: sovi samanaikaisista muokkauksista muiden muokkaajien kanssa. Idempotenssiavain ei havaitse toisen muokkaajan tekemää päivitystä.
Jos portaali näyttää tarkistuksen hylkäyksen, jota ei ole vielä ratkaistu, korjaa ensin sisältö ja käytä sitten erillistä tarkistuksen pyytämistoimintoa, kun se on käytettävissä. Toiminto tarkistaa nykyisen tuotantokampanjan ja jakamisen tilan. Pelkkä sisällön tallentaminen ei käynnistä toimintoa, eikä kampanjatunnuksen olemassaolo tarkoita hyväksyntää.
Tavalliset kampanjan PUT-päivitykset eivät käynnistä erillistä kampanjan rekisteröintiveloitusta nykyisessä palvelussa. Olemassa olevat kuukausimaksut, vähimmäissitoumukset, numerovuokrat ja viestien käyttömaksut ovat edelleen voimassa. Katso tällä hetkellä määritetyt kampanjahinnat kohdasta kampanjamaksut.
Käsittele rajoitukset ja epävarmat tulokset
Kun saat koodin HTTP 400, lue kenttäkohtainen virhe ja tarkista pituudet, suostumusteksti ja kampanjan tila. Kun saat koodin 401, 403 tai 404, tarkista API-tunnistetiedot, sallittu lähde-IP-osoite ja omistajuus. Kun saat koodin 429, noudata Retry-After-otsaketta. Jos saat koodin 500 tai 502 tai pyyntö keskeytyy, säilytä kampanjan tunnus ja mahdollinen requestId ja selvitä sitten olemassa olevan tietueen ajantasainen tila ennen uutta lähetystä.
Paikallinen tilannekuva riippuu palautetusta vastausrungosta. Osittaisesta vastauksesta, joka ei ole tyhjä, voi puuttua vanhempia kenttiä, kuten uusimisen metatietoja; tyhjä vastaus voi jättää vanhentuneet arvot ennalleen. Tarkista koko GET-tulos sen sijaan, että pitäisit pelkkää onnistumista todisteena kaikkien kenttien säilymisestä. Ilmoita ratkaisemattomista eroista tukeen. Tämä reitti ei päivitä operaattorimäärityksiä atomisesti eikä tarjoa yleistä toimintoa operaattoriaktivoinnin palauttamiseen.