Geliştiriciler

POST/tcr/v2/brand/nonBlocking

Bir mesajlaşma markası kaydetme

Hesaba ait bir işletme kimliği kaydedin, sandbox kullanımını isteklerde açıkça belirtin ve doğrulama ile ücretleri mutabakata bağlayın.

Bu sayfada
  1. Mesajlarınızın arkasındaki işletmeyi kaydedin
  2. Açık bir sandbox isteğiyle başlayın
  3. İşletme ve iletişim alanları
  4. Kararlı bir idempotency anahtarı koruyun
  5. Markayı ve durumunu okuyun
  6. Üretim ücretleri
  7. Hataları markayı çoğaltmadan ele alın

Mesajlarınızın arkasındaki işletmeyi kaydedin

Bir mesajlaşma markası, ABD 10DLC mesajlarını gönderen işletmeyi tanımlar. Bir kampanya kullanım senaryosu seçmeden önce markayı kaydedin. İşletmenin yasal bilgilerini ve gerekli her doğrulamayı tamamlayabilecek bir iletişim kişisini kullanın. Döndürülen bir marka kimliği, tek başına, mesaj gönderme onayı değildir.

Bu mevcut hesaba ait rotayı, etkin bir API hesabı ve izin verilen kaynak IP adresi ile HTTPS üzerinden kullanın. user_id, username veya başka bir müşterinin sahip tanımlayıcısını göndermeyin. MultiTEL, sahipliği kimliği doğrulanmış hesaptan kaydeder.

Açık bir sandbox isteğiyle başlayın

Portal, formundaki mode alanını varsayılan olarak sandbox değerine ayarlar; doğrudan bir API isteği, sahte (mock) bir marka amaçladığınızda JSON boolean mock: true değerini açıkça içermelidir. Bu bayrağın atlanması bir sandbox garantisi değildir ve ücretlendirilebilir bir üretim kaydı oluşturabilir. Portalın mode alanı, API'nin mock alanının yerine geçmez.

Aşağıdaki alanları kullanarak yerel bir brand.json dosyası hazırlayın. Yer tutucuları uygun test bilgileri ve güncel katalog kodlarıyla değiştirin. Bu örnek özel kâr amaçlı bir işletmedir; diğer tüzel kişilik türlerinin gereksinimleri farklıdır.

{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "Example business",
  "companyName": "Example legal business name",
  "ein": "YOUR_TAX_ID",
  "einIssuingCountry": "US",
  "phone": "+12025550123",
  "street": "123 Example Street",
  "city": "Example City",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "email": "contact@example.invalid",
  "brandRelationship": "BASIC_ACCOUNT",
  "vertical": "CURRENT_VERTICAL_CODE",
  "referenceId": "your-business-reference",
  "mock": true
}

Yukarıdaki işletme, adres, telefon ve tanımlayıcı birer yer tutucudur, kayda hazır bir işletme kimliği değildir. entityType, vertical, country, state, brandRelationship ve diğer numaralandırmalar için güncel değerleri şuradan alın: mesajlaşma katalogları.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data-binary @brand.json \
  'https://api.multitel.net/tcr/v2/brand/nonBlocking'

İşletme ve iletişim alanları

