Skip to main content
POST
Request authentication code.

Description

This endpoint allows requesting a pairing code as alternative method of authentication, without the need to scan the QR Code. The received code must be entered in the WhatsApp app to establish the connection.

URL Parameters

session
string
required
Unique ID of the session to be authenticated

Body

Body Parameters

Response

code
string
required
Pairing code generated. This code must be entered in the WhatsApp app to complete authentication.

Status Codes

  • 200 - Code generated successfully
  • 400 - Invalid parameters (ex: invalid phone number)
  • 401 - Unauthorized

Usage Example

Authorizations

apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

session
string
required

The session name (instanceName) you want to authenticate

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