Messages

---

Authorization

Add this header to every request in this page

{
  "Authorization": "Bearer ${token}"
}

🔒 Message Detail

Fetches Message Details

POST

/api/v1/messages

Body

{
   "message_ids":["<message_id>"]
}

Parameter Description

Name	Type	Required	Descripton
message_ids	Array<string>	Yes	Id's of the Messages which you want to know about status

Response

{
    "success": true,
    "message": "",
    "status_code": 200,
    "trace_id": "61739133-6a19-497a-b5d9-894689522f98",
    "errors": [],
    "items": [
        {
            "_id": "<message_id>",
            "status": "<status>",
            "company_id": "<company_id>",
            "phone_number": "<customer_number>",
            "from_number": "<container_number>",
            "full_name": "<customer_name>",
            "message_template_id": "<message_template_id>",
            "whatsapp_account_id": "<whatsapp_account_id>",
            "created_at": "2024-06-10T13:07:08.999Z",
            "updated_at": "2024-06-10T13:10:39.605Z",
            "__v": 0,
            "ext_id": "<message_whatsapp_id>",
            "webhook_response": "<webhook_response>"
        }
    ]
}

Parameter Description

Name	Type	Description
status	string	Status of the messages. Here you can see the status in details
phone_number	string	Phone number of the customer
from_number	string	The number from which the message is sent
full_name	string	The name of the person to whom the message is sent, provided at the send request
message_template_id	string	Id of the message template
webhook_response	any	Information provided by WhatsApp, which may contain objects of different types for the result of successful delivery or errors. It will be fixed