1. References
  2. Management API
  3. Structure
  4. PhoneNumberCountryRegionInfoType
Rate this page:

PhoneNumberCountryRegionInfoType

The GetPhoneNumberRegions function result.

Fields

account_currency

Optional
Copy URL
account_currency: 
string

Account currency

account_installation_price

Optional
Copy URL
account_installation_price: 
number

Phone number installation price in the account currency

account_price

Optional
Copy URL
account_price: 
number

Phone number price in the account currency

is_need_regulation_address

Optional
Copy URL
is_need_regulation_address: 
boolean

Whether to need proof of address

is_sms_supported

Copy URL
is_sms_supported: 
boolean

Whether SMS is supported for phone numbers in this region. SMS needs to be explicitly enabled for a phone number via the ControlSms Management API before sending or receiving SMS. If SMS is supported and enabled, SMS can be sent from a phone number via the SendSmsMessage Management API and received via the InboundSmsCallback property of the HTTP callback. See this article for HTTP callback details

local_currency

Optional
Copy URL
local_currency: 
string

Price list currency

local_installation_price

Optional
Copy URL
local_installation_price: 
number

Phone number installation price from the price list

local_price

Optional
Copy URL
local_price: 
number

Phone number price from the price list

localized_country_name

Copy URL
localized_country_name: 
string

The localized country name

localized_phone_category_name

Copy URL
localized_phone_category_name: 
string

The localized phone category name

localized_phone_region_name

Copy URL
localized_phone_region_name: 
string

The localized phone region name

multiple_numbers_price

Copy URL
multiple_numbers_price: 
[MultipleNumbersPrice]

Array with info about multiple numbers subscription for the child accounts

phone_count

Copy URL
phone_count: 
number

The phone number count in stock for the region

phone_installation_tax_reserve

Copy URL
phone_installation_tax_reserve: 
number

The phone number installation tax reserve

phone_period

Copy URL
phone_period: 
string

The charge period in 24-h format: Y-M-D H:m:s. Example: 0-1-0 0:0:0 is 1 month

phone_region_code

Copy URL
phone_region_code: 
string

The region phone prefix

phone_region_id

Copy URL
phone_region_id: 
number

The region ID

phone_region_name

Copy URL
phone_region_name: 
string

The full region name

phone_tax_reserve

Copy URL
phone_tax_reserve: 
number

The phone number tax reserve

regulation_address_type

Optional
Copy URL
regulation_address_type: 
string

The type of regulation address. The possible values are LOCAL, NATIONAL, WORLDWIDE

required_verification

Optional
Copy URL
required_verification: 
boolean

Whether verification is required for the account

verification_status

Optional
Copy URL
verification_status: 
string

The account verification status. The following values are possible: REQUIRED, IN_PROGRESS, VERIFIED