Baca persyaratan kampanye suatu merek

Jaga agar merek dan kasus penggunaan tetap bersama

Gunakan ID merek pada akun Anda dan nilai kasus penggunaan yang dikembalikan oleh daftar kualifikasi merek yang sama. Alur kerja pelanggan memeriksa kepemilikan sebelum permintaan ke penyedia. Pastikan nilai usecase pada objek yang dikembalikan cocok dengan nilai yang dipilih. Pencarian untuk satu merek atau kasus penggunaan tidak menetapkan persyaratan untuk merek atau kasus penggunaan lainnya.

Baca persyaratan saat ini

Terapkan persyaratan operator terpilih secara bersamaan

Persyaratan operator dapat berbeda. Jika tidak ada daftar operator eksplisit yang diberikan, portal mempertimbangkan semua metadata operator dalam respons; daftar yang tidak kosong membatasi pemeriksaan hanya pada ID yang dipilih tersebut. Jangan hanya menggunakan jumlah sampel atau deklarasi dari operator pertama. Pilih operator dari respons, periksa dukungan dan kualifikasi, penuhi minimum sampel tertinggi yang berlaku, dan penuhi deklarasi opt-in, opt-out, dan bantuan yang diwajibkan di seluruh pilihan tersebut. Portal menolak ID operator terpilih yang tidak ada dalam respons saat ini dan menolak pilihan yang tidak memiliki operator yang memenuhi syarat.

Persyaratan menjelaskan apa yang harus diberikan; persyaratan tidak membuktikan bahwa proses persetujuan pelanggan atau konten kampanye memenuhi persyaratan tersebut. Kumpulkan sampel dan deklarasi yang jujur dan representatif. Jangan mengaktifkan deklarasi secara otomatis hanya agar formulir lolos.

Siapkan sampel dan respons pelanggan

Formulir kampanye saat ini menggunakan sample1 hingga sample5 untuk sampel pesan. Jika persyaratan tidak dapat dipenuhi dalam formulir yang tersedia, hentikan dan selesaikan pilihan tersebut bersama tim dukungan. Untuk deklarasi pelanggan yang diaktifkan, berikan kata kunci dan teks respons yang bersangkutan: optinKeywords/optinMessage, optoutKeywords/optoutMessage, dan helpKeywords/helpMessage. Jaga agar sampel tetap konsisten dengan kasus penggunaan yang dipilih dan pesan pelanggan yang sebenarnya.

Tinjau sebelum permintaan pendaftaran apa pun

Segarkan persyaratan saat pilihan merek, kasus penggunaan, atau operator berubah. Portal memvalidasi ulang kasus penggunaan yang dipilih, jumlah sub-kasus penggunaan, kelayakan operator, sampel, dan deklarasi sebelum pembuatan. Tinjau harga akun dan ketentuan pendaftaran secara terpisah. GET ini tidak mendaftarkan atau menyetujui kampanye, tidak membagikannya kepada operator pesan, dan tidak menetapkan nomor telepon. Pembuatan dan penyediaan adalah operasi yang terpisah.

Tangani pencarian persyaratan yang gagal

Jika permintaan gagal, mengembalikan JSON yang tidak terduga, atau tidak cocok dengan kasus penggunaan yang dipilih, biarkan formulir tetap tidak lengkap dan biarkan pelanggan mencoba lagi setelah kesalahan teratasi. Jangan mengganti persyaratan yang tidak tersedia dengan objek kosong atau berasumsi bahwa data yang hilang berarti tidak ada persyaratan. Patuhi Retry-After dan gunakan backoff untuk batas laju dan kegagalan ketersediaan.

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.

GET dengan ID merek dan nilai kasus penggunaan yang dipilih di jalur URL. Tidak diperlukan badan permintaan.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"

Respons

Rute TCR saat ini mengembalikan badan JSON registri secara langsung dan mempertahankan status HTTP-nya. Rute ini tidak menambahkan amplop status/response v3 lama. Contoh fiktif yang disingkat ini bukan hasil kualifikasi langsung. Periksa status HTTP dan bentuk JSON yang diharapkan sebelum menggunakannya. Portal mengharapkan objek yang usecase-nya cocok dengan kasus penggunaan yang dipilih. Persyaratan operator berada di bawah mnoMetadata, menggunakan ID operator sebagai kunci. ID operator dan persyaratan dalam contoh bersifat fiktif. Bidang penyedia lainnya mungkin dikembalikan.

Bentuk respons ilustratif; bukan data akun langsung atau penawaran harga saat ini.

{
  "usecase": "2FA",
  "minSubUsecases": 0,
  "maxSubUsecases": 0,
  "mnoMetadata": {
    "12345": {
      "mnoSupport": true,
      "qualify": true,
      "minMsgSamples": 1,
      "reqSubscriberOptin": true,
      "reqSubscriberOptout": true,
      "reqSubscriberHelp": true,
      "noEmbeddedLink": false,
      "noEmbeddedPhone": false
    }
  }
}

Kesalahan

• 401: Autentikasi akun gagal. Periksa kredensial API, status aktif, dan pembatasan IP sumber yang berlaku.
• 404: Merek tidak terkait dengan akun yang terautentikasi, atau penyedia tidak dapat menemukan merek atau pilihan yang diminta. Penolakan kepemilikan lokal dikembalikan sebelum permintaan ke penyedia.
• Kesalahan registri lainnya: Status dan badan HTTP dari hulu dipertahankan. Kasus penggunaan yang tidak valid atau tidak tersedia bukanlah set persyaratan kosong yang berhasil.
• 429: Batas permintaan akun atau penyedia bersama tercapai. Patuhi Retry-After.
• 502/503: Kegagalan ketersediaan transportasi, penyedia, atau pembatas laju. Pertahankan formulir dan coba lagi dengan backoff.

Ketersediaan dan efek samping

• GET yang ditinjau memeriksa kepemilikan merek yang ada, menghubungi registri, dan menulis catatan audit permintaan. Operasi ini tidak membuat merek atau kampanye dan tidak membebankan biaya pendaftaran.
• Metadata biaya penyedia bukan penawaran harga ritel pelanggan MultiTEL. Portal meninjau harga akun secara terpisah sebelum permintaan pendaftaran selanjutnya.
• Kualifikasi dan persyaratan dapat berubah. Segarkan keduanya untuk merek dan kasus penggunaan yang dipilih sebelum pengajuan. Pencarian yang berhasil bukanlah persetujuan kampanye, penetapan nomor, atau izin untuk mulai mengirim pesan.