The PhoneNumber object
Attributes
number string | The phone number which can be purchased. |
prefix string | The prefix of the number. This is the area code of the number. |
city string | The city of the number. This can be null if the number is national. |
country string | The country of the number. |
region string | The region (city and country) of the phone number. |
rate_center string | The rate_center is only available for United States and Canada phone numbers. |
lata string | The lata (Local access and transport area) of the phone number. This attribute is null for all countries, except the US and Canada. |
type string | The type of the phone number can be fixed, mobile, and tollfree. |
sub_type string | The sub_type of the phone number can be fixed, mobile, tollfree, national, and local. local and national numbers are sub-types of fixed numbers. |
setup_rate string | The one-time setup fee for the number, in USD. |
monthly_rental_rate string | The monthly recurring rental fee, in USD, for the number. The monthly rent is billed at the start of the month. If the number is purchased in the middle of a month, the rental fee is pro-rated and billed. |
sms_enabled boolean | Indicates whether the phone number can receive SMS. |
sms_rate string | The cost (per SMS) of receiving an SMS on the number, in USD. |
mms_enabled boolean | Indicates whether the phone number can receive MMS. |
mms_rate string | The cost (per MMS) of receiving an MMS on the number, in USD. |
voice_enabled boolean | Indicates whether the phone number can receive calls. |
voice_rate string | The cost (per min) of receiving a call on the number, in USD. |
restriction string | Indicates the type of verification document required to activate the phone number, post its purchase. The restrictions differ between phone numbers from different countries. Possible values are:
|
restriction_text string | A description of the verification documents required to activate the phone number. |
resource_uri string | URI to the phone number resource. |
Response
{
"number": "14154009186",
"prefix": "415",
"city": "NEW YORK",
"country": "UNITED STATES",
"region": "United States",
"rate_center": "SNFC CNTRL",
"lata": 722,
"type": "fixed",
"sub_type": "local",
"setup_rate": "0.00000",
"monthly_rental_rate": "0.80000",
"sms_enabled": true,
"sms_rate": "0.00800",
"voice_enabled": true,
"voice_rate": "0.00500",
"restriction": null,
"restriction_text": null,
"resource_uri": "/v1/Account/MAXXXXXXXXXXXXXXXXXX/PhoneNumber/14154009186/",
}