Phone Numbers
List Company Phone Numbers
Returns the list of phone numbers assigned to RingCentral customer account. Both company-level and extension-level numbers are returned.
get/restapi/v1.0/account/{accountId}/phone-number
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)
Query parameters
pageinteger
Indicates a page number to retrieve. Only positive number values are accepted
perPageinteger
Indicates a page size (number of items)
usageTypestring[]
Usage type of phone number
paymentType'External' | 'TollFree' | 'Local' | 'BusinessMobileNumberProvider' | 'ExternalNumberProvider' | 'ExternalNumberProviderTollFree'
Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system
Payment Type of the number
status'Normal' | 'Pending' | 'PortedIn' | 'Temporary'
Status of a phone number
Response
Success
Example response
{
"paging": {
"perPage": 50,
"page": 5,
"pageEnd": 5,
"totalPages": 25,
"totalElements": 25
}
}