Pular para o conteúdo principal
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-webhook-message-status
Status da mensagem
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
}

​
Conceituação

Esse é o webhook de retorno do status da mensagem.
O Z-API não aceita webhooks que não sejam HTTPS.

​
Atualizar webhook

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Body

​
value
string
obrigatório
URL do webhook de status da mensagem

​
Request Body

{
  "value": "https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/status"
}

​
Retorno do webhook

​
instanceId
string
Identificador da instância
​
status
string
Status da mensagem: SENT, RECEIVED, READ, READ_BY_ME ou PLAYED
​
ids
array
Identificador(es) da mensagem
​
momment
integer
Timestamp do evento
​
phoneDevice
integer
Tipo do dispositivo (0 = mobile)
​
phone
string
Número de telefone de destino
​
type
string
Tipo do evento: MessageStatusCallback
​
isGroup
boolean
Indica se o chat é um grupo
{
  "instanceId": "instance.id",
  "status": "SENT",
  "ids": ["999999999999999999999"],
  "momment": 1632234645000,
  "phoneDevice": 0,
  "phone": "5544999999999",
  "type": "MessageStatusCallback",
  "isGroup": false
}

​
Response

​
200

{
  "value": true
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou PUT conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.