Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
mobile
/
respond-captcha
Responder captcha
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/mobile/respond-captcha \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "captcha": "<string>"
}
'
{
  "success": true
}

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

Método utilizado para responder ao captcha necessário para envio do código de confirmação.

Atributos

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

captcha
string
obrigatório
Código captcha para confirmação. Esse captcha é exibido na imagem retornada na solicitação do código de confirmação.

Request Body

{
  "captcha": "123456"
}

Response

200

success
boolean
Retorna true caso o captcha tenha sido respondido corretamente. Sendo assim, aguarde o recebimento do código de confirmação e utilize-o na API de confirmar código.
{
  "success": true
}

400

Requisição inválida. Verifique se os dados que você está enviando estão de acordo com o documentado.

405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET 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”.