Marka kayıt alanları
AlanlarSağlanacak bilgiler
entityType, displayNameGüncel tüzel kişilik türü kodu ve tanınabilir marka adı. Maksimum uzunluklar sırasıyla 20 ve 255 karakterdir.
country, street, city, state, postalCodeGerçek işletme adresi. İki harfli ülke kodunu ve uygun olduğunda güncel bir ABD state kodunu kullanın. Sınırlar: street 255, city 100, state 20 ve postalCode 10 karakter.
email, phoneEn fazla 100 karakterlik çalışan bir iletişim e-postası ve uluslararası +ülke-kodu biçiminde, en fazla 20 karakterlik bir telefon numarası. İşletme bilgilerini kayıt boyunca tutarlı tutun.
companyName, ein, einIssuingCountryKuruluşlar için yasal şirket adını ve işletme vergi tanımlayıcısını sağlayın. Tanımlayıcıyı veren ülke ayrı, iki harfli bir alandır. Sınırlar: companyName 255 ve ein 21 karakter. Şahıs işletmesi sahibi, bir kuruluşun vergi kimliği yerine kişisel ad alanlarını kullanır.
brandRelationship, verticalGüncel katalog kodlarını kullanarak işletmeyle ilişki ve sektörü. Kuruluşlar için bunlar zorunludur; şahıs işletmesi kuralları farklıdır. API kodlarının yerine çevrilmiş görüntü etiketleri koymayın.
firstName, lastName, mobilePhoneŞahıs işletmesi sahibi için zorunludur. Ad alanlarının her biri en fazla 100 karakter alır. Zorunlu OTP doğrulaması için uluslararası biçimde, uygun bir mobil numara sağlayın.
stockSymbol, stockExchange, website, businessContactEmailHalka açık bir şirketin ayrıca ek doğrulama süreci için hisse senedi sembolü/borsası, website ve uygun bir işletme iletişim e-postası gerekir. Sınırlar: stockSymbol 10, website 255 ve businessContactEmail 255 karakter.
altBusinessIdType, altBusinessIdİsteğe bağlı alternatif işletme tanımlayıcısı. Türünü ve değerini birlikte sağlayın. Güncel tür kataloğunu kullanın; değer en fazla 50 karakter alır.
referenceIdEn fazla 50 karakterlik işletme referansınız. Güncel tüzel kişiliğe özgü gereksinimler kapsamında şahıs işletmesi kaydı için ekleyin. Bu bir işletme meta verisidir, isteğin idempotency anahtarı değildir.
website, ipAddress, tagUygun olduğunda ek web sitesi, kaynak IP meta verisi ve etiket değerleri. Bunlar hesap sahipliğini belirlemez ve kimlik denetimlerinin yerine geçmez.
mockBir JSON boolean değeri. true değerini yalnızca amaçlanan sahte (mock) iş akışı için kullanın; açıkça incelenmiş bir üretim kaydı için false kullanın. JSON boolean yerine "false" dizesini göndermeyin.

Şahıs işletmesi sahipleri ABD veya Kanada kayıtları için desteklenir ve kampanya uygunluğundan önce OTP doğrulaması gerektirir. Halka açık şirketler bir işletme iletişim doğrulama adımı gerektirebilir. GOVERNMENT, ABD merkezli kamu kurumları içindir; diğer kuruluşlar için doğru tüzel kişilik kategorisini teyit edin. Tüzel kişiliğe özgü gereksinimlere ve döndürülen doğrulama hatalarına uyun.

Kararlı bir idempotency anahtarı koruyun

Bu amaçlanan kayıt için tek bir Idempotency-Key oluşturun. Boşluk içermeyen 1–128 yazdırılabilir ASCII karakterden oluşmalıdır. Aynı anahtarı yalnızca aynı HTTP yöntemi, yol, sorgu dizesi ve birebir aynı istek gövdesi baytlarıyla yeniden kullanın. JSON'u yeniden biçimlendirmek, anlamını değiştirmese bile istek parmak izini değiştirir.

Tamamlanmış anahtarlı bir istek, yeni bir kayıt gönderimi olmadan saklanan yanıtını yeniden oynatabilir. Hâlâ işlenmekte olan bir yineleme HTTP 409 döndürür ve Retry-After içerebilir. Aynı anahtarla değiştirilmiş bir istek çakışır. Sırf bir istek zaman aşımına uğradı veya hata döndürdü diye yeni bir anahtar oluşturmayın: işletme zaten kaydedilmiş olabilir.

