Take a number out of service

POST

/v1/phone-numbers/{number_id}/release

curl --request POST \
  --url https://api.vocapable.com/v1/phone-numbers/example/release \
  --header 'Authorization: Bearer <token>'

Authorizations

• HTTPBearer

Parameters

Path Parameters

number_id

required

Number Id

string

Responses

200

Successful Response

Media typeapplication/json

PhoneNumberSummary

object

id

required

Id

string

phone_e164

required

Phone E164

string

telephony_account_id

required

Telephony Account Id

string

provider_sid

Any of:

string

string

null

null

capabilities

Capabilities

Array<string>

Allowed values: voice sms

a2p_campaign_ref

Any of:

string

string

null

null

status

required

Status

string

Allowed values: provisioning active quarantined resting releasing released

assigned_at

Any of:

string

string format: date-time

null

null

daily_dial_cap

Any of:

integer

integer

null

null

dials_today

required

Dials Today

integer

reputation_state

required

Reputation State

string

Allowed values: clean at_risk flagged burned

inbound_agent_id

Any of:

string

string

null

null

inbound_route_mode

Inbound Route Mode

string

default: agent

Allowed values: agent voicemail policy

inbound_voicemail_greeting

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

Example

{
  "capabilities": [
    "voice"
  ],
  "status": "provisioning",
  "reputation_state": "clean",
  "inbound_route_mode": "agent"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}