Pilih merek yang sudah ada di akun Anda
Mulailah dengan ID merek registri yang sudah dikaitkan dengan akun MultiTEL Anda. Pencarian ini tidak membuat merek atau mengaitkan merek milik orang lain dengan akun Anda. Alur kerja pelanggan saat ini memeriksa kepemilikan sebelum meminta informasi kelayakan. Jika pencarian mengembalikan 404, periksa akun dan merek yang dipilih alih-alih menggantinya dengan ID baris lokal.
Susun pilihan jenis penggunaan dari hasil ini
Katalog umum jenis penggunaan menjelaskan opsi registri. Pencarian khusus merek ini menyediakan pilihan untuk merek yang dipilih. Pertahankan setiap nilai usecase yang dikembalikan dan gabungkan dengan label tampilan serta deskripsinya dari katalog. Jangan tawarkan semua entri katalog umum seolah-olah merek tersebut memenuhi syarat untuk semuanya.
Portal mengharapkan respons ini berupa daftar JSON. Jika respons tidak ada, formatnya salah, atau terjadi galat, pertahankan formulir pelanggan dan tampilkan bahwa informasi kelayakan tidak dapat dimuat. Jangan menganggapnya sebagai persetujuan untuk jenis penggunaan bawaan tanpa memberi tahu pelanggan. Registri dapat mengembalikan kolom tambahan di luar yang ditampilkan dalam contoh ringkas.
Muat persyaratan untuk jenis penggunaan yang dipilih
Setelah pelanggan memilih salah satu nilai jenis penggunaan yang dikembalikan, kirim permintaan ke /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} untuk merek yang sama. Respons tersebut menyediakan batasan subjenis penggunaan dan persyaratan khusus operator. Gunakan informasi ini untuk mengumpulkan contoh pesan, persetujuan, dan pernyataan wajib lainnya. Daftar kelayakan saja tidak cukup untuk menyusun pendaftaran kampanye yang lengkap.
Tinjau harga akun secara terpisah
Kolom penyedia seperti monthlyFee, quarterlyFee atau annualFee, jika dikembalikan, menjelaskan metadata biaya penyedia. Kolom tersebut tidak menggantikan harga akun pelanggan atau ketentuan pendaftaran. Portal saat ini membaca harga eceran kampanye secara terpisah dan menggabungkannya dengan data kelayakan untuk layar peninjauan. Jangan menyimpulkan biaya yang dikenakan kepada pelanggan dari harga yang ditanam tetap dalam kode pembantu enumerasi lama.
Perbarui saat merek atau jenis penggunaan berubah
Buang pilihan milik merek sebelumnya saat beralih merek dan muat informasi kelayakan untuk pilihan baru. Muat ulang persyaratan jenis penggunaan yang dipilih sebelum pengajuan. Permintaan GET ini tidak mengajukan pendaftaran, mengaktifkan kampanye, atau mengalokasikan nomor.
Permintaan
Gunakan akun API yang diaktifkan melalui HTTPS dari alamat IP sumber yang diizinkan. Rute saat ini mendukung kebijakan autentikasi akun, termasuk autentikasi Basic dan akun API bearer yang diaktifkan. Jangan gunakan kredensial penyedia.
Kirim GET dengan pengenal merek di jalur URL. Isi permintaan tidak diperlukan.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
brand_id | Teks | Ya | ID merek registri yang dikaitkan dengan akun MultiTEL Anda yang terautentikasi. Gunakan ID merek, bukan ID baris basis data lokal, ID kampanye, atau nomor pajak usaha. Enkodekan sebagai satu segmen jalur URL. |
Respons
Rute TCR saat ini mengembalikan isi JSON registri secara langsung dan mempertahankan status HTTP-nya. Rute ini tidak menambahkan pembungkus status/response versi lama v3. Contoh fiktif yang diringkas tersebut bukan hasil kelayakan aktual. Periksa status HTTP dan struktur JSON yang diharapkan sebelum menggunakannya. Portal saat ini mengharapkan daftar rekaman kelayakan, yang masing-masing mengidentifikasi satu usecase. Portal menggabungkan rekaman tersebut dengan katalog usecase untuk mendapatkan label tampilan dan membaca harga eceran secara terpisah. Kolom tambahan dari penyedia dapat disertakan.
Ilustrasi struktur respons; bukan data akun aktual atau penawaran harga saat ini.
[
{
"usecase": "2FA"
}
]Galat
- 401: Autentikasi akun gagal. Periksa kredensial API, status pengaktifan, dan pembatasan IP sumber yang berlaku.
- 404: Merek tidak dikaitkan dengan akun yang terautentikasi, atau penyedia tidak dapat menemukan merek atau pilihan yang diminta. Penolakan kepemilikan lokal dikembalikan sebelum permintaan dikirim ke penyedia.
- Galat registri lainnya: Status dan isi HTTP dari layanan hulu dipertahankan. Jenis penggunaan yang tidak valid atau tidak tersedia bukanlah respons berhasil dengan kumpulan persyaratan kosong.
- 429: Batas permintaan akun atau batas bersama penyedia telah tercapai. Patuhi Retry-After.
- 502/503: Terjadi kegagalan ketersediaan transportasi, penyedia, atau pembatas laju. Pertahankan formulir dan coba lagi dengan jeda yang bertambah.
Ketersediaan dan efek samping
- Permintaan GET yang ditinjau memeriksa kepemilikan merek yang sudah ada, menghubungi registri, dan menulis catatan audit permintaan. Permintaan ini tidak membuat merek atau kampanye, maupun mengenakan biaya pendaftaran.
- Metadata biaya penyedia bukan penawaran harga eceran untuk pelanggan MultiTEL. Portal meninjau harga akun secara terpisah sebelum permintaan pendaftaran berikutnya.
- Kelayakan dan persyaratan dapat berubah. Muat ulang keduanya untuk merek dan jenis penggunaan yang dipilih sebelum pengajuan. Pencarian yang berhasil bukan persetujuan kampanye, alokasi nomor, atau izin untuk mulai mengirim pesan.