Bu isteği çözümlerken brand.json dosyasını değiştirmeden tutun. Önbelleğe alınmış bir 500 veya 502, kaydı yeniden denemek yerine özgün hatayı yeniden oynatabilir. Döndürülen brandId, requestId ve korelasyon başlıklarını saklayın; farklı bir isteğe başlamadan önce mevcut markayı mutabakata bağlayın.

Markayı ve durumunu okuyun

Bu API, v3 status/response zarfı yerine HTTP durum kodlarını ve doğrudan bir JSON gövdesi kullanır. Başarılı kayıt, brandId içeren bir marka nesnesi döndürür. Bu tanımlayıcıyı saklayın ve döndürülen doğrulama veya kimlik durumunu inceleyin. Ek alanlar tüzel kişiliğe ve kayıt durumuna bağlıdır.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID"

Yalnızca hesabınıza ait bir markayı okuyun. Bir 404, markanın bu hesap için kullanılabilir olmadığı anlamına gelebilir. Gerekli her doğrulamayı tamamlayın, ardından kullanılabilir kampanya kullanım senaryolarını bulmak için marka yeterliliği işlevini kullanın. Sahte (mock) kaynakların üretim gönderimi için uygun olduğu varsayılamaz.

Üretim ücretleri

Mevcut yapılandırılmış marka kayıt ücretleri
KayıtÜcret
Standart kuruluş$5.00
Şahıs işletmesi$4.45
Sahte (mock) markaSahte (mock) iş akışında marka kayıt borçlandırması yoktur

Bu perakende tutarları 24 Ekim 2026 tarihinde mevcut portal yapılandırmasına göre kontrol edildi. Üretim kaydından önce güncel ücreti portalda teyit edin. Kampanya ücretleri, ek inceleme ve mesajlaşma kullanımı ayrıdır. Bir üretim kaydı, gönderimden önce satın alma iznini ve kullanılabilir bakiyeyi denetler; markanın kayıt sisteminde başarıyla oluşturulması ve yerel faturalandırma ayrı işleme adımlarıdır, bu nedenle kaynak kimliğini saklayın ve bir hata veya faturalandırma sorunu oluşursa işlemleri mutabakata bağlayın.

Sahte (mock) bir markayı üretime değiştirmek ayrıca onaylanan bir iş akışıdır ve yeni bir üretim kimliği ile ücret oluşturabilir. Sonraki bir istekte mock değerini false olarak düzenlemenin mevcut markayı dönüştürdüğünü varsaymayın.

Hataları markayı çoğaltmadan ele alın

Kayıt hataları
HTTP sonucuKontrol edilecekler
400Alan hatalarını okuyun. Kayıt defteri doğrulama hataları bir code/description nesneleri dizisi olabilir. Yerel idempotency anahtarı doğrulaması da 400 döndürebilir.
401, 403 veya 404API kimlik bilgilerini, API hesabının izin verilen kaynak IP'sini, müşteri izinlerini ve sahipliği kontrol edin. Bir kayıt defteri yanıtı kendi yetkilendirme hatasını da taşıyabilir.
402Bakiyeyi ve satın alma iznini gözden geçirin. Bakiyesi olmayan bir üretim isteğini sandbox testi olarak değerlendirmeyin.
409Devam eden bir isteği beklerken aynı anahtarı ve değiştirilmemiş isteği koruyun. Değiştirilmiş bir gövde/anahtar çakışması veya kurtarılamayan önceki bir yanıt önce mutabakat gerektirir.
429 veya sınırlayıcı kullanılamıyor yanıtıMevcut olduğunda Retry-After değerine uyun. Sınır kalktıktan sonra aynı amaçlanan isteği ve anahtarı yeniden deneyin.
500 veya 502Uzak işlem kabul edilmiş olabilir. Yerel bir işleme hatası requestId içerebilir. Bunu kaydedin ve mevcut kaynağı kontrol edin; yeni bir marka kaydının gerekli olduğunu varsaymayın.