Listing Senders

List the Senders this key can use

GET /v1/senders requires senders:read and returns only WhatsApp numbers connected to the API key's Yanola Account and Agent Project. A key restricted to selected Senders sees only that allowed set.

The key determines the environment. If you pass environment, it must match the key; an omitted environment defaults to the key environment.

import { WhatsAppClient } from "@yanola/whatsapp"

const apiKey = process.env.YANOLA_API_KEY

if (!apiKey) {
  throw new Error("Missing YANOLA_API_KEY")
}

const yanola = new WhatsAppClient({ apiKey })

const page = await yanola.senders.list({ limit: 100 })
const eligibleSenders = page.data.filter(
  (sender) => sender.apiEligible
)

for (const sender of eligibleSenders) {
  console.log(sender.phoneNumber, sender.displayName)
}

Sender fields

Status and API eligibility

Treat apiEligible as the final send-readiness signal. Status explains the connection state, while API eligibility also includes Developer Platform controls for the current environment.

Paginate safely

Sender lists use opaque cursor pagination, ordered newest first. The default page size is 20 and the maximum is 100.

When pagination.hasMore is true, pass pagination.nextCursor to the next request unchanged. Cursors are scoped to the key, project, environment, and query; do not decode them or reuse them with another key.

import { WhatsAppClient } from "@yanola/whatsapp"

const apiKey = process.env.YANOLA_API_KEY

if (!apiKey) {
  throw new Error("Missing YANOLA_API_KEY")
}

const yanola = new WhatsAppClient({ apiKey })

let cursor: string | null | undefined

do {
  const page = await yanola.senders.list({
    limit: 100,
    cursor: cursor ?? undefined,
  })

  for (const sender of page.data) {
    console.log(sender.phoneNumber, sender.apiEligible)
  }

  cursor = page.pagination.nextCursor
} while (cursor)

Select and retain a Sender

1. Persist phoneNumber, not an internal Yanola or Meta identifier.
2. Select only a record with status active and apiEligible true.
3. Refresh the list before a long-running batch or after a send reports Sender state problems.
4. Handle an empty result as configuration state, not as a reason to fall back to a different Agent Project.

Listing errors