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
https://backend.helorobo.com/agent-app/message-template/send-wizard/startv2
Body
json
{
"message_template_id": "<message_template_id>",
"rows": [
[1, "<to_phone_number>", "body1", "body2", "body3", "body4"],
[2, "<to_phone_number>", "test", "test2", "test3", "test4"]
],
"total_time": 1,
"channel_id": "<channel_id>",
"param_headers": [
"SIRA",
"MÜŞ. TEL NO",
"BODY.1",
"CAROUSEL.1.BODY.1",
"CAROUSEL.2.BODY.1"
]
}🔒 Durdur
Send Wizardı durdurur.
POST
https://backend.helorobo.com/agent-app/message-template/send-wizard/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.
POST
https://backend.helorobo.com/agent-app/message-template/send-wizard/reports
Body
json
{
"page":1,
"page_size":20,
"channel_id":"<channel_id>"
}Response
json
{
"success": true,
"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.
POST
https://backend.helorobo.com/agent-app/message-template/send-wizard/reports/detail
Body
json
{
"data": {
"page":1,
"page_size":20,
},
"id":"<send_wizard_id>"
}Response
json
{
"success": true,
"data": {
"report_details": [
{
"phone_number": "<phone_number>",
"full_name": null,
"status": "<status_of_message>",
// alttaki kısımlar durumlara bağlı olarak gelmektedir.
"backend_sended_time": "<backend_sended_time>",
"sended_time": "<sended_time>",
"delivered_time": "<delivered_time>",
"seen_time": "<seen_time>",
"failed_time": "<failed_time>",
"error_message": "<error_message>",
"error_message_detail": "<error_message_detail>",
"webhook_response": "<webhook_response>" // WhatsApp dökümantasyonunu kontrol etmeniz önerilir.
}
...
]
},
"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 ... ) |
| backend_sended_time | Mesajın Backend tarafından gönderildiği tarih ve saat |
| sended_time | WhatsAppa ulaştırılma tarihi |
| delivered_time | Mesajın müşteriye ulaştığı tarih ve saat |
| seen_time | Mesajın müşteri tarafından okunduğu tarih ve saat |
| failed_time | Mesajın başarısız olduğu tarih ve saat |
| erorr_message | Mesajın hatası var ise bu hataya ait bilgi |
| erorr_message_detail | Mesajın hatası var ise bu hataya ait detaylı bilgi |
| webhook_response | Mesajın durumuna ait Metanın paylaşmış olduğu webhook cevabı. |
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 |