Skip to main content
GET
Get LID by phone number
Resolves a phone-number-based chat ID to its linked identifier. Pass the @c.us value as a query parameter named phoneNumber.
You can send either the full identifier, such as [email protected], or only the numeric part when that fits your integration.
If the mapping is missing, your instance does not currently know how to convert that @c.us value.

Response Example

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept
string

application/json

Example:

"application/json"

Content-Type
string

application/json

Example:

"application/json"

Path Parameters

instance
string
required

Instance UUID copied from hypersender dashboard

Example:

"{{ instance_id }}"

Query Parameters

phoneNumber
string
required

The phone-number-based identifier to resolve. You can send either the full value like [email protected] or just the numeric part.

Response

Successful response

lid
string
required

Linked identifier for the contact

Example:

"1111111@lid"

pn
string
required

Phone-number-based chat ID for the same contact