Skip to main content
GET
Get Phone Numbers

Authorizations

Authorization
string
header
required

Specify the authorization token in the form AccountId:SecretKey, or an OAuth 2.0 access token.

For more information, check out the Authorization Guide and the OAuth 2.0 Guide.

Response

The list of active phone numbers for the account.

id
string | null

The unique identifier of the phone number.

number
string | null

The phone number in E.164 format.

displayName
string | null

The display name of the phone number. Falls back to the raw number when no display name is set.

direction
integer<int32>

Phone number direction (supported call capabilities).

  • InboundOutbound: Supports both inbound and outbound calls.
  • Inbound: Supports inbound calls only.
  • Outbound: Supports outbound calls only.
  • NotSet: Direction is not set.

1 - InboundOutbound

2 - Inbound

3 - Outbound

10 - NotSet

type
integer<int32>

Indicates how the phone number is provisioned and connected to NLPearl.

  • NLPearlDefault: a shared default number provided by NLPearl.
  • NLPearl: a number purchased and managed for you by NLPearl.
  • Twilio: a number from your own Twilio account that you connected.
  • CustomVoip: a custom VoIP number you connect over SIP.
  • Undefined: the type could not be determined.

1 - NLPearlDefault

2 - NLPearl

3 - Twilio

4 - CustomVoip

99 - Undefined

sipConfig
object | null

The inbound SIP configuration. Present only for custom VoIP numbers that have inbound configured; passwords are never returned.

sipTrunkConfig
object | null

The outbound SIP trunk configuration. Present only for custom VoIP numbers that have outbound configured; passwords are never returned.