Inaktivera en meddelandekampanj

Inaktivera en befintlig meddelandekampanj

Använd denna anropsväg när en kampanj som ägs av kontot ska avvecklas. Spara kampanjens ID för avstämning och historik. För att rätta innehåll eller uppdatera samtyckestext använder du Uppdatera en meddelandekampanj i stället.

Autentisera med ett aktiverat API-konto via HTTPS från en tillåten käll-IP-adress. Läs först kampanjens uppgifter och kontrollera det kopplade varumärket och avsändarnumren. Inaktiveringen ändrar registreringen; den skapar ingen ersättningskampanj och flyttar inte nummer till en annan kampanj.

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

Ta först bort de berörda nummerkopplingarna

Det publika DELETE-anropet för kampanjer kopplar inte bort telefonnummer hos meddelandeoperatören och tar inte bort deras lokala koppling. Använd arbetsflödet för att ta bort ett nummers koppling till en kampanj för varje berört nummer som ägs av kontot och kontrollera sedan dess koppling. Att ta bort en koppling innebär inte att telefonnumret lämnas tillbaka.

Portalens mer omfattande arbetsflöde Ta bort varumärke rensar varumärkets kampanjer och nummerkopplingar innan varumärket tas bort. Använd inte den åtgärden om du vill behålla varumärket och dess övriga kampanjer. Den vanliga kampanjredigeraren har för närvarande ingen separat knapp för att ta bort en kampanj som motsvarar denna direkta API-anropsväg.

Skicka den avsedda inaktiveringsbegäran

När du har granskat kampanjens ID och de berörda sändningsinställningarna skickar du DELETE utan någon JSON-kropp:

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 dokumenterade svaret vid en lyckad begäran är HTTP 204 med tom kropp. Kontrollera HTTP-statusen i stället för att förvänta dig ett JSON-svar omslutet av status/response. När borttagningen godtas markerar den nuvarande tjänsten kampanjresursen som borttagen och utgången lokalt och markerar dess äldre kampanjpost som utgången. Borttagningen omfattar inte automatiskt varumärket.

Använd en och samma idempotensnyckel för denna avsedda begäran och bevara metod, sökväg, frågesträng och kroppens byte exakt för upprepning. En dubblett av en begäran som behandlas kan ge 409 med Retry-After; för slutförda begäranden kan det lagrade resultatet återges. Ett cachelagrat fel eller en avbruten anslutning visar inte om registret redan har utfört åtgärden. Spara kampanjens ID och requestId när det finns.

Kontrollera både registreringen och kopplingarna

Kontrollera kampanjens aktuella tillstånd och de berörda numren i portalen efter begäran. API:et kan behålla lokala metadata om ägarskap efter avvecklingen så att en identifierare som tillhör kontot fortfarande kan kontrolleras; dra inte slutsatsen att samma ID alltid måste ge ett lokalt 404-svar. Registret avgör vilken status som returneras och om den avvecklade posten är tillgänglig.

Om ett nummer fortfarande är kopplat ska du stämma av den befintliga kopplingen. Skapa inte en annan kampanj enbart för att försöka inaktivera igen och anta inte att HTTP 204 bevisar att rensningen hos operatören har utförts. Om den lokala synkroniseringen misslyckas efter att registret har godtagit begäran kan API:et returnera 500 trots att den externa inaktiveringen redan har utförts.

Avveckling är skild från ekonomisk slutreglering av kontot

Den nuvarande DELETE-tjänsten utlöser ingen omedelbar debitering för kampanjregistrering. Detta innebär inget löfte om återbetalning, upphäver inte ett befintligt åtagande och lämnar inte tillbaka hyrda nummer. Kontrollera kontots kampanjvillkor och obetalda fakturor i portalen. Nummerhyra och meddelandeanvändning är separata från kampanjregistreringen.

Om hela företagsregistreringen ska avvecklas efter att dess kampanjer och kopplingar har stämts av fortsätter du med avveckling av varumärket.