Deaktiver en meldingskampanje

Deaktiver en eksisterende meldingskampanje

Bruk dette endepunktet når en kontoeid kampanje skal avvikles. Ta vare på kampanje-ID-en for avstemming og historikk. For rettelser i innholdet eller oppdateringer av samtykketeksten bruker du Oppdater en meldingskampanje i stedet.

Autentiser med en aktivert API-konto over HTTPS fra en tillatt kilde-IP-adresse. Hent kampanjen først, og kontroller den tilknyttede merkevaren og avsendernumrene. Deaktivering endrer registreringen; den oppretter ikke en erstatningskampanje og flytter ikke numre til en annen kampanje.

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

Fjern de berørte nummertilknytningene først

Den offentlige DELETE-operasjonen for kampanjer kobler ikke telefonnumre fra meldingsoperatøren og fjerner heller ikke den lokale tilknytningen. Bruk arbeidsflyten for å fjerne et nummers tilknytning til en kampanje for hvert berørte nummer som eies av kontoen, og kontroller deretter tilknytningen. Når en tilknytning fjernes, frigis ikke telefonnummeret.

Portalens mer omfattende arbeidsflyt Slett merkevare rydder opp i merkevarens kampanjer og numre før merkevaren slettes. Ikke bruk denne handlingen hvis du vil beholde merkevaren og de andre kampanjene dens. Det vanlige redigeringsverktøyet for kampanjer har foreløpig ingen egen knapp for kampanjesletting som tilsvarer dette direkte API-endepunktet.

Send inn den planlagte deaktiveringsforespørselen

Når du har kontrollert kampanje-ID-en og det berørte oppsettet for sending, sender du DELETE uten en forespørselskropp i JSON-format:

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 dokumenterte svaret ved vellykket behandling er HTTP 204 med tom svarkropp. Kontroller HTTP-statusen i stedet for å forvente en status/response-konvolutt i JSON-format. Når slettingen godtas, markerer den nåværende tjenesten kampanjeressursen som slettet og utløpt lokalt, og markerer kampanjeoppføringen i det eldre systemet som utløpt. Slettingen forplanter seg ikke til merkevaren.

Bruk én idempotensnøkkel for denne planlagte forespørselen, og bevar nøyaktig samme metode, sti, spørring og byte i forespørselskroppen ved gjentakelse. En duplikatforespørsel mens behandlingen pågår kan gi 409 med Retry-After; for fullførte forespørsler kan det lagrede resultatet returneres på nytt. En mellomlagret feil eller en avbrutt forbindelse fastslår ikke om registeret allerede har utført handlingen. Ta vare på kampanje-ID-en og requestId når den finnes.

Kontroller både registreringen og tilknytningene

Kontroller kampanjens gjeldende tilstand og de berørte numrene i portalen etter forespørselen. API-et kan beholde lokale metadata om eierskap etter avviklingen, slik at en identifikator som tilhører kontoen fortsatt kan kontrolleres; ikke anta at samme ID alltid må gi en lokal 404. Registeret avgjør hvilken status som returneres, eller om den avviklede oppføringen er tilgjengelig.

Hvis et nummer fortsatt er tilknyttet, må du avstemme den eksisterende tilknytningen. Ikke opprett en ny kampanje bare for å forsøke deaktivering på nytt, og ikke anta at HTTP 204 beviser at oppryddingen hos operatøren er utført. Hvis lokal synkronisering mislykkes etter at registeret har godtatt forespørselen, kan API-et returnere 500 selv om den eksterne deaktiveringen allerede er utført.

Resultater av deaktivering
Resultat	Neste steg
204	Det forventes ingen svarkropp. Kontroller kampanjens tilstand og nummertilknytningene som administreres separat.
400	Les den oppgitte feilen knyttet til validering eller registertilstand. Kontroller den nøyaktige kampanje-ID-en og den eksisterende tilstanden.
401, 403, 404	Kontroller API-påloggingsopplysningene, tillatt kilde-IP-adresse og kontoens eierskap. Ikke erstatt ID-en med en annen kundes ID.
409, 429	Skill mellom en pågående eller motstridende idempotent forespørsel og begrensning av forespørselsfrekvensen; følg Retry-After når denne er oppgitt.
500, 502 eller tidsavbrudd	Ta vare på forespørselsdetaljene, hent den eksisterende kampanjen og avstem tilstanden før du sender inn på nytt.

Avvikling er atskilt fra økonomisk oppgjør av kontoen

Den nåværende DELETE-tjenesten utløser ikke en umiddelbar belastning for kampanjeregistrering. Dette innebærer ikke et løfte om refusjon, fjerner ikke en eksisterende forpliktelse og frigir ikke leide numre. Kontroller kontoens kampanjevilkår og utestående fakturaer i portalen. Nummerleie og meldingsbruk er atskilt fra kampanjeregistrering.

Hvis hele bedriftsregistreringen skal avvikles etter at kampanjene og tilknytningene er avstemt, fortsetter du med avvikling av merkevaren.