RIringcentral
Phone Numbers

Get Phone Number

Returns phone number(s) belonging to a certain account or extension by phoneNumberId(s). Batch request syntax is supported.

get/restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}

Request

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

phoneNumberIdinteger required

Internal identifier of a phone number

Response

Phone number information

uristring uri

Link to a company phone number resource

idinteger

Internal identifier of a phone number

labelstring

Custom user-defined name of a phone number, if any

locationstring

Location (City, State). Filled for local US numbers

paymentType'External' | 'TollFree' | 'Local' | 'BusinessMobileNumberProvider' | 'ExternalNumberProvider' | 'ExternalNumberProviderTollFree'

Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system

phoneNumberstring

Phone number

status'Normal' | 'Pending' | 'PortedIn' | 'Temporary'

Status of a phone number. If the value is 'Normal', the phone number is ready to be used. If the value is 'Pending' it is an external number not yet ported to RingCentral.

type'VoiceFax' | 'FaxOnly' | 'VoiceOnly'

Phone number type

usageType'MainCompanyNumber' | 'AdditionalCompanyNumber' | 'CompanyNumber' | 'DirectNumber' | 'CompanyFaxNumber' | 'ForwardedNumber' | 'ForwardedCompanyNumber' | 'ContactCenterNumber' | 'ConferencingNumber' | 'MeetingsNumber' | 'NumberPool' | 'BusinessMobileNumber' | 'PartnerBusinessMobileNumber' | 'IntegrationNumber'

Usage type of phone number. Usage type of phone number. Numbers of 'NumberPool' type are not returned in phone number list requests

vanityPatternstring

Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters nxx plus line or numberPattern

primaryboolean

Specifies if a phone number is primary, i.e. displayed as 'main number' and called by default

Changes

No recorded changes to this operation across all 1 revision of this API.