MultiTEL
Geliştiriciler

GET/tcr/v2/enum/{type}

Mesajlaşma kaydı kataloglarını yükleme

İşletme türleri, sektörler ve kullanım senaryoları dahil olmak üzere mesajlaşma markaları ve kampanyaları için güncel seçenekleri yükleyin. Bu kataloglar form değerlerini sağlar; bir kampanyayı kaydetmez veya onaylamaz.

Bu sayfada
  1. Kayıt formunu oluşturmadan önce seçenekleri yükleyin
  2. Bir katalog seçin
  3. TCR yanıtını doğrudan işleyin
  4. Katalog seçeneklerini uygunluk değerlendirmesi ve fiyatlandırmadan ayrı tutun
  5. Kullanılamayan katalogları ele alın
  6. İstek
  7. Yanıt
  8. Hatalar
  9. Kullanılabilirlik ve yan etkiler

Kayıt formunu oluşturmadan önce seçenekleri yükleyin

Seçenekleri doldurmak için kayıt sistemi değerlerini koda sabit olarak yazmak yerine güncel mesajlaşma kaydı kataloğunu kullanın. Portal, marka formu için işletme türü, sektör, alternatif işletme kimliği türü, markayla ilişki, ülke, ABD eyaleti ve borsa kataloglarını yükler. Kampanya formu için kullanım senaryolarını, geçerli alt kullanım senaryolarını ve bağlantı ortaklarını yükler. Döndürülen her makine değerini görüntüleme etiketiyle birlikte saklayın; daha sonraki bir isteği oluştururken çevrilmiş etiketi değil, değeri kullanın.

Bir katalog seçin

Portalın kullandığı kataloglar
AdAmaç
usecaseKampanya kullanım senaryosu tanımları. Alt kullanım senaryosu seçeneklerini yüklerken validSubUsecase=true parametresini ekleyin.
entityTypeMarkanın işletme veya kuruluş türü.
verticalMarka için sektör seçenekleri.
altBusinessIdTypeAlternatif işletme kimliği kategorileri.
brandRelationshipKayıt formunda kullanılan ilişki seçenekleri.
countryKayıt sisteminin ülke seçenekleri; bunlar telefon numarası sunulan ülkelerden ayrıdır.
usStateKayıt adresleri için ABD eyaleti seçenekleri.
stockExchangeMarkanın işletme türünün gerektirdiği durumlar için borsa seçenekleri.
cnpBağlantı ortağı kimlikleri. Hesabınızın kampanya iş akışının desteklediği ortağı seçin.

TCR yanıtını doğrudan işleyin

Yanıt gövdesi doğrudan TCR API hizmetine aittir. Birçok eski /v3 uç noktasından farklı olarak ek bir status/response sarmalayıcısı içermez. Yorumlamadan önce HTTP durumunu kontrol edin. Bir katalog, dize etiketleri veya yapılandırılmış tanımlar içerebilir; bu nedenle her değerin aynı alanlara sahip olduğunu varsaymayın. HTTP isteği başarılı olsa bile gövde beklenen yapıda geçerli bir JSON değilse, sessizce boş bir listeyle değiştirmek yerine sorgulamanın başarısız olduğunu bildirin.

Katalog seçeneklerini uygunluk değerlendirmesi ve fiyatlandırmadan ayrı tutun

Genel kullanım senaryosu kataloğu, belirli bir markanın hangi kullanım senaryoları için uygun olduğunu göstermez. Mevcut portal, kampanya oluşturmadan önce markaya özel uygunluk sorgulaması yapar ve seçilen operatörün gerekliliklerini kontrol eder. Benzer şekilde, bir tedarikçinin ücret meta verileri hesabın nihai perakende fiyatı değildir. Hesaba uygulanan fiyatı ve kayıt koşullarını ayrıca inceleyin. Katalog yüklemek bir markayı, kampanyayı veya mesajlaşma numarasını onaylamaz.

Kullanılamayan katalogları ele alın

Sorgulama başarısız olursa müşterinin forma girdiği bilgileri koruyun. Hatayı gösterin ve Retry-After döndürülmüşse buna uyun; yeniden denemeler arasında giderek artan sürelerle bekleyin. Her kataloğu tekrar tekrar yüklemeyin ve hız sınırı veya aktarım hatasını boş, geçerli bir katalog olarak değerlendirmeyin. Bu GET isteği bir idempotans anahtarı gerektirmez ve değişiklik işlemlerinin idempotans deposundan yeniden yürütülmez.

