DELETE
/
phone_numbers
/
{phone_number}
curl --request DELETE \
  --url https://api.voiceos.io/phone_numbers/{phone_number} \
  --header 'Authorization: Bearer <token>'
{
  "uri": "<string>",
  "inbound_agent_id": "<string>",
  "phone_number": "<string>",
  "account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "telephony": {
    "provider": "twilio",
    "phone_number_sid": "<string>",
    "account_sid": "<string>",
    "auth_token": "<string>"
  },
  "webhooks": [
    {
      "events": [
        "phone_call:connection_requested"
      ],
      "url": "<string>",
      "method": "GET",
      "headers": {},
      "filter": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
phone_number
string
required

The phone number including the country code.

Query Parameters

​
release_phone_number
boolean
default:false

Response

200
application/json
Successful Response
​
uri
string
required

The uri of the phone number.

​
phone_number
string
required

The phone number including the country code.

​
account_id
string
required

The account id associated with the phone number.

​
created_at
string
required

The date the phone number was created.

​
updated_at
string
required

The date the phone number was last updated.

​
telephony
object
required

The telephony provider for the phone number.

​
inbound_agent_id
string

The agent id that will be used for inbound calls. If null, the phone number will not receive any calls.

​
webhooks
object[]

The webhooks of the phone number. This is used to fetch the agent at the start of the conversation.

Buy Phone NumberList Available to Buy