Bir markanın kampanya gereksinimlerini okuyun

Markayı ve kullanım senaryosunu birlikte tutun

Hesabınızdaki marka kimliğini ve aynı markanın yeterlilik listesi tarafından döndürülen bir kullanım senaryosu değerini kullanın. Müşteri iş akışı, sağlayıcı isteğinden önce sahipliği denetler. Döndürülen nesnenin usecase alanının seçilen değerle eşleştiğini doğrulayın. Bir marka veya kullanım senaryosu için yapılan sorgu, bir başkası için gereksinimleri belirlemez.

Güncel gereksinimleri okuyun

Seçili operatörlerin gereksinimlerini birlikte uygulayın

Operatör gereksinimleri farklılık gösterebilir. Açık bir operatör listesi sağlanmadığında portal yanıttaki tüm operatör meta verilerini dikkate alır; boş olmayan bir liste ise kontrolleri yalnızca seçilen kimliklerle sınırlar. Yalnızca ilk operatörün örnek sayısını veya beyanlarını kullanmayın. Operatörleri yanıttan seçin, destek ve yeterliliği kontrol edin, geçerli en yüksek örnek minimumunu karşılayın ve bu seçimin tamamında gerekli katılım (opt-in), çıkış (opt-out) ve yardım beyanlarını sağlayın. Portal, güncel yanıtta bulunmayan seçili operatör kimliklerini reddeder ve uygun operatör içermeyen bir seçimi reddeder.

Gereksinimler nelerin sağlanması gerektiğini açıklar; müşterinin onay sürecinin veya kampanya içeriğinin bu gereksinimleri karşıladığını kanıtlamaz. Doğru ve temsil edici örnekler ile beyanlar toplayın. Bir formun geçmesini sağlamak için beyanları otomatik olarak açmayın.

Örnekleri ve abone yanıtlarını hazırlayın

Güncel kampanya formu, mesaj örnekleri için sample1 ile sample5 arasındaki alanları kullanır. Gereksinimler mevcut form içinde karşılanamıyorsa durun ve seçimi destek ekibiyle çözün. Etkin bir abone beyanı için ilgili anahtar kelimeleri ve yanıt metnini sağlayın: optinKeywords/optinMessage, optoutKeywords/optoutMessage ve helpKeywords/helpMessage. Örnekleri seçilen kullanım senaryosuyla ve gerçek müşteri mesajlaşmasıyla tutarlı tutun.

Herhangi bir kayıt isteğinden önce gözden geçirin

Marka, kullanım senaryosu veya operatör seçimi değiştiğinde gereksinimleri yenileyin. Portal, oluşturmadan önce seçilen kullanım senaryosunu, alt kullanım senaryosu sayısını, operatör uygunluğunu, örnekleri ve beyanları yeniden doğrular. Hesap fiyatlandırmasını ve kayıt koşullarını ayrıca gözden geçirin. Bu GET bir kampanyayı kaydetmez veya onaylamaz, mesajlaşma operatörüyle paylaşmaz veya bir telefon numarası atamaz. Oluşturma ve sağlama (provisioning) ayrı işlemlerdir.

Başarısız bir gereksinim sorgusunu ele alın

İstek başarısız olursa, beklenmeyen JSON döndürürse veya seçilen kullanım senaryosuyla eşleşmezse formu eksik tutun ve hata giderildikten sonra müşterinin yeniden denemesine izin verin. Kullanılamayan gereksinimleri boş bir nesneyle değiştirmeyin veya eksik verinin gereksinim olmadığı anlamına geldiğini varsaymayın. Retry-After değerine uyun ve hız sınırları ile kullanılabilirlik hataları için geri çekilme (backoff) uygulayın.

İstek

HTTPS üzerinden, izin verilen bir kaynak IP adresinden etkin bir API hesabı kullanın. Güncel rota, Basic kimlik doğrulaması ve etkin taşıyıcı (bearer) API hesapları dahil olmak üzere hesap kimlik doğrulama politikasını destekler. Sağlayıcı kimlik bilgilerini kullanmayın.

URL yolunda marka kimliği ve seçilen kullanım senaryosu değeriyle GET isteği gönderin. İstek gövdesi gerekmez.

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

Yanıt

Güncel TCR rotası, kayıt defteri JSON gövdesini doğrudan döndürür ve HTTP durumunu korur. Eski v3 status/response zarfını eklemez. Kısaltılmış kurgusal örnek, canlı bir yeterlilik sonucu değildir. Kullanmadan önce HTTP durumunu ve beklenen JSON biçimini kontrol edin. Portal, usecase alanı seçilen kullanım senaryosuyla eşleşen bir nesne bekler. Operatör gereksinimleri, operatör kimliğine göre anahtarlanmış olarak mnoMetadata altında yer alır. Örnek operatör kimliği ve gereksinimler kurgusaldır. Başka sağlayıcı alanları da döndürülebilir.

Örnek amaçlı yanıt biçimi; canlı hesap verisi veya güncel bir fiyat teklifi değildir.

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

Hatalar

• 401: Hesap kimlik doğrulaması başarısız oldu. API kimlik bilgilerini, etkin durumu ve geçerli kaynak IP kısıtlamalarını kontrol edin.
• 404: Marka, kimliği doğrulanmış hesapla ilişkili değil veya sağlayıcı istenen markayı ya da seçimi bulamıyor. Yerel bir sahiplik reddi, sağlayıcı isteğinden önce döndürülür.
• Diğer kayıt defteri hataları: Üst kaynaktaki HTTP durumu ve gövde korunur. Geçersiz veya kullanılamayan bir kullanım senaryosu, başarılı bir boş gereksinim kümesi değildir.
• 429: Hesap veya paylaşılan sağlayıcı istek sınırına ulaşıldı. Retry-After değerine uyun.
• 502/503: Aktarım, sağlayıcı veya hız sınırlayıcı kullanılabilirlik hatası. Formu koruyun ve geri çekilme (backoff) ile yeniden deneyin.

Kullanılabilirlik ve yan etkiler

• İncelenen GET isteği, mevcut marka sahipliğini kontrol eder, kayıt defteriyle iletişim kurar ve istek denetim kayıtları yazar. Bir marka veya kampanya oluşturmaz ya da kayıt ücreti tahsil etmez.
• Sağlayıcı ücret meta verileri, bir MultiTEL müşteri perakende fiyat teklifi değildir. Portal, sonraki bir kayıt isteğinden önce hesap fiyatlandırmasını ayrıca gözden geçirir.
• Yeterlilik ve gereksinimler değişebilir. Göndermeden önce seçilen marka ve kullanım senaryosu için bunları yenileyin. Başarılı bir sorgu; kampanya onayı, numara ataması veya mesajlaşmaya başlama izni değildir.