Skip to main content
GET
Connect with phone

Overview

Allows connection without scanning the QRCode, using the “Connect with phone number” feature.

Attributes

instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
token
string
required
Your Z-API instance token.

Path

phone
string
required
Phone number with country code (e.g.: 5511999999999)

Response

200

This endpoint may return the standard connection code, or, on devices that require the Passkey, return the Challenge object to continue the authentication process.
Example response for the connection code
Example response for devices that require the Passkey
In cases where this response is returned, it is necessary to complete the authentication requested via the Challenge. For this, we have the Complete the Challenge endpoint.

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.