Menonaktifkan kampanye pesan

Menonaktifkan kampanye pesan yang sudah ada

Gunakan rute ini saat menghentikan kampanye milik akun. Simpan ID kampanyenya untuk rekonsiliasi dan riwayat. Untuk memperbaiki konten atau memperbarui teks persetujuan, gunakan Memperbarui kampanye pesan sebagai gantinya.

Lakukan autentikasi dengan akun API yang diaktifkan melalui HTTPS dari alamat IP sumber yang diizinkan. Baca data kampanye terlebih dahulu dan periksa merek serta nomor pengirim yang terkait. Penonaktifan mengubah pendaftaran; tindakan ini tidak membuat kampanye pengganti atau memindahkan nomor ke kampanye lain.

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

Hapus penetapan nomor yang terdampak terlebih dahulu

Operasi DELETE kampanye publik tidak memutus keterkaitan nomor telepon dari operator pesan atau menghapus penetapan lokalnya. Gunakan alur kerja penghapusan penetapan nomor ke kampanye untuk setiap nomor milik akun yang terdampak, lalu verifikasi penetapannya. Menghapus penetapan tidak melepaskan nomor telepon tersebut.

Alur kerja Hapus merek di portal memiliki cakupan lebih luas: alur ini membersihkan kampanye dan nomor terkait sebelum menghapus merek tersebut. Jangan gunakan tindakan itu jika Anda ingin mempertahankan merek beserta kampanye lainnya. Editor kampanye biasa saat ini tidak menyediakan tombol hapus kampanye terpisah yang setara dengan rute API langsung ini.

Kirim permintaan penonaktifan yang dimaksud

Setelah meninjau ID kampanye dan pengaturan pengiriman yang terdampak, kirim DELETE tanpa isi 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"

Respons berhasil yang didokumentasikan adalah HTTP 204 dengan isi kosong. Periksa status HTTP, alih-alih mengharapkan pembungkus status/response berformat JSON. Saat penghapusan diterima, layanan saat ini menandai sumber daya kampanye sebagai dihapus dan kedaluwarsa secara lokal, serta menandai catatan kampanye pada sistem lamanya sebagai kedaluwarsa. Penghapusan ini tidak merambat ke merek.

Gunakan satu kunci idempotensi untuk permintaan yang dimaksud ini dan pertahankan metode, jalur, kueri, serta bita isi persis seperti semula untuk pengiriman ulang. Duplikat permintaan yang sedang diproses dapat mengembalikan 409 dengan Retry-After; permintaan yang telah selesai dapat mengembalikan kembali hasil yang tersimpan. Galat yang tersimpan dalam tembolok atau koneksi yang terputus tidak memastikan apakah registri sudah menjalankan tindakan tersebut. Simpan ID kampanye dan requestId jika tersedia.

Verifikasi pendaftaran dan penetapan nomor

Periksa keadaan terkini kampanye dan nomor yang terdampak di portal setelah permintaan dikirim. API dapat mempertahankan metadata kepemilikan lokal setelah penghentian agar pengenal milik akun masih dapat diperiksa; jangan menyimpulkan bahwa ID yang sama harus selalu mengembalikan 404 lokal. Registri menentukan status yang dikembalikan atau ketersediaan catatan yang telah dihentikan.

Jika suatu nomor masih ditetapkan, rekonsiliasi penetapan yang sudah ada tersebut. Jangan membuat kampanye lain hanya untuk mencoba kembali penonaktifan atau menganggap HTTP 204 membuktikan bahwa pembersihan di sisi operator telah dilakukan. Jika sinkronisasi lokal gagal setelah registri menerima permintaan, API dapat mengembalikan 500 meskipun penonaktifan di sistem eksternal sudah terjadi.

Hasil penonaktifan
Hasil	Langkah berikutnya
204	Respons tidak diharapkan memiliki isi. Verifikasi keadaan kampanye dan penetapan nomor yang dikelola secara terpisah.
400	Baca galat validasi atau keadaan registri yang diberikan. Periksa ID kampanye yang tepat dan keadaan yang ada.
401, 403, 404	Periksa kredensial API, IP sumber yang diizinkan, dan kepemilikan akun. Jangan menggantinya dengan ID pelanggan lain.
409, 429	Bedakan permintaan idempoten yang sedang berlangsung atau berkonflik dari pembatasan laju permintaan; patuhi Retry-After jika diberikan.
500, 502 atau batas waktu terlampaui	Simpan detail permintaan, baca data kampanye yang sudah ada, dan lakukan rekonsiliasi sebelum mengirim permintaan lagi.

Penghentian terpisah dari penyelesaian tagihan akun

Layanan DELETE saat ini tidak mengirim instruksi pendebitan langsung untuk pendaftaran kampanye. Hal ini tidak menjanjikan pengembalian dana, menghapus komitmen yang sudah ada, atau melepaskan nomor sewaan. Periksa ketentuan kampanye akun dan faktur yang belum dibayar di portal. Penyewaan nomor dan penggunaan pesan terpisah dari pendaftaran kampanye.

Jika seluruh pendaftaran bisnis akan dihentikan setelah kampanye dan penetapannya direkonsiliasi, lanjutkan dengan penghentian merek.