Latest Legacy

The AccountPhoneNumber object

Attributes

number string

The phone number.

alias string

Alias for the phone number.

subaccount string

The subaccount with which the phone number is associated. If phone number belongs to the main account, this value will be null.

added_on string

The date on which the number was rented to the account. Format: YYYY-MM-DD

application string

The application linked to the number.

carrier string

The carrier linked to the phone number. This can either be a Plivo carrier or an incoming carrier that you’ve added.

region string

The region (city and country) of the phone number.

number_type string

The type of the number. Can be local, fixed, toll-free, mobile, or national.

monthlyrentalrate string

The monthly rental fee for the phone number, in USD.

sms_enabled boolean

Indicates whether the phone number can receive SMS.

sms_rate string

The cost (per message) of receiving SMS on the number, in USD.

mms_enabled boolean

Indicates whether the phone number can receive MMS.

mms_rate string

The cost (per message) of receiving MMS on the number, in USD.

voice_enabled boolean

Indicates whether the phone number can receive calls.

voice_rate string

The cost (per minute) of receiving a call on the number, in USD.

resource_uri string

URI to the account phone number resource.

tendlc_registration_status string The 10DLC registration status of US local numbers. Can be UNREGISTERED, PROCESSING, COMPLETED. This value is null if a number is not a US local number that is SMS-enabled.
tendlc_campaign_id string The specific 10DLC campaign ID that the phone number is linked to. If a phone number Is not linked to any 10DLC campaign, this value is null.
toll_free_sms_verification string The SMS verification status for US/Canada toll-free numbers that are SMS-enabled. Can be UNVERIFIED, PENDING_VERIFICATION, VERIFIED. For other numbers types, this value is null.

Response

{
  "number": "17609915566",
  "alias": null,
  "sub_account": null,
  "added_on": "2022-02-14",
  "application": "/v1/Account/MAXXXXXXXXXXXXXXXXXX/Application/29986316244302815/",
  "carrier": "Plivo",
  "region": "California, UNITED STATES",
  "number_type": "local",
  "monthly_rental_rate": "0.80000",
  "sms_enabled": true,
  "sms_rate": "0.00000",
  "voice_enabled": true,
  "voice_rate": "0.00850",
  "resource_uri": "/v1/Account/MAXXXXXXXXXXXXXXXXXX/Number/17609915566/",
  "tendlc_campaign_Id":"2FA_campaign",
  "tendlc_registration_status":"COMPLETED",
  "toll_free_sms_verification":null
}