v

latestOpenAPI 3.1.02026-08-105471692.1 MB

Account Groups4

Account Settings9

Accounts11

Ad Accounts17

Ad Audiences6

Ad Campaigns22

Ad Creatives11

Ad Insights7

Ad Targeting5

Analytics24

API Keys4

Broadcasts10

Calls3

Comment Automations6

Comments13

Connect43

Connected Apps2

Contacts7

Conversions12

Custom Fields6

Discord24

GMB Attributes3

GMB Food Menus2

GMB Location Details2

GMB Media3

GMB Place Actions4

GMB Reviews4

GMB Services2

GMB Verifications4

Inbox Analytics7

Instagram3

Invites1

Lead Gen7

LinkedIn Mentions1

Logs1

Media1

Mentions2

Messages15

Messaging Ads3

Phone Numbers25

Posts10

Profiles5

Queue6

Reach and Frequency4

Reddit Search2

Reviews3

Sequences10

Slack1

SMS22

Tracking Tags10

Twitter Engagement8

Usage6

Users2

Validate4

Verify3

Voice11

Webhooks6

WhatsApp35

WhatsApp Calling16

WhatsApp Flows13

WhatsApp Phone Numbers16

WhatsApp Sandbox3

WhatsApp Templates1

Workflows14

Webhooks

Webhook Events47

Voice

Enable phone calling on a number

Turns on regular phone (PSTN) calling for one of your numbers and configures how inbound calls are handled. Inbound calls route to forwardTo: your own AI voice agent (Vapi/Retell), a phone, or a SIP endpoint. Optional extras: voicemail, business-hours windows, an IVR menu, a caller blocklist, recording, and transcription. A number can also be voice-enabled with no forward (outbound-only).

Idempotent, and doubles as the settings update: only fields present in the body are written. Omitting forwardTo preserves the current destination; sending an empty string clears it.

post/v1/phone-numbers/{id}/voice

Path parameters

idstring required

Phone number record ID (from GET /v1/phone-numbers).

Request body

forwardTostring

tel:+E164, sip:..., or wss://... destination for inbound calls. Empty string clears the forward (outbound-only); omitted preserves the current one.

recordingEnabledboolean

transcriptionEnabledboolean

transcriptionLanguage'auto' | 'en' | 'es'

voicemailEnabledboolean

Voicemail is taken when there's no live destination. Default on.

voicemailGreetingstring

Custom spoken greeting; empty string restores the default.

businessHoursEnabledboolean

Outside the windows, inbound skips the forward and goes to voicemail. Off = 24/7.

businessHoursTimezonestring

IANA timezone the windows are evaluated in.

blockedCallersstring[]

E.164 numbers rejected before answer. Replaces the whole list; bare 10-digit values are normalized as US numbers.

forwardCallerId'business' | 'caller'

Caller ID on the forwarded leg: your number (business) or the original caller's (caller).

ivrEnabledboolean

IVR menu (supersedes the plain forward within business hours).

ivrPromptstring

Response

Voice enabled; the full effective voice config is echoed back.

enabledboolean

phoneNumberstring

pstnForwardTostring nullable