Message
Get Message
Retrieve message details
GET
/
message
/
{id}
Authorization
Path
curl --request GET \
--url https://chat.zoko.io/v2/message/{id} \
--header 'apikey: <apikey>'
{
"attachments": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"deliveryStatus": "sent",
"direction": "FROM_CUSTOMER",
"fileCaption": "<string>",
"fileUrl": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "whatsapp",
"platformSenderId": "919998880000",
"platformTimestamp": "2023-11-07T05:31:56Z",
"text": "<string>",
"type": "text"
}
Authorizations
apikey
string
headerrequiredAuthentication is done via apikey
provided for your account
Include the following in your request header
apikey: "your_apikey_here"
Path Parameters
id
string
requiredID of message
Response
200 - application/json
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
curl --request GET \
--url https://chat.zoko.io/v2/message/{id} \
--header 'apikey: <apikey>'
{
"attachments": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"deliveryStatus": "sent",
"direction": "FROM_CUSTOMER",
"fileCaption": "<string>",
"fileUrl": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "whatsapp",
"platformSenderId": "919998880000",
"platformTimestamp": "2023-11-07T05:31:56Z",
"text": "<string>",
"type": "text"
}