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
Single Template Message Send
When sending bulk messages for Single Message Template, you need to use the format below.
POST
https://backend.helorobo.com/agent-app/message-template/send-wizard/start
Body
json
{
"message_template_id": "<message_template_id>",
"rows": [
{
"id": 0,
"phone_number": "<phone_number>",
"full_name": "<full_name>",
"url_button_param": "<url_param_1>",
"url_button_param2": "<url_param_1>",
"text_header_param": "<text_header_param>",
"copy_code_param": "<copy_code_param>",
"params": ["<body_param_1>", "<body_param_2>", "<body_param_3>", "<body_param_4>"]
}
],
"total_time": 1,
"channel_id": "<channel_id>"
}Response
json
{
"success": true,
"data": {
"send_wizard_id": "<send_wizard_id>"
}
}Carousel Message Send
When sending bulk messages for Carousel Message Templates, you need to use the format below.
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", "card1.body1", "card1.button1", "card2.button1"],
[2, "<to_phone_number>", "body1", "card1.body1", "card1.button1", "card2.button1"]
],
"total_time": 1,
"channel_id": "<channel_id>",
"param_headers": [
"SIRA",
"MÜŞ. TEL NO",
"BODY.1",
"CAROUSEL.1.BODY.1",
"CAROUSEL.1.BUTTONS.1",
"CAROUSEL.2.BUTTONS.1"
]
}Response
json
{
"success": true,
"data": {
"send_wizard_id": "<send_wizard_id>"
}
}🔒 Stop
Stops Sending Multiple Messages.
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 Wizards
Fetchs the sending reports
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
}
}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
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>",
// the fields below are based on the status
"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>" // Check the WhatsApp documentation for more information.
},
...
]
},
"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 ... ) |
| backend_sended_time | The date and time when the message was sent by the backend |
| sended_time | The date and time when the message was delivered to WhatsApp |
| delivered_time | The date and time when the message was delivered to the customer |
| seen_time | The date and time when the customer reads the message |
| failed_time | The date and time when the message delivery failed |
| erorr_message | The error information if the message failed |
| erorr_message_detail | Detailed error information if the message failed |
| webhook_response | The response shared by Meta regarding the message status. |
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 |