Bir numarayı mesajlaşma kampanyasına atama

Bir kampanyaya gönderim numarası atama

Bu işlemi, mesajlaşma markanız ve üretim kampanyanız kaydedildikten ve kampanya etkin hale geldikten sonra kullanın. İşlem, hesabınızdaki SMS özellikli bir numarayı kampanyayla ilişkilendirir. Marka oluşturmaz, kampanya oluşturmaz veya onaylamaz, numara satın almaz ve mesaj göndermez.

Mevcut portal, bir numaraya kampanya atarken bu rotayı kullanır. Genel API bir kampanya tanımlayıcısı kabul eder; markayı ayrı bir marka tanımlayıcısı kabul etmek yerine hesaba ait kampanyadan türetir.

İstek

Etkin API hesabınızı ve bu hesap için izin verilen kaynak IP adresini kullanarak HTTPS üzerinden form kodlamalı bir POST isteği gönderin. Hesabınızdaki gerçek numara ve kampanya tanımlayıcılarını kullanın. Bu örnekteki numara kurgusaldır.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=add' \
  --data-urlencode "campaign=$CAMPAIGN_ID" \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

Kampanya atama parametreleri
Parametre	Zorunlu	Anlamı
action	Evet	Numaranın mevcut kampanya ilişkilendirmesini atamak için add, kaldırmak için delete kullanın. Büyük/küçük harf ve çevredeki boşluklar normalleştirilir.
campaign	add için	campaignId değeri; kimliği doğrulanmış hesaba ait ve ACTIVE durumunda olan bir kampanyaya ait olmalıdır. Kampanyanın markası da hesaba ait olmalıdır. Açıkça sandbox olarak işaretlenmiş bir kampanya canlı gönderim numaralarına atanamaz. delete için bu parametreyi atlayın; kaldırma işlemi numaranın mevcut ilişkilendirmesini kullanır.
number	Evet	Sahip olunan, etkin, geçersiz kılınmamış, SMS özellikli gönderim numarası. Kuzey Amerika numarası için artı işareti olmadan ülke kodu 1 ve ardından numaranın on hanesini kullanın. İşleyici rakam olmayan karakterleri kaldırır ve ayrıca artı önekli ve on haneli eşdeğerlerini de arar. Bu normalleştirme genel bir telefon numarası geçerlilik denetimi değildir.

İşlem tek bir numarayı değiştirir. Sayfalama, toplu işlem parametresi veya deneme çalıştırması seçeneği yoktur. Yalnızca mevcut bir kampanyaya numara eklemek için kampanya oluşturma uç noktasını kullanmayın.

Mevcut ilişkilendirmeyi kaldırma

Sahip olunan numarayla action=delete kullanın. Bu, numaranın gönderim kampanyası ilişkilendirmesini kaldırır ve o numara için kaydedilmiş marka/kampanya alanlarını temizler. Kampanyayı veya markayı silmez, telefon numarasını serbest bırakmaz, numaranın hizmetini iptal etmez ve kampanyanın yinelenen faturalandırmasını durdurmaz.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=delete' \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

Yanıt ve doğrulama

Bu kurgusal örnek, olağan API yanıt zarfını ve seçilmiş sonuç alanlarını gösterir. Döndürülen numara, hesabınızda kayıtlı biçimi korur. Başarılı bir kaldırma işleminden sonra brandId ve campaignId boş dizelerdir.

{
  "status": {"code": 200, "msg": "Campaign assignment updated."},
  "response": {
    "number": "+12025550123",
    "brandId": "BRAND_FROM_ACCOUNT",
    "campaignId": "CAMPAIGN_FROM_ACCOUNT",
    "providerStatus": 200
  }
}

providerStatus, mesajlaşma iş ortağının HTTP durumudur. İşleyici bir 2xx aktarım yanıtını kabul eder ve ardından yerel numara kaydını günceller; iş ortağının yanıt gövdesini ayrı bir iş düzeyi kabul sonucu için yorumlamaz. Bu nedenle başarılı bir yanıt, mesajlaşma kaydının tamamlandığının veya teslimatın başarılı olacağının kanıtı değildir. Üretim trafiği göndermeden önce numaranın kampanya durumunu portalda inceleyin.

Tek başına yerel bir ilişkilendirmeyi teslimat onayı olarak değerlendirmeyin. Kampanya ve marka onayı, numara tedariki, hesap izinleri, içerik kuralları ve olağan mesajlaşma sınırları geçerliliğini korur.

Hatalar ve kısmi sonuçlar

401: işleyicinin kullanabileceği kimliği doğrulanmış bir hesap yok.
400: action veya number eksik/geçersiz ya da bir add isteğinde kampanya tanımlayıcısı yok.
404: numara, sahip olunan, etkin, geçersiz kılınmamış bir SMS numarası değil.
409: kampanya hesap için kullanılamıyor, ACTIVE durumunda değil, açıkça sandbox olarak işaretli veya markası hesap için kullanılamıyor.
503: mesajlaşma entegrasyonu kullanılamıyor. Hesap kimlik bilgilerini değiştirmek veya yapılandırma değerleri uydurmak yerine destekle iletişime geçin.
502: mesajlaşma isteği başarısız oldu, zaman aşımına uğradı veya 2xx olmayan bir HTTP durumu döndürdü. providerStatus döndürülebilir. Zaman aşımı, iş ortağının hiçbir değişiklik yapmadığını kanıtlamaz.
partial=true ile 500: mesajlaşma iş ortağı başarılı bir HTTP durumu döndürdü, ancak yerel ilişkilendirme doğrulanamadı. Yeniden denemeden önce numarayı portalda uzlaştırın veya destekle iletişime geçin.

HTTP sonucunun yanı sıra API durum kodunu ve yanıt gövdesini de kontrol edin. Bir zaman aşımını veya kısmi sonucu körü körüne yeniden denemeyin. Bu işleyicinin istek düzeyinde idempotentlik anahtarı, işlemsel geri alma veya kampanya kaydı tamamlanma denetimi yoktur. Eşleşen bir yerel atamanın yinelenmesi, veritabanı değişen satır bildirmese bile başarı döndürebilir.

Kapsam ve etkiler

Bu işlem, gönderim numarası yönlendirmesini ve kayıtlı kampanya/marka ilişkilendirmesini değiştirir. İncelenen işleyicide doğrudan hesap borçlandırması, kampanya oluşturma, satın alma veya mesaj gönderimi yer almaz. Bu bir fiyat teklifi veya ücretsiz hizmet vaadi değildir: mevcut numara, kampanya ve mesajlaşma ücretleri hesap koşullarınız kapsamında devam eder.

Portalda farklı bir kampanyaya geçmek önce önceki ilişkilendirmeyi kaldırır, sonra yenisini ekler. Bunlar ayrı isteklerdir. İkinci istek başarısız olursa, önceki ilişkilendirme zaten kaldırılmış olabilir. İki isteğin birlikte geri alınacağını varsaymayın.