Deaktivace kampaně pro zasílání zpráv

Deaktivace existující kampaně pro zasílání zpráv

Tento koncový bod použijte při ukončování kampaně vlastněné účtem. ID kampaně si uchovejte pro kontrolu souladu a historii. Pro opravy obsahu nebo aktualizace textu souhlasu použijte Aktualizaci kampaně pro zasílání zpráv namísto deaktivace.

Ověřte se pomocí povoleného účtu API přes HTTPS z povolené zdrojové IP adresy. Nejprve načtěte kampaň a zkontrolujte přidruženou značku a čísla používaná k odesílání. Deaktivace mění registraci; nevytváří náhradní kampaň ani nepřesouvá čísla do jiné kampaně.

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

Nejprve odeberte přiřazení dotčených čísel

Veřejná operace DELETE pro kampaň neodpojuje telefonní čísla od operátora zajišťujícího zprávy ani nemaže jejich místní přiřazení. Použijte postup odebrání přiřazení čísla ke kampani pro každé dotčené číslo vlastněné účtem a poté ověřte jeho přiřazení. Odebrání přiřazení neuvolní telefonní číslo.

Rozsáhlejší postup Smazat značku v portálu provede úklid jejích kampaní a čísel před smazáním dané značky. Tuto akci nepoužívejte, pokud chcete značku a její ostatní kampaně zachovat. Současný běžný editor kampaní nenabízí samostatné tlačítko pro smazání kampaně odpovídající tomuto přímému koncovému bodu API.

Odešlete požadavek na zamýšlenou deaktivaci

Po kontrole ID kampaně a dotčeného nastavení odesílání odešlete DELETE bez těla ve formátu 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"

Dokumentovaná úspěšná odpověď je HTTP 204 s prázdným tělem. Kontrolujte stav HTTP a neočekávejte obálku status/response ve formátu JSON. Při přijetí smazání současná služba místně označí prostředek kampaně jako smazaný a s vypršenou platností a její záznam ve starším systému označí jako záznam s vypršenou platností. Smazání se kaskádově nepřenáší na značku.

Pro tento zamýšlený požadavek použijte jeden klíč idempotence a pro opakované odeslání zachovejte přesnou metodu, cestu, dotaz a bajty těla. Duplicitní požadavek, jehož původní zpracování ještě probíhá, může vrátit 409 s Retry-After; u dokončených požadavků lze znovu vrátit uložený výsledek. Chyba uložená v mezipaměti ani přerušené spojení neprokazují, zda registr již akci provedl. Uchovejte ID kampaně a také requestId, pokud je k dispozici.

Ověřte registraci i přiřazení

Po odeslání požadavku zkontrolujte v portálu aktuální stav kampaně a dotčená čísla. Rozhraní API může po ukončení zachovat místní metadata o vlastnictví, takže identifikátor patřící účtu lze nadále ověřovat; nevyvozujte z toho, že stejné ID musí vždy vrátit místní chybu 404. O vráceném stavu nebo dostupnosti ukončeného záznamu rozhoduje registr.

Pokud číslo zůstane přiřazené, zkontrolujte a uveďte do souladu jeho stávající přiřazení. Nevytvářejte další kampaň jen kvůli opakování deaktivace a nepředpokládejte, že HTTP 204 dokazuje provedení úklidu u operátora. Pokud po přijetí požadavku registrem selže místní synchronizace, může rozhraní API vrátit 500, i když externí deaktivace již proběhla.

Ukončení je oddělené od finančního vypořádání účtu

Současná služba DELETE nevyvolává okamžité zaúčtování poplatku za registraci kampaně. To nezaručuje vrácení peněz, neruší stávající závazek ani neuvolňuje pronajatá čísla. V portálu zkontrolujte podmínky kampaní pro daný účet a neuhrazené faktury. Pronájem čísel a využívání zpráv jsou oddělené od registrace kampaně.

Pokud po kontrole a uvedení kampaní a přiřazení do souladu ukončujete celou registraci firmy, pokračujte postupem pro ukončení registrace značky.