> ## Documentation Index
> Fetch the complete documentation index at: https://developer.z-api.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Status da mensagem

> Webhook de retorno do status da mensagem

## Conceituação

Esse é o webhook de retorno do status da mensagem.

<Warning>
  O Z-API não aceita webhooks que não sejam **HTTPS**.
</Warning>

***

## Atualizar webhook

### Header

<ParamField path="instanceId" type="string" required>
  ID da sua instância. Disponível no painel Z-API em **Instâncias**.
</ParamField>

<ParamField path="token" type="string" required>
  Token da sua instância Z-API.
</ParamField>

### Body

<ParamField body="value" type="string" required>
  URL do webhook de status da mensagem
</ParamField>

### Request Body

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "value": "https://endereco-do-seu-sistema.com.br/instancia/SUA_INSTANCIA/status"
}
```

***

## Retorno do webhook

<ResponseField name="instanceId" type="string">
  Identificador da instância
</ResponseField>

<ResponseField name="status" type="string">
  Status da mensagem: `SENT`, `RECEIVED`, `READ`, `READ_BY_ME` ou `PLAYED`
</ResponseField>

<ResponseField name="ids" type="array">
  Identificador(es) da mensagem
</ResponseField>

<ResponseField name="momment" type="integer">
  Timestamp do evento
</ResponseField>

<ResponseField name="phoneDevice" type="integer">
  Tipo do dispositivo (0 = mobile)
</ResponseField>

<ResponseField name="phone" type="string">
  Número de telefone de destino
</ResponseField>

<ResponseField name="type" type="string">
  Tipo do evento: `MessageStatusCallback`
</ResponseField>

<ResponseField name="isGroup" type="boolean">
  Indica se o chat é um grupo
</ResponseField>

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "instanceId": "instance.id",
  "status": "SENT",
  "ids": ["999999999999999999999"],
  "momment": 1632234645000,
  "phoneDevice": 0,
  "phone": "5544999999999",
  "type": "MessageStatusCallback",
  "isGroup": false
}
```

***

## Response

### 200

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "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".