GET
/
message
/
{id}

Authorizations

​
apikey
string
header
required

Authentication is done via apikey provided for your account

Include the following in your request header

apikey: "your_apikey_here"

Path Parameters

​
id
string
required

ID of message

Response

200 - application/json

Message data model

​
attachments
object
​
customer
object
​
deliveryStatus
enum<string>

last known delivery status of the message

Available options:
sent,
delivered,
read,
failed
​
direction
enum<string>

direction of message

FROM_CUSTOMER - incoming messages

FROM_STORE - outgoing messages

Available options:
FROM_CUSTOMER,
FROM_STORE
​
fileCaption
string

caption of the media file

​
fileUrl
string

url of the media file

​
id
string

system ID of message

​
platform
enum<string>
Available options:
whatsapp
​
platformSenderId
string

customer's social id.

sender for incoming messages and recipient for outgoing messages

Please note that this is always the customer's number and never yours (you already know yours, don't you)

​
platformTimestamp
string
​
text
string

message content

​
type
enum<string>
Available options:
text,
image,
document,
audio,
video,
template
Send MessageDelete Message