Package com.ringcentral.paths.restapi.v2.accounts.phonenumbers

Class Index

java.lang.Object

com.ringcentral.paths.restapi.v2.accounts.phonenumbers.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
String	phoneNumberId
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String phoneNumberId)

Method Summary

Modifier and Type	Method	Description
Index	bulkAdd()
Index	bulkAdd(String taskId)
DeletePhoneNumbersResponse	delete(DeletePhoneNumbersRequest deletePhoneNumbersRequest)	This method can only delete numbers that meet one of the following requirements: - numbers that have `"usageType": "Inventory"` - `"Forwarded"` numbers - `"Forwarded Company"` numbers
AccountPhoneNumberList	get()
AccountPhoneNumberList	get(ListAccountPhoneNumbersV2Parameters queryParams)	Returns the list of phone numbers assigned to RingCentral customer account.
AccountPhoneNumberInfo	patch(AssignPhoneNumberRequest assignPhoneNumberRequest)	Assigns or reassigns a phone number as a company or extension number.
String	path()
String	path(Boolean withParameter)
Index	replace()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rc

public RestClient rc

parent

public Index parent

phoneNumberId

public String phoneNumberId

Constructor Details

Index

public Index(Index parent,
 String phoneNumberId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

get

public AccountPhoneNumberList get(ListAccountPhoneNumbersV2Parameters queryParams)
                           throws RestException,
IOException

Returns the list of phone numbers assigned to RingCentral customer account. Both company-level and extension-level numbers are returned. Conferencing numbers, hot desk and ELIN numbers are not returned.

HTTP Method: get Endpoint: /restapi/v2/accounts/{accountId}/phone-numbers Rate Limit Group: Heavy App Permission: ReadAccounts User Permission: ReadCompanyPhoneNumbers

Throws:

RestException

IOException

get

public AccountPhoneNumberList get()
                           throws RestException,
IOException

Throws:

RestException

IOException

delete

public DeletePhoneNumbersResponse delete(DeletePhoneNumbersRequest deletePhoneNumbersRequest)
                                  throws RestException,
IOException

This method can only delete numbers that meet one of the following requirements: - numbers that have `"usageType": "Inventory"` - `"Forwarded"` numbers - `"Forwarded Company"` numbers

In other words, this method will not delete numbers which are in use on the account - extension direct numbers, main number, etc. It is possible to indicate phone numbers to be deleted using their IDs or exact string values in e.164 format. However, the same lookup method (by ID or by value) must be used for all numbers within the same API call.

HTTP Method: delete Endpoint: /restapi/v2/accounts/{accountId}/phone-numbers Rate Limit Group: Medium App Permission: EditAccounts User Permission: EditCompanyPhoneNumbers

Throws:

RestException

IOException

patch

public AccountPhoneNumberInfo patch(AssignPhoneNumberRequest assignPhoneNumberRequest)
                             throws RestException,
IOException

Assigns or reassigns a phone number as a company or extension number.

Assign scenarios supported: - from Inventory to a company number; - from Inventory to an extension number.

Reassign scenarios supported: - from an extension to another extension; - from an extension to a company number; - from a company number to an extension.

HTTP Method: patch Endpoint: /restapi/v2/accounts/{accountId}/phone-numbers/{phoneNumberId} Rate Limit Group: Medium App Permission: EditAccounts User Permission: EditCompanyPhoneNumbers

Throws:

RestException

IOException

replace

public Index replace()

bulkAdd

public Index bulkAdd()

bulkAdd

public Index bulkAdd(String taskId)