İçeriğe geç
ZZenWapp Docs

API referansı

Broadcast

Çok alıcılı kampanya gönderimi, ilerleme takibi ve iptal.

get/broadcasts

Toplu gönderimleri listele

Gerekli yetki: messages:read

Sorgu parametreleri

statusstring
pageintegerVarsayılan: 1
limitintegerVarsayılan: 20

İstek örneği

curl -X GET "https://api.zenwapp.com/api/v1/whatsapp/external/broadcasts" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY"

Yanıt kodları

  • 200Kampanya listesi
post/messages/broadcast

Toplu mesaj gönder

Alıcıları `phones` dizisiyle ya da `recipient_filter` ile (etiket, arama vb.) belirtin — en az biri zorunludur. `delay_between_messages` gönderimler arası bekleme süresidir; hesabın engellenmemesi için düşük değer vermeyin.

Gerekli yetki: messages:send

Gövde alanları

namezorunlustringKampanya adı.
messagestring
message_typestringVarsayılan: "text"
media_urlstring
media_captionstring
template_iduuid
template_variablesobject
phonesstring[]
recipient_filterobject
scheduled_atISO 8601
delay_between_messagesintegerMilisaniye.Varsayılan: 2000

İstek örneği

curl -X POST "https://api.zenwapp.com/api/v1/whatsapp/external/messages/broadcast" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Ağustos kampanyası","message":"Ağustos'a özel %20 indirim!","phones":["905551234567","905339876543"],"delay_between_messages":4000}'

Yanıt 400

{
  "error": "validation_error",
  "message": "Missing required field: to"
}

Yanıt kodları

  • 201Kampanya oluşturuldu
  • 400Gövde veya sorgu parametreleri geçersiz
get/broadcasts/{id}

Kampanya detayı

Kampanyanın ilerleme sayaçlarını (gönderilen, başarısız, bekleyen) içerir.

Gerekli yetki: messages:read

Yol parametreleri

idzorunluuuidKaynak kimliği (UUID).

İstek örneği

curl -X GET "https://api.zenwapp.com/api/v1/whatsapp/external/broadcasts/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY"

Yanıt 404

{
  "error": "not_found",
  "message": "Resource not found"
}

Yanıt kodları

  • 200Detay
  • 404Kaynak bulunamadı
delete/broadcasts/{id}

Kampanyayı iptal et

Henüz gönderilmemiş alıcılar iptal edilir; gönderilmiş mesajlar geri alınamaz.

Gerekli yetki: messages:send

Yol parametreleri

idzorunluuuidKaynak kimliği (UUID).

İstek örneği

curl -X DELETE "https://api.zenwapp.com/api/v1/whatsapp/external/broadcasts/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY"

Yanıt 404

{
  "error": "not_found",
  "message": "Resource not found"
}

Yanıt kodları

  • 200İptal edildi
  • 404Kaynak bulunamadı
get/broadcasts/{id}/recipients

Kampanya alıcılarını listele

Gerekli yetki: messages:read

Yol parametreleri

idzorunluuuidKaynak kimliği (UUID).

Sorgu parametreleri

statusstringDeğerler: pending, sent, failed
pageintegerVarsayılan: 1
limitintegerVarsayılan: 50

İstek örneği

curl -X GET "https://api.zenwapp.com/api/v1/whatsapp/external/broadcasts/00000000-0000-0000-0000-000000000000/recipients" \
  -H "Authorization: Bearer $ZENWAPP_API_KEY"

Yanıt kodları

  • 200Alıcı listesi