WhatsApp

List your WhatsApp numbers

WhatsApp Business numbers registered to your org, newest first. Active only unless include_released=true. Requires the telephony:manage scope.

get/v1/whatsapp/numbers

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/whatsapp/numbers
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

include_releasedboolean

Response

Your WhatsApp numbers

objectstring

Example response

{
  "object": "list",
  "data": [
    {
      "object": "whatsapp.number",
      "id": "wan_...",
      "phone_number": "+14155550123"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.