Skip to main content
POST
Register a WhatsApp Business number

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Body

application/json
waba_id
string
required
phone_number_id
string
required
display_phone_number
string
required

The number in E.164.

Example:

"+14155550123"

access_token
string
required

Meta system-user token with whatsapp_business_messaging. Stored encrypted, never returned.

app_id
string | null

Meta app that owns the webhook subscription.

agent_id
string | null

Optional agent to route inbound calls to.

Response

Registered

object
string
Example:

"whatsapp.number"

id
string
Example:

"wan_..."

waba_id
string

WhatsApp Business Account id.

phone_number_id
string

Meta's id for the business number (what the webhook carries).

phone_number
string

E.164.

Example:

"+14155550123"

app_id
string | null
agent_id
string | null

Agent that answers inbound WhatsApp calls.

calling_enabled
boolean
calling_settings
object

Last calling settings pushed to Meta.

status
enum<string>
Available options:
active,
released
created_at
integer

Unix ms.

updated_at
integer

Unix ms.

released_at
integer | null

Unix ms.