Send Wizard
Otantikasyon
Bu başlığı her istekte gönderiniz.
json
{
"Authorization": "Bearer ${token}"
}🔒 Toplu Mesaj Gönderme
Çoklu mesaj göndermek istediğinizde kullanmanız tavsiye edilir. Tekil gönderimden en belirgin farkı raporları görebilmenizdir.
POST
/api/v1/send-wizards/start
Body
json
{
"message_template_id": "",
"rows": [
{
"id": 1,
"phone_number": "<customer_phone_number>",
"full_name": "<customer_name>",
"url_button_param": "<url_button_param>",
"text_header_param": "<text_header_param>",
"params": [
"<param1string>"
"<param2string>"
"<param3string>"
"<param4string>"
]
}
],
"total_time": 2,
"channel_id": "<channel_id>"
}🔒 Durdur
Send Wizardı durdurur.
POST
/api/v1/send-wizards/stop
Body
json
{
"send_wizard_id": "<send_wizard_id>",
"channel_id": "<channel_id>"
}🔒 Send Wizardları Listeler
Send Wizardları çeker. Rapor için kullanılmaktadır.
GET
/api/v1/send-wizards/reports?page_size=20&page=1&status=FINISHED&channel_id=<channel_id>
Response
json
{
"success": true,
"message": "",
"status_code": 200,
"trace_id": "f273e4a6-c265-4d46-aa2d-7110fc58a23f",
"errors": [],
"items": [
{
"name": "<message_template_name>",
"send_wizard_id": "<send_wizard_id>",
"status": "<status>",
"from_number": "<channel_phone_number>",
"summary": 4,
"waiting": 4,
"queued": 0,
"awaiting_backend_count": -1,
"failed_count": 4,
"delivered_count": 1,
"sent_count": 1,
"seen_count": 0,
"created_at": 1712326805885,
"has_button": false
},
...
],
"pagination": {
"page": 1,
"page_size": 20,
"total": 14
}
}Parametre Açıklaması
| İsim | Açıklama |
|---|---|
| name | Mesaj Şablonu ismi. |
| send_wizaard_id | Başlatılmış Send Wizard'ın Id'si |
| from_number | Mesaj Şablonlarının gönderildiği Channel numarası |
| summary | Toplan gönderilmek için işaretlenmiş mesaj Sayısı |
| waiting | Gönderilmek için bekleyen mesaj sayısı |
| queued | Gönderilmek için sıraya alınmış mesaj sayısı |
| processed_count | Gönderimini başlatılmış olan mesaj sayısı |
| awaiting_backend_count | Backend üzerinden mesajın gönderildiğini ve WhatsApp tarafından webhook eventlerinin ( gönderildi, okuldu ) bilgisinin gelmediği durumda olan mesajların sayısını verir |
| failed_count | Gönderimi başarısız sayısı |
| delivered_count | WhatsApp server'ına ulaşan mesaj sayısı |
| sent_count | Müşterinin telefonuna ulaşan mesaj sayısı |
| seen_count | Müşteri tarafından okunan mesaj sayısı |
🔒 Send Wizard Mesaj Rapor
Gönderimlerin Mesaj Raporları çekmek için kullanılmaktadır.
GET
/api/v1/send-wizards/:wizardId/details?page_size=20&page=1
Response
json
{
"success": true,
"message": "",
"status_code": 200,
"trace_id": "eed77933-546e-4b2d-81a1-f1639aafe8a0",
"errors": [],
"data": {
"report_details": [
{
"phone_number": "<phone_number>",
"full_name": null,
"status": "<status_of_message>"
},
...
]
},
"pagination": {
"page": 1,
"page_size": 20,
"total": 2
}
}Parametre Açıklaması
| Name | Description |
|---|---|
| phone_number | Müşteri telefon numarası |
| full_name | Müşteri ismi |
| status | Mesajın durumu ( seen,delivered ... ) |
Rapor Detay Durum Açıklamaları
| Title | Değer | AÇIKLAMA |
|---|---|---|
| In Queue | NONE | Gönderim Sihirbazı Oluşturuldu ancak gönderilmedi |
| Cancelled | CANCELLED | Gönderim Sihirbazı kullanıcı tarafından durduruldu |
| Queued | QUEUED | Gönderim Sihirbazı Başlatıldı |
| Agenda | AGENDA | Gönderim Servisinde |
| Number Checked Success | OPT_IN_SUCCESS | Numara Başarıyla Kontrol Edildi ve Mesaj Göndermeye Hazır |
| Number Check Failed | OPT_IN_FAILED | WhatsApp'a Yapılan İstek Sırasında Numara Kontrol Başarısız Oldu |
| Invalid Number | OPT_IN_FAILED_INVALID_NUMBER | Numara kontrol edildi ve WhatsApp'tan geçersiz numara yanıtı alındı |
| Send To Backend | SENT_TO_BACKEND | Mesaj Backend'e Gönderildi. Webhook eventi bekleniyor |
| Send To Backend Failed | SENT_TO_BACKEND_FAILED | Mesaj Backend İsteği Sırasında Gönderilemedi |
| Delivered | BACKEND_DELIVERED | Mesaj WhatsApp'a Ulaştı |
| Seen | BACKEND_SEEN | Mesaj müşteri tarafından görüldü |
| Sent | BACKEND_SENT | Mesaj kullanıcının telefonuna ulaştı |
| Failed | BACKEND_FAILED | Mesaj gönderilemedi |
| Deleted | BACKEND_DELETED | Mesaj silindi |