Pular para o conteúdo principal
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-webhook-disconnected
Ao desconectar
curl --request PUT \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-webhook-disconnected \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>"
}
'
{
  "momment": 123,
  "error": "<string>",
  "disconnected": true,
  "type": "<string>",
  "instanceId": "<string>"
}

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.

​
Conceituação

Esse é o webhook de resposta de desconexão.
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 desconexão

​
Request Body

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

​
Retorno do webhook

​
momment
integer
Timestamp do momento da desconexão
​
error
string
Descrição do erro que causou a desconexão
​
disconnected
boolean
Indicador de status de conexão
​
type
string
Tipo do evento: DisconnectedCallback
​
instanceId
string
Identificador da instância
{
  "momment": 1580163342,
  "error": "Device has been disconnected",
  "disconnected": true,
  "type": "DisconnectedCallback",
  "instanceId": "instance.id"
}

​
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”.