Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 4.79 KB

SlimPhoneNumberDetailed.md

File metadata and controls

86 lines (62 loc) · 4.79 KB
Raw

SlimPhoneNumberDetailed

Properties

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]
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]
connectionId String Identifies the connection associated with the phone number. [optional]
customerReference String A customer reference string for customer look ups. [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 when the resource was purchased. [optional] [readonly]
createdAt String ISO 8601 formatted date indicating when the resource was created. [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. Note: For numbers purchased prior to July 2023 or when fetching a number's details immediately after a purchase completes, the legacy values `tollfree`, `shortcode` or `longcode` may be returned instead. [optional] [readonly]
inboundCallScreening InboundCallScreeningEnum The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it. [optional]

Enum: StatusEnum

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"
REQUIREMENT_INFO_PENDING "requirement-info-pending"
REQUIREMENT_INFO_UNDER_REVIEW "requirement-info-under-review"
REQUIREMENT_INFO_EXCEPTION "requirement-info-exception"
PROVISION_PENDING "provision-pending"

Enum: NumberLevelRoutingEnum

Name Value
DISABLED "disabled"

Enum: PhoneNumberTypeEnum

Name Value
LOCAL "local"
TOLL_FREE "toll_free"
MOBILE "mobile"
NATIONAL "national"
SHARED_COST "shared_cost"
LANDLINE "landline"
TOLLFREE "tollfree"
SHORTCODE "shortcode"
LONGCODE "longcode"

Enum: InboundCallScreeningEnum

Name Value
DISABLED "disabled"
REJECT_CALLS "reject_calls"
FLAG_CALLS "flag_calls"