POST /ProactiveMessage/SendWhatsappCampaign

Bu endpoint, sistemlerin belirli kullanıcı gruplarına şablon tabanlı, kişiselleştirilmiş ve zamanında WhatsApp mesajları göndermesini sağlamak amacıyla tasarlanmıştır. Proaktif mesaj gönderimi, yalnızca kullanıcı aksiyonlarına dayalı olmayan, sistem tetiklemeli iletişim senaryolarının önünü açar. Bu endpoint'i kullanmak için bir WhatsApp Business API hesabınız olması ve gönderilecek template'lerin Meta tarafından onaylatılması gerekmektedir. 

Request Format

Content-Type: application/json-patch+json
Authentication: Basic Authentication  https://help.jetlink.io/developer-documents/jetlink-api-test
Body: Aşağıdaki formatta JSON gönderilmelidir.


Request Body


Image Placeholder


Parametre Açıklamaları
Alan Adı
Tipi
Açıklama
templateName
string
WhatsApp Business tarafından onaylanmış mesaj şablonunun adı.
imageUrl
string
Mesaja eklenecek görselin URL'si (opsiyonel, şablonla uyumlu olmalı).
buttonParamater
string
Şablon içindeki butonun parametresi (ör. tıklanacak URL, etiket vs.).
bodyParameters
string[]
Şablon gövdesinde kullanılan değişken değerler.
userDatas
object[]
Mesaj gönderilecek kullanıcı bilgileri. Birden fazla kullanıcı girilebilir.

userDatas altındaki alanlar:

Alan Adı
Tipi
Açıklama
email
string
Kullanıcının e-posta adresi (opsiyonel).
phone
string
Kullanıcının telefon numarası (zorunlu).
name
string
Kullanıcının adı (kişiselleştirme için gerekli) (opsiyonel).
surname
string
Kullanıcının soyadı (opsiyonel).
gender
string
Kullanıcının cinsiyeti (opsiyonel).

Örnek Kullanım


Image Placeholder


✅ Başarılı Yanıt


Image Placeholder

❌ Hata Yanıtı Örneği


Image Placeholder


 Notlar


  • Gönderilen templateName, WhatsApp'ta onaylı bir şablon olmalıdır. Aksi takdirde mesaj gönderimi başarısız olur.

  • bodyParameters sıralaması, şablonda kullanılan değişken sırasıyla eşleşmelidir (örneğin {{1}}, {{2}}, ...).

  • phone alanı uluslararası formatta olmalıdır (örn: +90 ile başlamalıdır).


  • Çoklu kullanıcıya aynı mesaj gönderimi için userDatas dizisine birden fazla kullanıcı eklenebilir.

    Kullanım Senaryoları:


  • Planlı kampanya bildirimleri

  • Sepet hatırlatma mesajları

  • Teslimat güncellemeleri ve işlem bildirimleri

  • Üyelik yenileme veya ödeme hatırlatma süreçleri

  • Şarta bağlı bilgilendirme sistemleri (ör. bakiye limiti, kullanım süresi uyarıları)

Faydalar:

  • API ile Otomasyon: Arka plan servisleri ve cron job’lar ile entegre çalışarak tam otomasyon sağlar.

  • Kişiselleştirme Desteği: bodyParameters üzerinden mesaj içerikleri dinamik olarak kullanıcıya özel düzenlenebilir.

  • Toplu Gönderim Yeteneği: userDatas dizisi sayesinde tek çağrıda birden fazla kullanıcıya mesaj iletilebilir.

  • Şablon Uyumlu Altyapı: WhatsApp Business API'nin şablon kurallarıyla tam uyumludur; template yapısına göre değişken alanlara veri geçişi yapılabilir.

  • Düşük Gecikme Süresi: Reaktif değil, tetikleyici olmayan senaryolarda da hızlı yanıt süresi sunar.

Bu yapı, hem pazarlama ekiplerinin planlı kampanyalarını teknik süreçlerle entegre etmesini, hem de transactional mesajların kullanıcıya doğrudan ulaşmasını sağlar.




POST /ProactiveMessage/StatusWhatsappCampaign

Bu API, WhatsApp mesaj şablonlarının durumunu sorgulamak amacıyla kullanılır. messageId parametresi ile, belirli bir template mesajının güncel durumu hakkında bilgi alabilirsiniz. 

HTTP Yöntemi

  • POST: /ProactiveMessage/StatusWhatsappCampaign

Parametreler

Bu API çağrısında herhangi bir URL parametresi gerekmemektedir. İstek gövdesinde sadece messageId parametresi gereklidir.

Request Body

Parametre:

  • messageId (string): SendWhatsappCampaign isteğinin response'unda verilen msgId alanındaki mesaj id si buraya girilecek

Örnek Request Body:

Image Placeholder

Response
API başarılı bir işlem gerçekleştirdiğinde, şablonun durumunu döndüren bir yanıt gönderir. Yanıt, mesaj şablonunun aktif durumu, kalitesi ve diğer metrikler hakkında bilgi sağlar.

Başarılı Example Response:

  • HTTP Durum Kodu: 200 OK

  • Medya Türü: text/plain

    Image Placeholder



    sent: Sistemin mesajı başarılı şekilde gönderdiğini ifade eder.
    delivered:     Kullanıcıya mesajın başarılı şekilde ulaştığını ifade eder.
    read: Kullanıcının mesajı açtığını ve okuduğunu ifade eder.


Örnek Request:

Aşağıdaki örnek, bir kampanya mesajının durumunu sorgulamak için API'ye yapılacak bir POST isteğini göstermektedir:

Image Placeholder


Bu endpoint, WhatsApp şablonlarıyla çalışırken doğru durumları almak ve şablon kalitesini izlemek için geliştiriciler tarafından kullanılabilir.