Phone & voice · Voice

Enable phone calling on a number

Enables a phone calling on a number.

POSThttps://api.pozy.ai/v1/phone-numbers/{id}/voice

enableVoiceOnNumber

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`id`required	string

Request body

application/json, optional

forwardTostring
recordingEnabledboolean
transcriptionEnabledboolean
transcriptionLanguagestring
One of auto, en, es.
voicemailEnabledboolean
voicemailGreetingstring
Up to 1000 characters.
businessHoursEnabledboolean
businessHoursTimezonestring
Up to 64 characters.
businessHoursarray of object
Up to 21 items.
- dayintegerrequired
  0 to 6.
- openstringrequired
  Matches ^\d{2}:\d{2}$.
- closestringrequired
  Matches ^\d{2}:\d{2}$.
blockedCallersarray of string
Up to 1000 items.
forwardCallerIdstring
One of business, caller.
ivrEnabledboolean
ivrPromptstring
Up to 1000 characters.
ivrOptionsarray of object
Up to 12 items.
- digitstringrequired
  Matches ^[0-9*#]$.
- forwardTostringrequired
- labelstring
  Up to 80 characters.

Example

curl -X POST "https://api.pozy.ai/v1/phone-numbers/6bfebd43ddc270f6d2c56fc5/voice" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "forwardTo": "string",
  "recordingEnabled": true,
  "transcriptionEnabled": true,
  "transcriptionLanguage": "auto"
}'

const res = await fetch("https://api.pozy.ai/v1/phone-numbers/6bfebd43ddc270f6d2c56fc5/voice", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    forwardTo: "string",
    recordingEnabled: true,
    transcriptionEnabled: true,
    transcriptionLanguage: "auto"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.post(
    "https://api.pozy.ai/v1/phone-numbers/6bfebd43ddc270f6d2c56fc5/voice",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "forwardTo": "string",
        "recordingEnabled": True,
        "transcriptionEnabled": True,
        "transcriptionLanguage": "auto",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

enabledboolean
phoneNumberstring
pstnForwardTostring
Can be null.
recordingEnabledboolean
transcriptionEnabledboolean
transcriptionLanguagestring
One of auto, en, es.
voicemailEnabledboolean
voicemailGreetingstring
Can be null.
businessHoursEnabledboolean
businessHoursTimezonestring
Can be null.
businessHoursarray of object
- dayinteger
- openstring
- closestring
blockedCallersarray of string
forwardCallerIdstring
One of business, caller.
ivrEnabledboolean
ivrPromptstring
Can be null.
ivrOptionsarray of object
- digitstring
- forwardTostring
- labelstring

200 response

{
  "enabled": true,
  "phoneNumber": "+14155550123",
  "pstnForwardTo": "string",
  "recordingEnabled": true,
  "transcriptionEnabled": true,
  "transcriptionLanguage": "auto",
  "voicemailEnabled": true,
  "voicemailGreeting": "alex@example.com",
  "businessHoursEnabled": true,
  "businessHoursTimezone": "string",
  "businessHours": [
    {
      "day": 1,
      "open": "string",
      "close": "string"
    }
  ],
  "blockedCallers": [
    "string"
  ],
  "forwardCallerId": "business",
  "ivrEnabled": true,
  "ivrPrompt": "string",
  "ivrOptions": [
    {
      "digit": "string",
      "forwardTo": "string",
      "label": "string"
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Voice

GETList phone calls POSTPlace an outbound phone call GETGet a phone call POSTHang up a live call GETGet a call recording POSTBlind-transfer a live call GETEstimate call cost POSTMint a browser softphone session POSTDial from the browser softphone DELDisable phone calling on a number GETList SIP trunks POSTCreate a SIP trunk GETGet a SIP trunk DELDelete a SIP trunk POSTRotate a SIP trunk's password POSTAttach a number to a SIP trunk DELDetach a number from its SIP trunk