Get LID by Phone Number - Wappfy API

Get lid by phone number (chat id)

curl --request GET \
  --url https://{host}/api/{session}/lids/pn/{phoneNumber} \
  --header 'apikey: <api-key>'

import requests

url = "https://{host}/api/{session}/lids/pn/{phoneNumber}"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{host}/api/{session}/lids/pn/{phoneNumber}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/{session}/lids/pn/{phoneNumber}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/{session}/lids/pn/{phoneNumber}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{host}/api/{session}/lids/pn/{phoneNumber}")
  .header("apikey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/{session}/lids/pn/{phoneNumber}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "lid": "12345678901234567890",
  "phone": "5511999999999",
  "jid": "5511999999999@s.whatsapp.net"
}

GET

api

{session}

lids

{phoneNumber}

Get lid by phone number (chat id)

curl --request GET \
  --url https://{host}/api/{session}/lids/pn/{phoneNumber} \
  --header 'apikey: <api-key>'

import requests

url = "https://{host}/api/{session}/lids/pn/{phoneNumber}"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{host}/api/{session}/lids/pn/{phoneNumber}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/{session}/lids/pn/{phoneNumber}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/{session}/lids/pn/{phoneNumber}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{host}/api/{session}/lids/pn/{phoneNumber}")
  .header("apikey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/{session}/lids/pn/{phoneNumber}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "lid": "12345678901234567890",
  "phone": "5511999999999",
  "jid": "5511999999999@s.whatsapp.net"
}

Description

This endpoint returns the LID (Local ID) associated with a specific phone number. LID is a local identifier used by WhatsApp to map contacts efficiently.

URL Parameters

session

string

required

Unique authenticated session ID

phoneNumber

string

required

Phone number (international format, numbers only). Example: 5511999999999

{
  "lid": "12345678901234567890",
  "phone": "5511999999999",
  "jid": "5511999999999@s.whatsapp.net"
}

Status Codes

200 - LID returned successfully
401 - Unauthorized session
404 - Session or phone number not found

Usage Example

curl -X GET https://api.wappfy.com.br/api/my-session/lids/pn/5511999999999

const session = 'my-session';
const phoneNumber = '5511999999999';
const response = await fetch(
  `https://api.wappfy.com.br/api/${session}/lids/pn/${phoneNumber}`
);
const data = await response.json();
console.log(`Phone: ${data.phone}`);
console.log(`LID: ${data.lid}`);
console.log(`JID: ${data.jid}`);

import requests

session = 'my-session'
phone_number = '5511999999999'
response = requests.get(
    f'https://api.wappfy.com.br/api/{session}/lids/pn/{phone_number}'
)
data = response.json()
print(f"Phone: {data['phone']}")
print(f"LID: {data['lid']}")
print(f"JID: {data['jid']}")

Authorizations

apikey

string

header

required

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

Path Parameters

phoneNumber

string

required

Response

200 - application/json

lid

string

User's linked ID

Example:

"1111111@lid"

string

User's phone number (chat id)

Example:

"3333333@c.us"

Get All LID to Number Mappings Get Phone Number by LID

​Description

​URL Parameters

​Status Codes

​Usage Example

Authorizations

Path Parameters

Response

Description

URL Parameters

Status Codes

Usage Example