Deaktivirajte postojeću kampanju za razmjenu poruka
Upotrijebite ovu krajnju točku kada kampanju u vlasništvu računa povlačite iz upotrebe. Sačuvajte identifikator kampanje radi usklađivanja i povijesne evidencije. Za ispravke sadržaja ili ažuriranja teksta privole upotrijebite Ažuriranje kampanje za razmjenu poruka umjesto toga.
Autentificirajte se omogućenim računom za API putem protokola HTTPS s dopuštene izvorne IP adrese. Najprije dohvatite kampanju i provjerite povezanu robnu marku i brojeve za slanje. Deaktivacija mijenja registraciju; ne stvara zamjensku kampanju niti premješta brojeve u drugu kampanju.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"Najprije uklonite dodjele zahvaćenih brojeva
Javna operacija DELETE za kampanju ne odvaja telefonske brojeve od operatora za razmjenu poruka niti uklanja njihovu lokalnu dodjelu. Upotrijebite postupak uklanjanja dodjele broja kampanji za svaki zahvaćeni broj u vlasništvu računa, a zatim provjerite njegovu dodjelu. Uklanjanjem dodjele telefonski se broj ne oslobađa.
Širi postupak Brisanje robne marke na portalu provodi čišćenje njezinih kampanja i brojeva prije brisanja te robne marke. Nemojte upotrebljavati tu radnju ako želite zadržati robnu marku i njezine ostale kampanje. Trenutačni standardni uređivač kampanja nema zaseban gumb za brisanje kampanje koji bi bio ekvivalent ovoj izravnoj krajnjoj točki API-ja.
Pošaljite zahtjev za željenu deaktivaciju
Nakon što provjerite identifikator kampanje i zahvaćene postavke slanja, pošaljite DELETE bez tijela u formatu JSON:
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"Dokumentirani odgovor na uspješan zahtjev jest HTTP 204 s praznim tijelom. Provjerite status HTTP-a umjesto da očekujete omotnicu status/response u formatu JSON. Kada je brisanje prihvaćeno, trenutačna usluga lokalno označava resurs kampanje kao izbrisan i istekao, a pripadajući zapis kampanje iz starijeg sustava označava kao istekao. Brisanje se ne prenosi kaskadno na robnu marku.
Za ovaj namjeravani zahtjev upotrijebite jedan ključ idempotentnosti i za ponovno slanje sačuvajte točnu metodu, putanju, upit i bajtove tijela. Duplikat zahtjeva koji se obrađuje može vratiti 409 uz Retry-After; za dovršene zahtjeve može se ponovno vratiti pohranjeni rezultat. Pogreška pohranjena u predmemoriji ili prekinuta veza ne potvrđuju je li registar već izvršio radnju. Sačuvajte identifikator kampanje i requestId kada je prisutan.
Provjerite i registraciju i dodjele
Nakon zahtjeva na portalu provjerite trenutačno stanje kampanje i zahvaćene brojeve. API može zadržati lokalne metapodatke o vlasništvu nakon povlačenja iz upotrebe, pa se identifikator u vlasništvu računa i dalje može provjeriti; nemojte zaključiti da isti identifikator uvijek mora vratiti lokalni odgovor 404. Registar određuje vraćeni status ili dostupnost zapisa povučenog iz upotrebe.
Ako broj ostane dodijeljen, uskladite tu postojeću dodjelu. Nemojte stvarati drugu kampanju samo radi ponovnog pokušaja deaktivacije niti pretpostaviti da HTTP 204 dokazuje da je provedeno čišćenje kod operatora. Ako lokalna sinkronizacija ne uspije nakon što registar prihvati zahtjev, API može vratiti 500 iako je vanjska deaktivacija već provedena.
| Rezultat | Sljedeći korak |
|---|---|
| 204 | Tijelo se ne očekuje. Provjerite stanje kampanje i dodjele brojeva kojima se upravlja zasebno. |
| 400 | Pročitajte dostavljenu pogrešku provjere valjanosti ili stanja registra. Provjerite točan identifikator kampanje i postojeće stanje. |
| 401, 403, 404 | Provjerite vjerodajnice za API, dopuštenu izvornu IP adresu i vlasništvo računa. Nemojte umjesto toga upotrijebiti identifikator drugog korisnika. |
| 409, 429 | Razlikujte idempotentni zahtjev koji je u tijeku ili u sukobu od ograničenja učestalosti zahtjeva; poštujte Retry-After kada je naveden. |
| 500, 502 ili istek vremena čekanja | Sačuvajte pojedinosti zahtjeva, dohvatite postojeću kampanju i uskladite stanje prije ponovnog slanja. |
Povlačenje iz upotrebe odvojeno je od podmirenja računa
Trenutačna usluga DELETE ne pokreće trenutačno terećenje za registraciju kampanje. Time se ne obećava povrat novca, ne poništava postojeća obveza niti oslobađaju unajmljeni brojevi. Na portalu provjerite uvjete kampanje za taj račun i nepodmirene račune. Najam brojeva i potrošnja poruka odvojeni su od registracije kampanje.
Ako se cijela registracija poslovnog subjekta povlači iz upotrebe nakon što su njezine kampanje i dodjele usklađene, nastavite s postupkom za povlačenje robne marke iz upotrebe.