Skip to main content
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-webhook-message-status
Message status
curl --request PUT \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-webhook-message-status \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>"
}
'
{
  "instanceId": "<string>",
  "status": "<string>",
  "ids": [
    {}
  ],
  "momment": 123,
  "phoneDevice": 123,
  "phone": "<string>",
  "type": "<string>",
  "isGroup": true
}

​
Overview

This is the message status callback webhook.
Z-API does not accept webhooks that are not HTTPS.

​
Update webhook

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Body

​
value
string
required
Message status webhook URL

​
Request Body

{
  "value": "https://your-system-address.com/instance/YOUR_INSTANCE/status"
}

​
Webhook callback

​
instanceId
string
Instance identifier
​
status
string
Message status: SENT, RECEIVED, READ, READ_BY_ME or PLAYED
​
ids
array
Message identifier(s)
​
momment
integer
Event timestamp
​
phoneDevice
integer
Device type (0 = mobile)
​
phone
string
Destination phone number
​
type
string
Event type: MessageStatusCallback
​
isGroup
boolean
Whether the chat is a group
{
  "instanceId": "instance.id",
  "status": "SENT",
  "ids": ["999999999999999999999"],
  "momment": 1632234645000,
  "phoneDevice": 0,
  "phone": "5544999999999",
  "type": "MessageStatusCallback",
  "isGroup": false
}

​
Response

​
200

{
  "value": true
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or PUT as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.