Deaktiver en beskedkampagne

Deaktiver en eksisterende beskedkampagne

Brug dette endepunkt, når en kampagne, der tilhører kontoen, skal udfases. Gem kampagnens id til afstemning og historik. Ved rettelser af indhold eller opdateringer af samtykketekst skal du bruge Opdater en beskedkampagne i stedet.

Autentificer dig med en aktiveret API-konto via HTTPS fra en tilladt kilde-IP-adresse. Hent først kampagnen, og kontroller det tilknyttede brand og afsendernumrene. Deaktivering ændrer registreringen; den opretter ikke en erstatningskampagne og flytter ikke numre til en anden kampagne.

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

Fjern først de berørte nummertilknytninger

Det offentlige DELETE-endepunkt for kampagner fjerner ikke telefonnumre fra beskedoperatøren og rydder ikke deres lokale tilknytning. Brug arbejdsgangen til fjernelse af et nummers tilknytning til en kampagne for hvert berørt nummer, der tilhører kontoen, og kontroller derefter dets tilknytning. Fjernelse af en tilknytning frigiver ikke telefonnummeret.

Portalens mere omfattende arbejdsgang Slet brand rydder op i brandets kampagner og numre, før brandet slettes. Brug ikke denne handling, hvis du vil beholde brandet og dets øvrige kampagner. Den nuværende almindelige kampagneeditor har ikke en særskilt knap til sletning af kampagner, som svarer til dette direkte API-endepunkt.

Indsend den ønskede deaktivering

Når du har gennemgået kampagnens id og den berørte afsendelsesopsætning, skal du sende DELETE uden en JSON-brødtekst:

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"

Det dokumenterede svar ved en vellykket anmodning er HTTP 204 med en tom brødtekst. Kontroller HTTP-statussen frem for at forvente en JSON-svarindpakning med status/response. Når sletningen accepteres, markerer den nuværende tjeneste kampagneressourcen som slettet og udløbet lokalt og markerer den tilhørende ældre kampagnepost som udløbet. Sletningen videreføres ikke til brandet.

Brug én idempotensnøgle til denne tilsigtede anmodning, og bevar den nøjagtige metode, sti, forespørgsel og brødtekstens bytes til gentagelse. En dublet af en anmodning, der er under behandling, kan returnere 409 med Retry-After; for afsluttede anmodninger kan det gemte resultat returneres igen. En fejl i cachen eller en afbrudt forbindelse fastslår ikke, om registret allerede har udført handlingen. Gem kampagnens id og requestId, når det foreligger.

Kontroller både registrering og tilknytninger

Kontroller kampagnens aktuelle tilstand og de berørte numre i portalen efter anmodningen. API'et kan bevare lokale metadata om ejerskab efter udfasningen, så en identifikator, der tilhører kontoen, stadig kan kontrolleres; antag ikke, at det samme id altid skal returnere en lokal 404. Registret afgør, hvilken status der returneres, eller om den udfasede post er tilgængelig.

Hvis et nummer fortsat er tilknyttet, skal du afstemme den eksisterende tilknytning. Opret ikke en anden kampagne blot for at forsøge deaktiveringen igen, og antag ikke, at HTTP 204 beviser, at oprydningen hos operatøren er sket. Hvis den lokale synkronisering mislykkes, efter at registret har accepteret anmodningen, kan API'et returnere 500, selvom den eksterne deaktivering allerede er sket.

Udfasning er adskilt fra kontoafregning

Den nuværende DELETE-tjeneste udløser ikke en øjeblikkelig debitering for kampagneregistrering. Dette er ikke et løfte om tilbagebetaling, ophæver ikke en eksisterende forpligtelse og frigiver ikke lejede numre. Kontroller kontoens kampagnevilkår og udestående fakturaer i portalen. Nummerleje og beskedforbrug er adskilt fra kampagneregistrering.

Hvis hele virksomhedsregistreringen skal udfases, efter at dens kampagner og tilknytninger er blevet afstemt, skal du fortsætte med udfasning af brandet.