Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
mobile
/
request-registration-code
Solicitar código de confirmação
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/mobile/request-registration-code \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ddi": "<string>",
  "phone": "<string>",
  "method": "<string>"
}
'
{
  "success": true,
  "captcha": "<string>",
  "blocked": true,
  "retryAfter": 123,
  "smsWaitSeconds": 123,
  "voiceWaitSeconds": 123,
  "waOldWaitSeconds": 123,
  "method": "<string>"
}

​
Conceituação

Método utilizado para solicitar o envio do código de confirmação.
Não se esqueça que o número de telefone que você deve enviar nesta requisição é o mesmo que você verificou na API anterior.Caso receba um captcha na resposta, confirme-o via API de captcha antes de receber o código.

​
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

​
ddi
string
obrigatório
Código do país
​
phone
string
obrigatório
Número do telefone com DDD (ex: 4499999999)
​
method
string
obrigatório
Método de envio do código: sms, voice ou wa_old

​
Request Body

{
  "ddi": "55",
  "phone": "4499999999",
  "method": "sms"
}

​
Response

​
200

​
success
boolean
Retorna true caso a solicitação do código tenha sido enviada com sucesso
​
captcha
string
Base64 de imagem com código captcha
​
blocked
boolean
Define se o número está banido ou não
​
retryAfter
number
Tempo em segundos que deve ser aguardado para nova solicitação do código
​
smsWaitSeconds
number
Tempo que deve ser aguardado para solicitação de SMS
​
voiceWaitSeconds
number
Tempo que deve ser aguardado para solicitação de chamada de voz
​
waOldWaitSeconds
number
Tempo que deve ser aguardado para solicitação de pop-up no aplicativo
​
method
string
Método de envio do código
Sucesso: 
{
  "success": true,
  "retryAfter": 165,
  "smsWaitSeconds": 125,
  "voiceWaitSeconds": 125,
  "waOldWaitSeconds": 125,
  "method": "sms"
}
Número bloqueado: 
{
  "success": false,
  "blocked": 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”.