Een bestaande berichtencampagne deactiveren
Gebruik deze route wanneer een campagne die eigendom is van het account buiten gebruik wordt gesteld. Bewaar de campagne-ID voor afstemming en de historie. Gebruik voor inhoudelijke correcties of wijzigingen in de toestemmingstekst Een berichtencampagne bijwerken in plaats daarvan.
Authenticeer u met een ingeschakeld API-account via HTTPS vanaf een toegestaan bron-IP-adres. Vraag eerst de campagnegegevens op en controleer het bijbehorende merk en de verzendnummers. Deactivering wijzigt de registratie; er wordt geen vervangende campagne aangemaakt en er worden geen nummers naar een andere campagne verplaatst.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Verwijder eerst de betrokken nummertoewijzingen
De openbare DELETE-bewerking voor campagnes ontkoppelt telefoonnummers niet bij de berichtenprovider en verwijdert hun lokale toewijzing niet. Gebruik de procedure voor het verwijderen van een nummertoewijzing aan een campagne voor elk betrokken nummer dat eigendom is van het account en controleer daarna de toewijzing. Door een toewijzing te verwijderen wordt het telefoonnummer niet vrijgegeven.
De uitgebreidere procedure ‘Merk verwijderen’ in het portaal ruimt de bijbehorende campagnes en nummers op voordat het merk wordt verwijderd. Gebruik die actie niet als u het merk en de andere bijbehorende campagnes wilt behouden. De huidige standaardeditor voor campagnes heeft geen afzonderlijke knop om een campagne te verwijderen die gelijkwaardig is aan deze directe API-route.
Dien het beoogde deactiveringsverzoek in
Controleer de campagne-ID en de betrokken verzendconfiguratie en verstuur daarna DELETE zonder JSON-body:
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"Het gedocumenteerde antwoord bij succes is HTTP 204 met een lege body. Controleer de HTTP-status in plaats van een JSON-envelop met status/response te verwachten. Wanneer de verwijdering is geaccepteerd, markeert de huidige service de campagneresource lokaal als verwijderd en verlopen, en de campagnerecord in het oude systeem als verlopen. Het bijbehorende merk wordt niet via een cascade verwijderd.
Gebruik één idempotentiesleutel voor dit beoogde verzoek en bewaar de exacte bytes van de methode, het pad, de query en de body voor herhaling. Een duplicaat van een verzoek dat nog wordt verwerkt, kan 409 met Retry-After retourneren; bij voltooide verzoeken kan het opgeslagen resultaat opnieuw worden teruggegeven. Een fout uit de cache of een verbroken verbinding maakt niet duidelijk of het register de actie al heeft uitgevoerd. Bewaar de campagne-ID en requestId indien aanwezig.
Controleer zowel de registratie als de toewijzingen
Controleer na het verzoek de huidige campagnestatus en de betrokken nummers in het portaal. De API kan na buitengebruikstelling lokale eigendomsmetadata behouden, zodat een identificatiecode die bij het account hoort nog steeds kan worden gecontroleerd; ga er niet van uit dat dezelfde ID altijd lokaal een 404 moet opleveren. Het register bepaalt de geretourneerde status en de beschikbaarheid van de buiten gebruik gestelde record.
Als een nummer toegewezen blijft, controleer dan die bestaande toewijzing en stem deze af. Maak niet zomaar een andere campagne aan om de deactivering opnieuw te proberen en neem niet aan dat HTTP 204 bewijst dat de provider de opschoning heeft uitgevoerd. Als de lokale synchronisatie mislukt nadat het register het verzoek heeft geaccepteerd, kan de API 500 retourneren terwijl de externe deactivering al heeft plaatsgevonden.
| Resultaat | Volgende stap |
|---|---|
| 204 | Er wordt geen body verwacht. Controleer de campagnestatus en de nummertoewijzingen die onafhankelijk daarvan worden beheerd. |
| 400 | Lees de ontvangen foutmelding over de validatie of de registerstatus. Controleer de exacte campagne-ID en de bestaande status. |
| 401, 403, 404 | Controleer de API-inloggegevens, het toegestane bron-IP-adres en het eigendom van het account. Gebruik geen ID van een andere klant. |
| 409, 429 | Maak onderscheid tussen een lopend of conflicterend idempotent verzoek en een beperking van het aantal verzoeken; houd rekening met Retry-After indien opgegeven. |
| 500, 502 of een time-out | Bewaar de verzoekgegevens, vraag de bestaande campagne op en stem de gegevens af voordat u opnieuw een verzoek indient. |
Buitengebruikstelling staat los van de financiële afwikkeling van een account
De huidige DELETE-service zet geen onmiddellijke afschrijving voor campagneregistratie in gang. Dit garandeert geen terugbetaling, heft geen bestaande verplichting op en geeft gehuurde nummers niet vrij. Controleer de campagnevoorwaarden en openstaande facturen van het account in het portaal. Nummerhuur en berichtengebruik staan los van campagneregistratie.
Als de volledige bedrijfsregistratie buiten gebruik wordt gesteld nadat de campagnes en toewijzingen zijn gecontroleerd en afgestemd, gaat u verder met het buiten gebruik stellen van het merk.