REST Resource: phoneNumbers¶

Resource: PhoneNumber¶

The PhoneNumber resource.

JSON representation

{
  "name": string,
  "phoneNumber": string,
  "capabilities": [
    enum (PhoneNumberCapability)
  ],
  "sku": string,
  "activationSku": string,
  "numberType": enum (PhoneNumberType),
  "countryCode": string
}

Fields
name	string Resource name of the phone number. It must match the pattern `phoneNumbers/*`
phoneNumber	string The phone number, in +E164 format.
capabilities[]	enum (PhoneNumberCapability) The capabilities of the phone number.
sku	string The SKU that will be used to bill the phone number for the monthly service charge. In the form `services//skus/`. Output only.
activationSku	string The SKU that will be used to bill the phone number for the once-off activation charge. In the form `services//skus/`. If not set, there is no activation charge. Output only.
numberType	enum (PhoneNumberType) The type of phone number.
countryCode	string The alpha-2 country code that identifies the country associated with the phone number.

PhoneNumber.PhoneNumberCapability¶

A capability of a phone number.

Enums
PHONE_NUMBER_CAPABILITY_UNSPECIFIED	Unspecified phone number capability.
SMS	The phone number is capable of SMS.
MMS	The phone number is capable of MMS.
VOICE	The phone number is capable of voice.

PhoneNumber.PhoneNumberType¶

The type of phone number.

Enums
PHONE_NUMBER_TYPE_UNSPECIFIED	Unspecified phone number type.
LOCAL	The phone number is a local phone number and corresponds to a specific geography within a country.
NATIONAL	The phone number is a national phone number and is independent of geography within a country.
MOBILE	The phone number is a mobile-only phone number and is independent of geography within a country.
TOLL_FREE	The phone number is a toll-free number, where the caller can call the number typically without any cost to the caller.
SHARED_RATE	The phone number is a shared-rate number, where both the caller and holder of the phone number both typically share in the cost of calls to the phone number.

Methods¶

Methods
search	GET /v1beta1/phoneNumbers:search Searches available phone numbers with the specified filters. Search returns phone numbers sorted by create_time descending. The caller must be authenticated.