MultiTEL
Kūrėjams

DELETE/tcr/v2/campaign/{campaignId}

Pranešimų siuntimo kampanijos išaktyvinimas

Nutraukite kampaniją, suderinkite jai priskirtus numerius ir sužinokite, ką reiškia sėkmingas atsakymas be turinio.

Šiame puslapyje
  1. Esamos pranešimų siuntimo kampanijos išaktyvinimas
  2. Pirmiausia pašalinkite susijusių numerių priskyrimus
  3. Pateikite numatytą išaktyvinimo užklausą
  4. Patikrinkite ir registraciją, ir priskyrimus
  5. Nutraukimas ir atsiskaitymas už paskyrą yra atskiri veiksmai

Esamos pranešimų siuntimo kampanijos išaktyvinimas

Naudokite šį maršrutą, kai nutraukiama paskyrai priklausanti kampanija. Išsaugokite kampanijos identifikatorių duomenims suderinti ir istorijai išlaikyti. Norėdami pataisyti turinį arba atnaujinti sutikimo tekstą, rinkitės veiksmą Atnaujinti pranešimų siuntimo kampaniją kaip alternatyvą.

Autentifikuokitės naudodami įjungtą API paskyrą per HTTPS iš leidžiamo šaltinio IP adreso. Pirmiausia gaukite kampanijos duomenis ir patikrinkite susietą prekės ženklą bei siuntimo numerius. Išaktyvinimas pakeičia registraciją; jis nesukuria pakaitinės kampanijos ir neperkelia numerių į kitą kampaniją.

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

Pirmiausia pašalinkite susijusių numerių priskyrimus

Viešoji kampanijos DELETE operacija neatsieja telefono numerių nuo pranešimų siuntimo operatoriaus ir nepašalina jų vietinio priskyrimo. Atlikite numerio priskyrimo kampanijai pašalinimo procedūrą kiekvienam susijusiam paskyrai priklausančiam numeriui, tada patikrinkite jo priskyrimą. Pašalinus priskyrimą, telefono numeris neatlaisvinamas.

Platesnė portalo procedūra „Ištrinti prekės ženklą“ prieš ištrindama prekės ženklą sutvarko jo kampanijas ir numerius. Nenaudokite šio veiksmo, jei ketinate išsaugoti prekės ženklą ir kitas jo kampanijas. Dabartiniame įprastame kampanijų redaktoriuje nėra atskiro kampanijos ištrynimo mygtuko, atitinkančio šį tiesioginį API maršrutą.

Pateikite numatytą išaktyvinimo užklausą

Patikrinę kampanijos identifikatorių ir susijusią siuntimo konfigūraciją, siųskite DELETE užklausą be JSON turinio:

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"

Dokumentacijoje nurodytas sėkmingas atsakymas yra HTTP 204 su tuščiu turiniu. Tikrinkite HTTP būseną, užuot tikėjęsi JSON status/response apvalkalo. Priėmusi ištrynimo užklausą, dabartinė tarnyba vietinėje sistemoje pažymi kampanijos išteklių kaip ištrintą ir nebegaliojantį, o jos senosios sistemos kampanijos įrašą – kaip nebegaliojantį. Prekės ženklo ji kaskadiškai neištrina.

Šiai numatytai užklausai naudokite vieną idempotentiškumo raktą ir išsaugokite tikslų metodą, kelią, užklausos parametrus bei turinio baitus, kad galėtumėte ją pakartoti. Dar apdorojamos užklausos dublikatas gali grąžinti 409 su Retry-After; užbaigtų užklausų atveju gali būti pakartotinai grąžintas išsaugotas rezultatas. Podėlyje išsaugota klaida arba nutrūkęs ryšys neleidžia nustatyti, ar registras jau atliko veiksmą. Išsaugokite kampanijos identifikatorių ir requestId, jei jis pateiktas.

Patikrinkite ir registraciją, ir priskyrimus

Po užklausos portale patikrinkite dabartinę kampanijos būseną ir susijusius numerius. Po nutraukimo API gali išlaikyti vietinius priklausomybės metaduomenis, kad paskyrai priklausantį identifikatorių vis dar būtų galima patikrinti; nedarykite išvados, kad tas pats identifikatorius visada turi grąžinti vietinį 404 atsakymą. Registras nustato grąžinamą būseną arba nutraukto įrašo prieinamumą.

Jei numeris lieka priskirtas, suderinkite esamą priskyrimą. Nekurkite kitos kampanijos vien tam, kad pakartotumėte išaktyvinimą, ir nemanykite, kad HTTP 204 įrodo, jog operatoriaus sistemoje priskyrimai buvo pašalinti. Jei registrui priėmus užklausą vietinis sinchronizavimas nepavyksta, API gali grąžinti 500, nors išaktyvinimas išorinėje sistemoje jau įvyko.

Išaktyvinimo rezultatai
RezultatasKitas veiksmas
204Atsakymo turinio neturi būti. Patikrinkite kampanijos būseną ir atskirai valdomus numerių priskyrimus.
400Perskaitykite pateiktą tikrinimo arba registro būsenos klaidos pranešimą. Patikrinkite tikslų kampanijos identifikatorių ir esamą būseną.
401, 403, 404Patikrinkite API prisijungimo duomenis, leidžiamą šaltinio IP adresą ir priklausomybę paskyrai. Nenaudokite kito kliento identifikatoriaus vietoj savojo.
409, 429Atskirkite vykdomą arba konfliktuojančią idempotentinę užklausą nuo užklausų dažnio ribojimo; laikykitės Retry-After, jei ši antraštė pateikta.
500, 502 arba baigėsi laukimo laikasIšsaugokite užklausos duomenis, gaukite esamos kampanijos duomenis ir juos suderinkite prieš pateikdami kitą užklausą.

Nutraukimas ir atsiskaitymas už paskyrą yra atskiri veiksmai

Dabartinė DELETE tarnyba neinicijuoja nedelsiamo mokesčio už kampanijos registraciją nurašymo. Tai nežada pinigų grąžinimo, nepanaikina esamo įsipareigojimo ir neatlaisvina nuomojamų numerių. Portale patikrinkite paskyros kampanijų sąlygas ir neapmokėtas sąskaitas. Numerių nuoma ir pranešimų siuntimas apskaitomi atskirai nuo kampanijos registracijos.

Jei suderinus kampanijas ir priskyrimus nutraukiama visa įmonės registracija, pereikite prie prekės ženklo registracijos nutraukimo.