Skip to main content
GET
/
whatsapp
/
business_accounts
/
{id}
/
phone_numbers
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const phoneNumberListResponse of client.whatsapp.businessAccounts.phoneNumbers.list(
  'id',
)) {
  console.log(phoneNumberListResponse.phone_number_id);
}
{
  "data": [
    {
      "record_type": "whatsapp_business_phone_number",
      "phone_number": "<string>",
      "phone_number_id": "<string>",
      "waba_id": "<string>",
      "user_id": "<string>",
      "display_name": "<string>",
      "quality_rating": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "enabled": true,
      "calling_enabled": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Whatsapp Business Account ID

Query Parameters

​
page
object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

List of phone numbers

​
data
object[]
​
meta
object