İstek

İzin verilen bir kaynak IP adresinden HTTPS üzerinden etkin bir API hesabı kullanın. Mevcut yol, Basic kimlik doğrulaması ve taşıyıcı belirteciyle kimlik doğrulayan etkin API hesapları dahil olmak üzere hesabın kimlik doğrulama politikasını destekler. Sağlayıcının kimlik bilgilerini kullanmayın.

Yolda desteklenen bir katalog adıyla GET isteği gönderin. Geçerli katalog filtrelerini sorgu dizesinde iletin. İstek gövdesi gerekmez.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"
Yol parametreleri
AdTürZorunluAçıklama
typedizeEvetÖzgün büyük/küçük harf kullanımı korunmuş katalog adı. Portal usecase, entityType, vertical, altBusinessIdType, brandRelationship, country, usState, stockExchange ve cnp kataloglarını kullanır. Bunlar katalog adlarıdır; marka veya kampanya kimlikleri değildir.
Sorgu parametreleri
AdTürZorunluAçıklama
validSubUsecasemantıksal değerHayırPortal, usecase kataloğunda geçerli alt kullanım senaryosu seçeneklerini yüklemek için true değerini gönderir. Normal kullanım senaryosu kataloğunu yüklerken bu parametreyi göndermeyin. Kullanılabilirlik bilgisi ve tanımlar kayıt sistemi tarafından sağlanır.

Yanıt

Bu TCR yolu, kayıt sisteminin gövdesini HTTP durumuyla birlikte doğrudan döndürür. Eski v3 status.code/status.msg/response zarfını kullanmaz. Katalog yapıları farklılık gösterir: bazıları değerleri açıklayıcı nesnelere, diğerleri ise dizelere eşler. Daha sonra bir form gönderirken makine tarafından okunabilir anahtarları koruyun. Kısaltılmış, kurgusal usecase örneği nesne değerli bir eşlemeyi gösterir; canlı bir katalog veya eksiksiz olduğu garanti edilen bir şema değildir. Hem HTTP durumunu hem de beklenen JSON yapısını kontrol edin.

Örnek yanıt yapısıdır; canlı hesap verisi veya güncel bir fiyat teklifi değildir.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Hatalar

  • 401: Hesap kimlik doğrulaması başarısız oldu. API kimlik bilgisini, hesabın etkinlik durumunu ve geçerli kaynak IP kısıtlamalarını kontrol edin.
  • 400/404 ve diğer kayıt sistemi hataları: Katalog veya filtre geçersiz ya da kullanılamıyor. Mevcut yol, üst hizmetin HTTP durumunu ve yanıt gövdesini korur; evrensel bir v3 hata zarfı yoktur.
  • 429: Hesabın veya sağlayıcının paylaşılan istek sınırına ulaşıldı. Retry-After başlığına uyun ve giderek artan bekleme süreleriyle yeniden deneyin.
  • 502: Kayıt sistemine ulaşılamadı. Kullanılabilirlik bilinmiyor; başarılı sonuç yerine boş seçenekler sunmayın.
  • 503: İstek sınırlayıcı veya üst hizmet kullanılamıyor. Yeniden denemeden önce gövdeyi ve varsa Retry-After başlığını inceleyin.

Kullanılabilirlik ve yan etkiler

  • Bu katalog GET isteği, incelenen yürütme yolunda marka veya kampanya oluşturmaz, kayıt başvurusu göndermez, kaynak ayırmaz veya kayıt ücreti tahsil etmez. Sağlayıcıyla iletişim kurar ve istek denetim kayıtları yazar.
  • Katalog tanımları ve varsa tedarikçi ücret meta verileri, müşteriye yönelik perakende fiyat teklifi değildir. Mevcut portal, perakende kampanya fiyatlarını ayrıca alır; eski getCampaignPrice yardımcı işlevi ve eski numaralandırma türlerindeki fiyat açıklamaları bu yolun fiyatlandırma sözleşmesi olarak değerlendirilmemelidir.
  • Desteklenen bir katalog girdisi, belirli bir markanın o kullanım senaryosu için uygun olduğunu kanıtlamaz. Daha sonraki bir kayıt isteğinden önce markaya özel uygunluk değerlendirmesini, beyanları, onay işlemlerini ve hesap fiyatlandırması incelemesini tamamlayın.