Arendajad

DELETE/tcr/v2/campaign/{campaignId}

Sõnumikampaania deaktiveerimine

Lõpetage kampaania, kooskõlastage selle numbriseosed ja mõistke tühja sisuga edukat vastust.

Sellel lehel
  1. Olemasoleva sõnumikampaania deaktiveerimine
  2. Eemaldage esmalt asjaomaste numbrite seosed
  3. Esitage kavandatud deaktiveerimistaotlus
  4. Kontrollige nii registreeringut kui ka seoseid
  5. Lõpetamine on konto arvelduste lõplikust tasaarvestusest eraldi

Olemasoleva sõnumikampaania deaktiveerimine

Kasutage seda marsruuti kontole kuuluva kampaania lõpetamisel. Säilitage kampaania ID andmete kooskõlastamiseks ja ajaloo jaoks. Sisu parandamiseks või nõusolekuteksti uuendamiseks kasutage toimingut Sõnumikampaania uuendamine selle asemel.

Autentige lubatud lähte-IP-aadressilt aktiveeritud API kontoga, kasutades protokolli HTTPS. Kõigepealt lugege kampaania andmeid ning kontrollige seotud kaubamärki ja saatmisnumbreid. Deaktiveerimine muudab registreeringut; see ei loo asenduskampaaniat ega vii numbreid teise kampaaniasse.

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

Eemaldage esmalt asjaomaste numbrite seosed

Kampaania avalik DELETE toiming ei lahuta telefoninumbreid sõnumsideoperaatorist ega eemalda nende kohalikku seost. Kasutage numbri ja kampaania seose eemaldamise töövoogu iga asjaomase kontole kuuluva numbri puhul ning seejärel kontrollige selle seost. Seose eemaldamine ei vabasta telefoninumbrit.

Portaali ulatuslikum töövoog „Kustuta kaubamärk” teeb enne kaubamärgi kustutamist selle kampaaniate ja numbrite korrastustoimingud. Ärge kasutage seda toimingut, kui soovite kaubamärgi ja selle teised kampaaniad alles jätta. Praeguses tavalises kampaaniaredaktoris pole eraldi kampaania kustutamise nuppu, mis vastaks sellele otsesele API marsruudile.

Esitage kavandatud deaktiveerimistaotlus

Pärast kampaania ID ja asjaomase saatmisseadistuse ülevaatamist saatke DELETE päring ilma JSON sisuta:

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"

Dokumenteeritud edukas vastus on HTTP 204 tühja sisuga. Kontrollige HTTP olekukoodi, selle asemel et oodata JSON status/response vastuseümbrist. Kui kustutamine võetakse vastu, märgib praegune teenus kampaania ressursi kohalikult kustutatuks ja aegunuks ning selle varasema süsteemi kampaaniakirje aegunuks. Kustutamine ei laiene kaskaadina kaubamärgile.

Kasutage selle kavandatud päringu jaoks üht idempotentsusvõtit ning säilitage kordamiseks täpne meetod, tee, päringuparameetrid ja sisu baidid. Veel töödeldava päringu duplikaat võib tagastada 409 koos päisega Retry-After; lõpetatud päringute korral võidakse uuesti tagastada salvestatud tulemus. Vahemällu salvestatud viga või katkenud ühendus ei näita, kas register on toimingu juba teinud. Säilitage kampaania ID ja requestId, kui see on olemas.

Kontrollige nii registreeringut kui ka seoseid

Pärast päringut kontrollige portaalis kampaania praegust olekut ja asjaomaseid numbreid. API võib pärast lõpetamist säilitada kohalikke omandiõiguse metaandmeid, et kontole kuuluvat identifikaatorit saaks endiselt kontrollida; ärge järeldage, et sama ID peab alati tagastama kohaliku 404 vastuse. Tagastatava oleku või lõpetatud kampaania kirje kättesaadavuse määrab register.

Kui number jääb seotuks, kooskõlastage see olemasolev seos. Ärge looge teist kampaaniat pelgalt deaktiveerimise kordamiseks ega eeldage, et HTTP 204 tõendab operaatoripoolsete korrastustoimingute tegemist. Kui kohalik sünkroonimine ebaõnnestub pärast seda, kui register on päringu vastu võtnud, võib API tagastada 500, kuigi väline deaktiveerimine on juba toimunud.

Deaktiveerimise tulemused
TulemusJärgmine samm
204Vastuse sisu pole ette nähtud. Kontrollige kampaania olekut ja eraldi hallatavaid numbriseoseid.
400Lugege edastatud valideerimisvea või registri olekuvea teadet. Kontrollige täpset kampaania ID-d ja olemasolevat olekut.
401, 403, 404Kontrollige API autentimisandmeid, lubatud lähte-IP-aadressi ja kontole kuulumist. Ärge asendage ID-d teise kliendi ID-ga.
409, 429Eristage pooleliolevat või vastuolulist idempotentset päringut päringusageduse piiramisest; järgige päist Retry-After, kui see on antud.
500, 502 või ajalõppSäilitage päringu üksikasjad, lugege olemasoleva kampaania andmeid ja kooskõlastage olek enne uut esitamist.

Lõpetamine on konto arvelduste lõplikust tasaarvestusest eraldi

Praegune DELETE teenus ei algata kohest kampaania registreerimistasu debiteerimist. See ei luba tagasimakset, ei tühista olemasolevat kohustust ega vabasta renditud numbreid. Kontrollige portaalis konto kampaaniatingimusi ja tasumata arveid. Numbrite rent ja sõnumite kasutus on kampaania registreerimisest eraldi.

Kui pärast kampaaniate ja seoste kooskõlastamist lõpetatakse kogu ettevõtte registreering, jätkake kaubamärgi lõpetamisega.