Documentation

HTTP API Documentation


https://api.waapi.me

Get message


This request retrieves a specific message from a WaAPI using its unique message ID. Use this method to fetch detailed information about a particular message that was sent or received by the bot.


Request


This section provides an example HTTP request for retrieving a message by its ID. Ensure that the correct message ID are specified in the request to fetch the desired message.


GEThttps://api.waapi.me/message/:id

Headers


When making this request, it`s important to include Authorization HTTP header


Authorization: <YOUR_API_KEY>

Response


The response contains the details of the message identified by the provided message ID. The data returned in JSON format, including fields like the sender, body, and status. Refer to the table for a detailed description of each field returned in the response.


Field
Type
Description
idstringMessage id
instanceIdstring|uuidInstance(bot) id
fromstringFrom phone number
tostringTo phone number
bodystringMessage body
statusstring|enumMessage status
typestring|enumMessage direction type, from instance or to instance
errorstring|nullError message
readbooleanIf true message was read by recipient

{
    "id": "6724f988204191f30af53473",
    "instanceId": "c3996092-b982-4af7-8cf1-0cfafea5143c",
    "from": "78005553535",
    "to": "78005553636",
    "body": "Hello form WaAPI!",
    "status": "sent",
    "type": "outcome",
    "error": null,
    "read": true
}