Name | Type | Description | Notes |
---|---|---|---|
id | String | Identifies the resource. | [optional] [readonly] |
recordType | String | Identifies the type of the resource. | [optional] [readonly] |
phoneNumber | String | The +E.164-formatted phone number associated with this record. | [optional] [readonly] |
status | StatusEnum | The phone number's current status. | [optional] [readonly] |
tags | List<String> | A list of user-assigned tags to help manage the phone number. | [optional] |
externalPin | String | If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism. | [optional] |
connectionName | String | The user-assigned name of the connection to be associated with this phone number. | [optional] [readonly] |
connectionId | String | Identifies the connection associated with the phone number. | [optional] |
customerReference | String | A customer reference string for customer look ups. | [optional] |
messagingProfileId | String | Identifies the messaging profile associated with the phone number. | [optional] |
messagingProfileName | String | The name of the messaging profile associated with the phone number. | [optional] |
billingGroupId | String | Identifies the billing group associated with the phone number. | [optional] |
emergencyEnabled | Boolean | Indicates whether emergency services are enabled for this number. | [optional] [readonly] |
emergencyAddressId | String | Identifies the emergency address associated with the phone number. | [optional] [readonly] |
callForwardingEnabled | Boolean | Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints. | [optional] [readonly] |
cnamListingEnabled | Boolean | Indicates whether a CNAM listing is enabled for this number. | [optional] [readonly] |
callerIdNameEnabled | Boolean | Indicates whether caller ID is enabled for this number. | [optional] [readonly] |
callRecordingEnabled | Boolean | Indicates whether call recording is enabled for this number. | [optional] [readonly] |
t38FaxGatewayEnabled | Boolean | Indicates whether T38 Fax Gateway for inbound calls to this number. | [optional] [readonly] |
purchasedAt | String | ISO 8601 formatted date indicating the time the request was made to purchase the number. | [optional] [readonly] |
createdAt | String | ISO 8601 formatted date indicating when the time it took to activate after the purchase. | [optional] [readonly] |
updatedAt | String | ISO 8601 formatted date indicating when the resource was updated. | [optional] [readonly] |
numberLevelRouting | NumberLevelRoutingEnum | Deprecated field, the only value for this is 'disabled'. All routing for numbers should be configured via connection settings. | [optional] |
phoneNumberType | PhoneNumberTypeEnum | The phone number's type. | [optional] [readonly] |
Name | Value |
---|---|
PURCHASE_PENDING | "purchase-pending" |
PURCHASE_FAILED | "purchase-failed" |
PORT_PENDING | "port-pending" |
PORT_FAILED | "port-failed" |
ACTIVE | "active" |
DELETED | "deleted" |
EMERGENCY_ONLY | "emergency-only" |
PORTED_OUT | "ported-out" |
PORT_OUT_PENDING | "port-out-pending" |
Name | Value |
---|---|
DISABLED | "disabled" |
Name | Value |
---|---|
LOCAL | "local" |
TOLL_FREE | "toll_free" |
MOBILE | "mobile" |
NATIONAL | "national" |
SHARED_COST | "shared_cost" |
LANDLINE | "landline" |