Geliştiriciler

DELETE/tcr/v2/campaign/{campaignId}

Mesajlaşma kampanyasını devre dışı bırakma

Bir kampanyayı kullanımdan kaldırın, numara atamalarını uzlaştırın ve başarılı yanıttaki boş gövdenin anlamını öğrenin.

Bu sayfada
  1. Mevcut bir mesajlaşma kampanyasını devre dışı bırakma
  2. Önce etkilenen numara atamalarını kaldırın
  3. Amaçlanan devre dışı bırakma isteğini gönderin
  4. Hem kaydı hem de atamaları doğrulayın
  5. Kullanımdan kaldırma, hesabın mali kapatılmasından ayrıdır

Mevcut bir mesajlaşma kampanyasını devre dışı bırakma

Hesaba ait bir kampanyayı kullanımdan kaldırırken bu uç noktayı kullanın. Uzlaştırma ve geçmiş kayıtları için kampanya kimliğini saklayın. İçerik düzeltmeleri veya izin metni güncellemeleri için bunun yerine Mesajlaşma kampanyasını güncelleme işlemini kullanın.

İzin verilen bir kaynak IP adresinden, etkinleştirilmiş bir API hesabıyla HTTPS üzerinden kimlik doğrulayın. Önce kampanyayı sorgulayın ve ilişkili markayı ve gönderici numaralarını kontrol edin. Devre dışı bırakma, kaydı değiştirir; mevcut kampanyanın yerine yeni bir kampanya oluşturmaz veya numaraları başka bir kampanyaya taşımaz.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

Önce etkilenen numara atamalarını kaldırın

Herkese açık kampanya DELETE işlemi, telefon numaralarının mesajlaşma operatörüyle bağlantısını kesmez veya yerel atamalarını temizlemez. Numaranın kampanya atamasını kaldırma iş akışını, hesaba ait etkilenen her numara için uygulayın, ardından atamasını doğrulayın. Bir atamanın kaldırılması telefon numarasını serbest bırakmaz.

Portalın daha kapsamlı olan Markayı silme iş akışı, markayı silmeden önce kampanya ve numara temizliğini gerçekleştirir. Markayı ve diğer kampanyalarını korumak istiyorsanız bu işlemi kullanmayın. Mevcut standart kampanya düzenleyicisinde, bu doğrudan API uç noktasına eşdeğer ayrı bir kampanya silme düğmesi bulunmaz.

Amaçlanan devre dışı bırakma isteğini gönderin

Kampanya kimliğini ve etkilenen gönderim yapılandırmasını gözden geçirdikten sonra DELETE isteğini JSON gövdesi olmadan gönderin:

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

Belgelenen başarılı yanıt, boş gövdeli HTTP 204 yanıtıdır. HTTP durum kodunu inceleyin; JSON biçiminde bir status/response sarmalayıcısı beklemeyin. Silme kabul edildiğinde mevcut hizmet, kampanya kaynağını yerel olarak silinmiş ve süresi dolmuş olarak, eski kampanya kaydını ise süresi dolmuş olarak işaretler. Silme işlemini markaya zincirleme olarak uygulamaz.

Amaçlanan bu istek için tek bir idempotans anahtarı kullanın ve yeniden yürütme için yöntemi, yolu, sorguyu ve gövde baytlarını aynen koruyun. İşlenmekte olan bir isteğin yinelenen kopyası, Retry-After başlığıyla birlikte 409 döndürebilir; tamamlanmış isteklerde saklanan sonuç yeniden döndürülebilir. Önbelleğe alınmış bir hata veya kesilen bir bağlantı, kayıt sisteminin işlemi zaten gerçekleştirip gerçekleştirmediğini göstermez. Kampanya kimliğini ve varsa requestId değerini saklayın.

Hem kaydı hem de atamaları doğrulayın

İstekten sonra kampanyanın güncel durumunu ve etkilenen numaraları portalda kontrol edin. API, kullanımdan kaldırma sonrasında yerel sahiplik meta verilerini koruyabilir; böylece hesaba ait bir kimlik hâlâ kontrol edilebilir. Aynı kimliğin her zaman yerel bir 404 yanıtı döndürmesi gerektiği sonucuna varmayın. Döndürülen durumu veya kullanımdan kaldırılan kaydın erişilebilirliğini kayıt sistemi belirler.

Bir numara atanmış olarak kalırsa mevcut atamayı uzlaştırın. Yalnızca devre dışı bırakmayı yeniden denemek için başka bir kampanya oluşturmayın veya HTTP 204 yanıtının operatör tarafındaki temizliğin yapıldığını kanıtladığını varsaymayın. Kayıt sistemi isteği kabul ettikten sonra yerel eşitleme başarısız olursa, harici sistemde devre dışı bırakma zaten gerçekleşmiş olsa bile API 500 döndürebilir.

Devre dışı bırakma sonuçları
SonuçSonraki adım
204Yanıt gövdesi beklenmez. Kampanya durumunu ve bağımsız olarak yönetilen numara atamalarını doğrulayın.
400Döndürülen doğrulama veya kayıt sistemi durumu hatasını okuyun. Kampanya kimliğinin tam değerini ve mevcut durumu kontrol edin.
401, 403, 404API kimlik bilgilerini, izin verilen kaynak IP adresini ve kaynağın hesaba ait olduğunu kontrol edin. Başka bir müşterinin kimliğini onun yerine kullanmayın.
409, 429Devam eden veya çakışan bir idempotent isteği, istek hızı sınırlamasından ayırt edin; Retry-After başlığı sağlanmışsa belirtilen bekleme süresine uyun.
500, 502 veya zaman aşımıİstek ayrıntılarını saklayın, mevcut kampanyayı sorgulayın ve yeniden göndermeden önce durumu uzlaştırın.

Kullanımdan kaldırma, hesabın mali kapatılmasından ayrıdır

Mevcut DELETE hizmeti, kampanya kaydı için anında bir borçlandırma işlemi başlatmaz. Bu, geri ödeme sözü vermez, mevcut bir taahhüdü ortadan kaldırmaz veya kiralanan numaraları serbest bırakmaz. Hesabın kampanya koşullarını ve ödenmemiş faturalarını portalda kontrol edin. Numara kiralama ve mesaj kullanımı, kampanya kaydından ayrıdır.

Kampanyalar ve atamalar uzlaştırıldıktan sonra işletme kaydının tamamı kullanımdan kaldırılacaksa şu işlemle devam edin: markayı kullanımdan kaldırma.