Izstrādātājiem

DELETE/tcr/v2/campaign/{campaignId}

Ziņojumapmaiņas kampaņas deaktivizēšana

Pārtrauciet kampaņas darbību, saskaņojiet tās numuru piesaistes un izprotiet veiksmīgu atbildi ar tukšu saturu.

Šajā lapā
  1. Esošas ziņojumapmaiņas kampaņas deaktivizēšana
  2. Vispirms noņemiet attiecīgo numuru piesaistes
  3. Iesniedziet paredzēto deaktivizēšanas pieprasījumu
  4. Pārbaudiet gan reģistrāciju, gan piesaistes
  5. Darbības pārtraukšana ir nošķirta no norēķinu nokārtošanas kontā

Esošas ziņojumapmaiņas kampaņas deaktivizēšana

Izmantojiet šo maršrutu, lai pārtrauktu kontam piederošas kampaņas darbību. Saglabājiet kampaņas ID saskaņošanai un vēsturei. Satura labojumiem vai piekrišanas teksta atjauninājumiem izmantojiet funkciju Ziņojumapmaiņas kampaņas atjaunināšana kā alternatīvu.

Autentificējieties ar iespējotu API kontu, izmantojot HTTPS no atļautas avota IP adreses. Vispirms nolasiet kampaņas datus un pārbaudiet saistīto zīmolu un sūtīšanas numurus. Deaktivizēšana maina reģistrāciju; tā neizveido aizstājošu kampaņu un nepārvieto numurus uz citu kampaņu.

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

Vispirms noņemiet attiecīgo numuru piesaistes

Publiskā kampaņas DELETE darbība neatvieno tālruņa numurus no ziņojumapmaiņas operatora un nenoņem to lokālo piesaisti. Izmantojiet numura piesaistes kampaņai noņemšanas darbplūsmu katram attiecīgajam kontam piederošajam numuram un pēc tam pārbaudiet tā piesaisti. Piesaistes noņemšana neatbrīvo tālruņa numuru.

Portāla plašākā darbplūsma “Dzēst zīmolu” pirms zīmola dzēšanas veic tā kampaņu un numuru uzkopšanu. Neizmantojiet šo darbību, ja vēlaties saglabāt zīmolu un citas tā kampaņas. Pašreizējā parastajā kampaņu redaktorā nav atsevišķas kampaņas dzēšanas pogas, kas būtu līdzvērtīga šim tiešajam API maršrutam.

Iesniedziet paredzēto deaktivizēšanas pieprasījumu

Pēc kampaņas ID un attiecīgās sūtīšanas konfigurācijas pārskatīšanas nosūtiet DELETE pieprasījumu bez JSON satura:

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"

Dokumentētā veiksmīgā atbilde ir HTTP 204 ar tukšu saturu. Pārbaudiet HTTP statusu, nevis gaidiet JSON status/response atbildes apvalku. Kad dzēšana ir pieņemta, pašreizējais pakalpojums lokāli atzīmē kampaņas resursu kā dzēstu un tādu, kura derīgums ir beidzies, kā arī atzīmē mantoto kampaņas ierakstu kā tādu, kura derīgums ir beidzies. Dzēšana kaskādes veidā neattiecas uz zīmolu.

Šim paredzētajam pieprasījumam izmantojiet vienu idempotences atslēgu un atkārtotai izpildei saglabājiet precīzu metodi, ceļu, vaicājumu un satura baitus. Pieprasījuma, kas vēl tiek apstrādāts, dublikāts var atgriezt 409 ar Retry-After; pabeigtiem pieprasījumiem var tikt atkārtoti atgriezts saglabātais rezultāts. Kešatmiņā saglabāta kļūda vai pārtraukts savienojums neļauj noteikt, vai reģistrs jau ir veicis darbību. Saglabājiet kampaņas ID un requestId, ja tas ir norādīts.

Pārbaudiet gan reģistrāciju, gan piesaistes

Pēc pieprasījuma pārbaudiet portālā kampaņas pašreizējo stāvokli un attiecīgos numurus. Pēc darbības pārtraukšanas API var saglabāt lokālos īpašumtiesību metadatus, lai kontam piederošu identifikatoru joprojām varētu pārbaudīt; neizdariet secinājumu, ka tam pašam ID vienmēr jāatgriež lokāla 404 atbilde. Reģistrs nosaka atgriezto statusu vai darbību pārtraukušās kampaņas ieraksta pieejamību.

Ja numurs joprojām ir piesaistīts, saskaņojiet šo esošo piesaisti. Neveidojiet citu kampaņu tikai tāpēc, lai atkārtotu deaktivizēšanu, un neuzskatiet, ka HTTP 204 pierāda uzkopšanas pabeigšanu operatora pusē. Ja pēc pieprasījuma pieņemšanas reģistrā neizdodas lokālā sinhronizācija, API var atgriezt 500, lai gan ārējā deaktivizēšana jau ir notikusi.

Deaktivizēšanas rezultāti
RezultātsNākamā darbība
204Atbildes saturs nav paredzēts. Pārbaudiet kampaņas stāvokli un atsevišķi pārvaldītās numuru piesaistes.
400Izlasiet sniegto validācijas vai reģistra stāvokļa kļūdas ziņojumu. Pārbaudiet precīzu kampaņas ID un esošo stāvokli.
401, 403, 404Pārbaudiet API akreditācijas datus, atļauto avota IP adresi un piederību kontam. Neaizstājiet ID ar cita klienta ID.
409, 429Atšķiriet apstrādē esošu vai konfliktējošu idempotentu pieprasījumu no pieprasījumu biežuma ierobežošanas; ievērojiet Retry-After, ja tas ir norādīts.
500, 502 vai noildzeSaglabājiet pieprasījuma informāciju, nolasiet esošās kampaņas datus un pirms atkārtotas iesniegšanas saskaņojiet stāvokli.

Darbības pārtraukšana ir nošķirta no norēķinu nokārtošanas kontā

Pašreizējais DELETE pakalpojums neierosina tūlītēju maksas iekasēšanu par kampaņas reģistrāciju. Tas nesola atmaksu, neatceļ esošās saistības un neatbrīvo nomātos numurus. Portālā pārbaudiet konta kampaņu noteikumus un neapmaksātos rēķinus. Numuru noma un ziņojumu izmantošana ir nošķirta no kampaņas reģistrācijas.

Ja pēc kampaņu un to piesaistu saskaņošanas tiek pārtraukta visa uzņēmuma reģistrācija, turpiniet ar zīmola darbības pārtraukšanu.