Telephony

Release a number

Release the managed number (stops the monthly rental). Idempotent. Requires the telephony:manage scope.

delete/v1/telephony/numbers/{id}

Request

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

Path parameters

idstring required

Response

Released

objectstring
idstring
phone_numberstring

E.164.

countrystring
area_codestring nullable
agent_idstring nullable

Agent that answers inbound calls to this number.

recordingboolean

Whether PyAI recording is enabled for the number.

monthly_cost_centsinteger
status'active' | 'released'
created_atinteger

Unix ms.

released_atinteger nullable

Unix ms.

Example response

{
  "object": "telephony.number",
  "id": "pn_...",
  "phone_number": "+14155550123",
  "country": "US",
  "area_code": "415"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.