Send Wizard
Authorization
Add this header to every request in this page
json
{
"Authorization": "Bearer ${token}"
}🔒 Bulk ( Multi ) Send Message
Allows sending multiple template messages at same time. It's best if you want to see reports
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>"
}🔒 Stop
Stops Sending Multiple Messages.
POST
/api/v1/send-wizards/stop
Body
json
{
"send_wizard_id": "<send_wizard_id>",
"channel_id": "<channel_id>"
}🔒 Send Wizards
Fetchs the sending reports
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
}
}Parameters description
| Name | Description |
|---|---|
| name | Name of the Message Template. |
| send_wizaard_id | ID of the initiated Send Wizard. |
| from_number | Channel number from which the Message Templates are sent. |
| summary | Number of messages marked for bulk sending. |
| waiting | Number of messages waiting to be sent. |
| queued | Number of messages queued to be sent. |
| processed_count | Number of the messages started to send. These messages count as processed. |
| awaiting_backend_count | Number of messages sent to backend and awaiting status ( read, delivered... )webhook response from WhatsApp |
| failed_count | Number of messages that failed to send. |
| delivered_count | Number of messages that reached the WhatsApp server. |
| sent_count | Number of messages that reached the customer's phone. |
| seen_count | Number of messages read by the customer. |
🔒 Message Reports of Send Wizard
Fetchs the Message Reports of Sendings
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
}
}Parameters description
| Name | Description |
|---|---|
| phone_number | Customer Phone number |
| full_name | Customer name |
| status | Status of the message ( seen,delivered ... ) |
Report Detail Statuses
| Title | Value | Description |
|---|---|---|
| In Queue | NONE | Send Wizard Created but has not send |
| Cancelled | CANCELLED | Send Wizard Stopped by user |
| Queued | QUEUED | Send Wizard Started |
| Agenda | AGENDA | On Sending Service |
| Number Checked Success | OPT_IN_SUCCESS | Number Checked Successfully and Ready to Send Message |
| Number Check Failed | OPT_IN_FAILED | Number Check Failed during Request to WhatsApp |
| Invalid Number | OPT_IN_FAILED_INVALID_NUMBER | Number checked and invalid number response returned from WhatsApp |
| Send To Backend | SENT_TO_BACKEND | Message Sent to Backend. Waiting for webhook event. |
| Send To Backend Failed | SENT_TO_BACKEND_FAILED | Message Send failed during Backend Request to Helorobo |
| Delivered | BACKEND_DELIVERED | Message has been reached to WhatsApp |
| Seen | BACKEND_SEEN | Message has been seen by customer |
| Sent | BACKEND_SENT | Message has been reached to user phone |
| Failed | BACKEND_FAILED | Message has been failed to send |
| Deleted | BACKEND_DELETED | Message has been deleted |