Sign in

v1

latestOpenAPI 3.0.12026-07-2665150231.1 KB
Account

Get Phone Numbers

Retrieves all active phone numbers of the account.

get/v2/Account/PhoneNumbers

Response

The list of active phone numbers for the account.

idstring nullable

The unique identifier of the phone number.

numberstring nullable

The phone number in E.164 format.

displayNamestring nullable

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

directioninteger

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

typeinteger

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