GET
/
message
/
{id}
curl --request GET \
  --url https://chat.zoko.io/v2/message/{id} \
  --header 'apikey: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "platformSenderId": "919998880000",
  "platform": "whatsapp",
  "platformTimestamp": "2023-11-07T05:31:56Z",
  "direction": "FROM_CUSTOMER",
  "type": "text",
  "text": "<string>",
  "fileUrl": "<string>",
  "fileCaption": "<string>",
  "deliveryStatus": "sent",
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "attachments": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

apikey
string
headerrequired

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
id
string

system ID of message

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)

platform
enum<string>
Available options:
whatsapp
platformTimestamp
string
direction
enum<string>

direction of message

FROM_CUSTOMER - incoming messages

FROM_STORE - outgoing messages

Available options:
FROM_CUSTOMER,
FROM_STORE
type
enum<string>
Available options:
text,
image,
document,
audio,
video,
template
text
string

message content

fileUrl
string

url of the media file

fileCaption
string

caption of the media file

deliveryStatus
enum<string>

last known delivery status of the message

Available options:
sent,
delivered,
read,
failed
customer
object
attachments
object