Poista viestikampanja käytöstä

Poista olemassa oleva viestikampanja käytöstä

Käytä tätä reittiä, kun tilin omistama kampanja poistetaan käytöstä. Säilytä kampanjan tunniste täsmäytystä ja historiatietoja varten. Sisällön korjaamiseen tai suostumustekstin päivittämiseen käytä toimintoa Päivitä viestikampanja sen sijaan.

Tunnistaudu käytössä olevalla API-tilillä HTTPS-yhteyden kautta sallitusta lähde-IP-osoitteesta. Lue ensin kampanjan tiedot ja tarkista siihen liittyvä brändi sekä lähetysnumerot. Käytöstäpoisto muuttaa rekisteröintiä; se ei luo korvaavaa kampanjaa eikä siirrä numeroita toiseen kampanjaan.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

Poista ensin asiaankuuluvat numeroliitokset

Kampanjan julkinen DELETE-toiminto ei irrota puhelinnumeroita viestioperaattorilta eikä poista niiden paikallista liitosta. Käytä työnkulkua numeron kampanjaliitoksen poistaminen jokaiselle asiaankuuluvalle tilin omistamalle numerolle ja tarkista sitten numeron liitos. Liitoksen poistaminen ei vapauta puhelinnumeroa.

Portaalin laajempi Poista brändi -työnkulku siivoaa brändin kampanjat ja numeroliitokset ennen brändin poistamista. Älä käytä tätä toimintoa, jos aiot säilyttää brändin ja sen muut kampanjat. Nykyisessä tavallisessa kampanjaeditorissa ei ole erillistä kampanjan poistopainiketta, joka vastaisi tätä suoraa API-reittiä.

Lähetä aiottu käytöstäpoistopyyntö

Kun olet tarkistanut kampanjan tunnisteen ja asiaankuuluvat lähetysasetukset, lähetä DELETE-pyyntö ilman JSON-runkoa:

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

Dokumentoitu onnistuneen pyynnön vastaus on HTTP 204, jonka runko on tyhjä. Tarkista HTTP-tilakoodi sen sijaan, että odottaisit JSON-muotoista status/response-vastauskuorta. Kun poisto hyväksytään, nykyinen palvelu merkitsee kampanjaresurssin paikallisesti poistetuksi ja vanhentuneeksi sekä sen vanhan järjestelmän kampanjatietueen vanhentuneeksi. Poisto ei ulotu automaattisesti brändiin.

Käytä tälle aiotulle pyynnölle yhtä ja samaa idempotenssiavainta ja säilytä menetelmä, polku, kyselyosa ja rungon tavut täsmälleen samoina uusintaa varten. Käsiteltävänä olevan pyynnön kaksoiskappale voi palauttaa koodin 409 ja Retry-After-otsakkeen; valmistuneiden pyyntöjen tallennettu tulos voidaan palauttaa uudelleen. Välimuistiin tallennettu virhe tai katkennut yhteys ei osoita, onko rekisteri jo suorittanut toimenpiteen. Säilytä kampanjan tunniste ja requestId, jos se on saatavilla.

Tarkista sekä rekisteröinti että liitokset

Tarkista pyynnön jälkeen portaalista kampanjan nykyinen tila ja asiaankuuluvat numerot. API voi säilyttää paikalliset omistajuuden metatiedot käytöstäpoiston jälkeen, jotta tilille kuuluva tunniste voidaan edelleen tarkistaa; älä päättele, että saman tunnisteen on aina palautettava paikallinen 404-vastaus. Rekisteri määrää palautettavan tilan tai käytöstä poistetun tietueen saatavuuden.

Jos numero on edelleen liitettynä, täsmäytä kyseinen olemassa oleva liitos. Älä luo toista kampanjaa vain yrittääksesi käytöstäpoistoa uudelleen äläkä oleta, että HTTP 204 todistaa operaattorin puolella tehdyn siivouksen. Jos paikallinen synkronointi epäonnistuu rekisterin hyväksyttyä pyynnön, API voi palauttaa koodin 500, vaikka ulkoinen käytöstäpoisto on jo tapahtunut.

Käytöstäpoisto on erillinen asia tilin loppuselvityksestä

Nykyinen DELETE-palvelu ei käynnistä välitöntä kampanjan rekisteröintiveloitusta. Tämä ei lupaa hyvitystä, poista olemassa olevaa sitoumusta eikä vapauta vuokrattuja numeroita. Tarkista portaalista tilin kampanjaehdot ja maksamattomat laskut. Numeroiden vuokraus ja viestien käyttö ovat erillisiä kampanjan rekisteröinnistä.

Jos koko yritysrekisteröinti poistetaan käytöstä sen kampanjoiden ja liitosten täsmäyttämisen jälkeen, jatka vaiheeseen brändin käytöstäpoisto.