Skip to content
vocapable.Docs

Whether Twilio can port a number in

GET
/v1/workspace/numbers/portability
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/numbers/portability?phone_e164=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
phone_e164
required
Phone E164
string
/^\+1[2-9]\d{9}$/

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspacePortability
object
phone_e164
required
Phone E164
string
portable
required
Portable
boolean
pin_and_account_number_required
required
Pin And Account Number Required
boolean
number_type
required
Any of:
string
reason
required
Any of:
string
Examplegenerated
{
  "phone_e164": "example",
  "portable": true,
  "pin_and_account_number_required": true,
  "number_type": "example",
  "reason": "example"
}

422

Section titled “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
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}