Skip to main content
POST
/
api
/
{session}
/
auth
/
request-code
Solicitar código de autenticação.
curl --request POST \
  --url https://{host}/api/{session}/auth/request-code \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "phoneNumber": "12132132130",
  "method": null
}
'
{
  "code": "ABCD-1234"
}

Documentation Index

Fetch the complete documentation index at: https://docs.wappfy.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Descrição

Este endpoint permite solicitar um código de pareamento como método alternativo de autenticação, sem a necessidade de escanear o QR Code. O código recebido deve ser inserido no aplicativo WhatsApp para estabelecer a conexão.

​
Parâmetros de URL

​
session
string
required
ID único da sessão a ser autenticada

​
Body

{
  "phone": "5511999999999"
}

​
Parâmetros do Body

PropriedadeTipoObrigatórioDescrição
phonestring✅ SimNúmero de telefone para o qual o código de pareamento será solicitado

​
Resposta

​
code
string
required
Código de pareamento gerado. Este código deve ser inserido no aplicativo WhatsApp para completar a autenticação.
{
  "code": "ABCD-1234"
}

​
Códigos de Status

  • 200 - Código gerado com sucesso
  • 400 - Parâmetros inválidos (ex: número de telefone inválido)
  • 401 - Não autorizado

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/my-session/auth/request-code \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "5511999999999"
  }'

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

​
session
string
required

O nome da sessão (instanceName) que você deseja autenticar

Body

application/json
​
phoneNumber
string
required

Mobile phone number in international format

Example:

"12132132130"

​
method
string

How would you like to receive the one time code for registration? |sms|voice. Leave empty for Web pairing.

Example:

null

Response

201 - undefined