Deaktiveer 'n bestaande boodskapveldtog
Gebruik hierdie roete wanneer 'n veldtog wat aan die rekening behoort, beëindig word. Bewaar die veldtog se identifiseerder vir rekonsiliasie en geskiedenis. Vir inhoudskorreksies of opdaterings aan toestemmingsteks, gebruik Werk 'n boodskapveldtog by eerder.
Verifieer jou identiteit met 'n geaktiveerde API-rekening oor HTTPS vanaf 'n toegelate bron-IP-adres. Lees eers die veldtog se besonderhede en kontroleer die gekoppelde handelsmerk en versendingsnommers. Deaktivering verander die registrasie; dit skep nie 'n vervangende veldtog of skuif nommers na 'n ander veldtog nie.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Verwyder eers die betrokke nommertoewysings
Die openbare DELETE-bewerking vir veldtogte ontkoppel nie telefoonnommers van die boodskapdiensoperateur of verwyder hul plaaslike toewysing nie. Gebruik die werkvloei om 'n nommer se toewysing aan 'n veldtog te verwyder vir elke betrokke nommer wat aan die rekening behoort, en kontroleer dan die toewysing daarvan. Die verwydering van 'n toewysing stel nie die telefoonnommer vry nie.
Die portaal se omvattender werkvloei ‘Verwyder handelsmerk’ ruim die handelsmerk se veldtogte en nommertoewysings op voordat dit die handelsmerk verwyder. Moenie dié aksie gebruik wanneer jy die handelsmerk en sy ander veldtogte wil behou nie. Die huidige gewone veldtogredigeerder het nie 'n afsonderlike knoppie om 'n veldtog te verwyder wat met hierdie direkte API-roete ooreenstem nie.
Dien die beoogde deaktivering in
Nadat jy die veldtog se identifiseerder en die betrokke versendingsopstelling nagegaan het, stuur DELETE sonder 'n JSON-liggaam:
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"Die gedokumenteerde suksesvolle antwoord is HTTP 204 met 'n leë liggaam. Kontroleer die HTTP-status eerder as om 'n JSON-omhulsel met status/response te verwag. Wanneer die verwydering aanvaar word, merk die huidige diens die veldtoghulpbron plaaslik as verwyder en verval, en merk dit die ou veldtogrekord as verval. Dit voer nie 'n kaskadeverwydering van die handelsmerk uit nie.
Gebruik een idempotensiesleutel vir hierdie beoogde versoek en bewaar die presiese metode, pad, navraag en liggaamgrepe vir herhaling. 'n Duplikaat van 'n versoek wat nog verwerk word, kan 409 met Retry-After teruggee; voltooide versoeke kan die gestoorde resultaat weer teruggee. 'n Gekaste fout of onderbroke verbinding bevestig nie of die register reeds opgetree het nie. Bewaar die veldtog se identifiseerder en requestId wanneer dit teenwoordig is.
Kontroleer sowel die registrasie as die toewysings
Kontroleer die veldtog se huidige toestand en die betrokke nommers in die portaal ná die versoek. Die API kan plaaslike eienaarskapmetadata ná beëindiging behou sodat 'n identifiseerder wat aan die rekening behoort, steeds nagegaan kan word; moenie aflei dat dieselfde identifiseerder altyd plaaslik 404 moet teruggee nie. Die register bepaal die status wat teruggegee word of die beskikbaarheid van die beëindigde rekord.
As 'n nommer steeds toegewys is, rekonsilieer daardie bestaande toewysing. Moenie nog 'n veldtog skep bloot om deaktivering weer te probeer nie, en moenie aanvaar dat HTTP 204 bewys dat die opruiming by die operateur plaasgevind het nie. As plaaslike sinchronisasie misluk nadat die register die versoek aanvaar het, kan die API 500 teruggee al het die eksterne deaktivering reeds plaasgevind.
| Resultaat | Volgende stap |
|---|---|
| 204 | Geen antwoordliggaam word verwag nie. Kontroleer die veldtog se toestand en die nommertoewysings wat onafhanklik bestuur word. |
| 400 | Lees die verskafte valideringsfout of fout oor die register se toestand. Kontroleer die presiese veldtogidentifiseerder en die bestaande toestand. |
| 401, 403, 404 | Kontroleer die API-aanmeldbesonderhede, toegelate bron-IP-adres en rekeningeienaarskap. Moenie 'n ander kliënt se identifiseerder in die plek daarvan gebruik nie. |
| 409, 429 | Onderskei 'n idempotente versoek wat nog verwerk word of konflik veroorsaak van versoektempobeperking; hou by Retry-After waar dit verskaf word. |
| 500, 502 of tydverstryking | Bewaar die versoekbesonderhede, lees die bestaande veldtog se besonderhede en rekonsilieer dit voordat jy weer indien. |
Beëindiging staan los van die vereffening van 'n rekening
Die huidige DELETE-diens voer nie 'n onmiddellike debiet vir veldtogregistrasie uit nie. Dit beloof nie 'n terugbetaling, kanselleer nie 'n bestaande verpligting en stel nie gehuurde nommers vry nie. Kontroleer die rekening se veldtogbepalings en uitstaande fakture in die portaal. Nommerhuur en boodskapgebruik staan los van veldtogregistrasie.
As die hele besigheidsregistrasie beëindig word nadat die veldtogte en toewysings daarvan gerekonsilieer is, gaan voort met die beëindiging van die handelsmerkregistrasie.