--- title: "End User activation" method: POST path: "/v2/partition/{partitionId}/account/{accountId}/user/activation" tags: ["End User"] deprecated: true --- # End User activation `POST /v2/partition/{partitionId}/account/{accountId}/user/activation` ## Request - Base URL: `https://api.alianza.com` - URL: `https://api.alianza.com/v2/partition/{partitionId}/account/{accountId}/user/activation` - Auth: API key in header `X-AUTH-TOKEN` - TypeScript: (a function with typed inputs; its response is checked against the schema) > **Deprecated.** (DEPRECATED) Use to create a new end user/device/csr to an existing account ## Path parameters - `accountId` string, required - `partitionId` string, required ## Request body - EndUserActivationV2X - `device` DeviceX - `id` string, required: Not required for creating a new device line - `deviceTypeId` string, required: Identifies the equipment as well as the features that the device supports. Refers to deviceType.id. See also: Get All Device Types and Get Device Type by ID - `accountId` string, required: Not required for creating a new device line - `partitionId` string, required: Not required for creating a new device line - `macAddress` string: The 48-bit hexadecimal address assigned to the device by the manufacturer. Required if the device line refers to a physical device. Must not be claimed in another device request. - `deviceName` string, required - `emergencyNumber` string: Required if emergencyNumberReservationId is absent - `emergencyNumberReservationId` string: Required if emergencyNumber is absent - `faxEnabled` boolean, required - `lineNumber` integer, required: Required for POST & PUT operations only - `userId` string, required - `sipPassword` string - `sipUsername` string: Required to be globally unique if specified - `zipcode` string - `state` string - `lineType` 'Line' | 'AdvancedSharedLine' | 'ReferencedUser' | 'IntercomLine' | 'PresenceBlfUser' | 'SpeedDialUser' | 'SpeedDialTn' | 'CallParkingSpot' | 'SipPaging' | 'Custom' - `referenceId` string: Changes Depending on LineType. If LineType.Line then this should be null. If LineType.ReferencedUser, PresenceBlfUser, or SpeedDialUser then this should be a valid userid. If LineType.SpeedDialTn then this should be a valid phone number. - `provisioningRequest` ProvisioningRequestX - `id` string: The 48-bit hexadecimal address assigned to the device by the manufacturer. - `requestDate` string, date-time: The ISO 8601 formatted date string indicating when the device last tried to retrieve provisioning data. - `httpStatus` integer: The http status of the device's most recent request for provisioning. - `deviceId` string: DeviceId, reference to device.id - `ipAddress` string - `userAgent` string: The user agent that was used to retrieve the provisioning data. - `user` EndUserV2X - `id` string - `username` string: If the userProductPlan is ADVANCED or PROFESSIONAL, do not use an email as a username as this will result in loss of access to the softphone client. - `firstName` string - `lastName` string - `emailAddress` string: Must be a valid email address - `mustChangePassword` boolean - `languageTag` string: RFC-5646 Language tag. Refer to supported languages for a list of supported values. - `partitionId` string - `accountId` string - `callingPlans` CallingPlanX[]: callingPlans - `id` string - `referenceId` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'ACCOUNT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER' - `callingPlanProductId` string - `endDate` string, date-time - `startDate` string, date-time - `planMinutes` integer - `secondsRemaining` integer - `devices` DeviceX[]: devices - `id` string, required: Not required for creating a new device line - `deviceTypeId` string, required: Identifies the equipment as well as the features that the device supports. Refers to deviceType.id. See also: Get All Device Types and Get Device Type by ID - `accountId` string, required: Not required for creating a new device line - `partitionId` string, required: Not required for creating a new device line - `macAddress` string: The 48-bit hexadecimal address assigned to the device by the manufacturer. Required if the device line refers to a physical device. Must not be claimed in another device request. - `deviceName` string, required - `emergencyNumber` string: Required if emergencyNumberReservationId is absent - `emergencyNumberReservationId` string: Required if emergencyNumber is absent - `faxEnabled` boolean, required - `lineNumber` integer, required: Required for POST & PUT operations only - `userId` string, required - `sipPassword` string - `sipUsername` string: Required to be globally unique if specified - `zipcode` string - `state` string - `lineType` 'Line' | 'AdvancedSharedLine' | 'ReferencedUser' | 'IntercomLine' | 'PresenceBlfUser' | 'SpeedDialUser' | 'SpeedDialTn' | 'CallParkingSpot' | 'SipPaging' | 'Custom' - `referenceId` string: Changes Depending on LineType. If LineType.Line then this should be null. If LineType.ReferencedUser, PresenceBlfUser, or SpeedDialUser then this should be a valid userid. If LineType.SpeedDialTn then this should be a valid phone number. - `provisioningRequest` ProvisioningRequestX - `id` string: The 48-bit hexadecimal address assigned to the device by the manufacturer. - `requestDate` string, date-time: The ISO 8601 formatted date string indicating when the device last tried to retrieve provisioning data. - `httpStatus` integer: The http status of the device's most recent request for provisioning. - `deviceId` string: DeviceId, reference to device.id - `ipAddress` string - `userAgent` string: The user agent that was used to retrieve the provisioning data. - `timeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland', required - `extension` string - `callerIdConfig` CallerIdConfigX - `callerIdNumber` string - `externalCallerIdVisible` boolean, required - `extensionCallerIdVisible` boolean, required - `callerIdNumberReservationId` string - `callerIdName` string - `callHandlingSettings` CallHandlingSettingsX - `callWaitingEnabled` boolean - `doNotDisturbEnabled` boolean - `callHandlingOptionType` 'RingPhone' | 'ForwardAlways' | 'SimultaneousRing' | 'FindMeFollowMe' - `forwardAlwaysToNumber` string - `forwardAlwaysToNumberDescription` string - `ringPhoneCallHandling` RingPhoneCallHandlingX - `busyCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `noAnswerCallHandling` CallHandlingWithTimeoutX - `type` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `timeout` integer - `forwardToNumber` string - `description` string - `unregisteredCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `simultaneousRingCallHandling` SimultaneousRingCallHandlingX - `forwardToNumberList` string[] - `forwardToTimedNumberList` SimultaneousRingEndpointX[]: Mutually exclusive with forwardToNumberList; if both are sent, this list takes precedence when non-empty. Endpoint delays must be in chronological order with no gaps between active windows. The first endpoint delay must be less than or equal to noAnswerCallHandling.timeout. - `toNumber` string - `ringDelay` integer - `ringDuration` integer: When noAnswerCallHandling.type is RingForever, this value is ignored by the service. - `continueOnBusy` boolean - `noAnswerCallHandling` CallHandlingWithTimeoutX - `type` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `timeout` integer - `forwardToNumber` string - `description` string - `continueOnBusy` boolean - `findMeFollowMeCallHandling` FindMeFollowMeCallHandlingX - `findMeEndpoints` FindMeEndpointX[] - `ringUserDevice` boolean - `toNumber` string - `description` string - `timeout` integer - `toUserId` string - `continueOnBusy` boolean: Must be false for the last Find Me endpoint. - `busyCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `timeoutType` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `forwardAlwaysToNumberType` 'Extension' | 'PhoneNumber' | 'ShortCode' - `callScreeningSettings` CallScreeningSettingsX - `anonymousCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `anonymousRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `tollFreeCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `tollFreeRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `defaultCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `defaultRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `customCallScreenList` CustomCallScreenX[] - `telephoneNumber` string - `blockType` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `forwardTn` string - `newCppId` string - `mediaFriends` MediaFriendsX - `enabled` boolean - `host` string - `toNumber` string - `callHandlingSchedules` CallHandlingScheduleX[] - `schedule` ScheduleX - `name` string - `type` 'CUSTOM' | 'WEEKLY' - `weekly` object - `custom` CustomScheduleX[] - `date` string, date-time, required - `startTime` string, required - `endTime` string, required - `callHandling` CallHandlingSettingsX - `callWaitingEnabled` boolean - `doNotDisturbEnabled` boolean - `callHandlingOptionType` 'RingPhone' | 'ForwardAlways' | 'SimultaneousRing' | 'FindMeFollowMe' - `forwardAlwaysToNumber` string - `forwardAlwaysToNumberDescription` string - `ringPhoneCallHandling` RingPhoneCallHandlingX - `busyCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `noAnswerCallHandling` CallHandlingWithTimeoutX - `type` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `timeout` integer - `forwardToNumber` string - `description` string - `unregisteredCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `simultaneousRingCallHandling` SimultaneousRingCallHandlingX - `forwardToNumberList` string[] - `forwardToTimedNumberList` SimultaneousRingEndpointX[]: Mutually exclusive with forwardToNumberList; if both are sent, this list takes precedence when non-empty. Endpoint delays must be in chronological order with no gaps between active windows. The first endpoint delay must be less than or equal to noAnswerCallHandling.timeout. - `toNumber` string - `ringDelay` integer - `ringDuration` integer: When noAnswerCallHandling.type is RingForever, this value is ignored by the service. - `continueOnBusy` boolean - `noAnswerCallHandling` CallHandlingWithTimeoutX - `type` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `timeout` integer - `forwardToNumber` string - `description` string - `continueOnBusy` boolean - `findMeFollowMeCallHandling` FindMeFollowMeCallHandlingX - `findMeEndpoints` FindMeEndpointX[] - `ringUserDevice` boolean - `toNumber` string - `description` string - `timeout` integer - `toUserId` string - `continueOnBusy` boolean: Must be false for the last Find Me endpoint. - `busyCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `timeoutType` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `forwardAlwaysToNumberType` 'Extension' | 'PhoneNumber' | 'ShortCode' - `voicemailBoxId` string - `endUserType` 'ADMIN' | 'ADVANCED_ADMIN' | 'BASIC_ADMIN' | 'STANDARD' | 'STANDARD_ADMIN' | 'SUPER_ADMIN' - `userProductPlan` 'STANDARD' | 'ADVANCED' | 'PROFESSIONAL' - `softphoneClientType` 'STRETTO' | 'CYMBUS' - `pinLockedOut` boolean - `privacySettings` EndUserPrivacySettingsX - `directoryPrivacyEnabled` boolean - `autoAttendantDialByExtensionPrivacyEnabled` boolean - `autoAttendantDialByNamePrivacyEnabled` boolean - `autoAnswerPrivacyEnabled` boolean - `welcomeEmailSent` string, date-time - `blockEmail` boolean - `allowPortalAccess` boolean - `tags` string - `group` UserGroupX - `id` string - `name` string - `description` string - `telephoneNumberAccount` TelephoneNumberAccountV2X - `phoneNumber` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'LINE_APPEARANCE' | 'LINE_HUNTGROUP' | 'TELEPHONE' | 'VFAX' | 'BUSINESS_LINE' | 'BUSINESS_LINE_HUNT_GROUP' | 'CALL_GROUP' | 'CALL_QUEUE' | 'AUTO_ATTENDANT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER': What kind of destination gets calls from this number. - `referenceId` string: The id of the destination which gets calls from this number. You can think of this as a variable refkey; what it points to depends on the referenceType. - `functionType` 'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN' - `canAcceptSMS` boolean - `operationalStatus` 'ACTIVE' | 'STAGED' - `portId` string - `servicePackageType` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `accountId` string - `partitionId` string - `customerServiceRecord` CustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `carrierStatus` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED' - `orderVersion` string - `e911Address` E911AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `latitude` string: -90 through 90, 4-6 decimals - `longitude` string: -180 through 180, 4-6 decimals - `language` string: Optional, see /v2/ref/language for supported languages - `temporaryNumber` string - `directoryListing` DirectoryListingX - `listed` boolean - `type` 'ERROR' | 'LIST_PUBLISH' | 'LIST_NOT_PUBLISH' | 'NOT_LIST_NOT_PUBLISH' | 'PORTED' | 'COMPLEX': Indicates how a telephone number should be listed. - `address` AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in USA and CAN - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `assignAsCallerId` boolean - `byotnCarrierId` string - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7': Default ringtype for this phone - `carrierId` string - `tollFree` boolean - `id` string - `tags` string[]: Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number. - `dynamicTelephoneNumberActivation` DynamicTelephoneNumberActivationX - `partitionId` string - `accountId` string - `carrierId` string - `orderId` string - `tnQuantity` integer - `deviceId` string - `userId` string - `customerServiceRecord` LatLongCustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `latitude` number, double - `longitude` number, double - `directoryListing` DirectoryListingX - `listed` boolean - `type` 'ERROR' | 'LIST_PUBLISH' | 'LIST_NOT_PUBLISH' | 'NOT_LIST_NOT_PUBLISH' | 'PORTED' | 'COMPLEX': Indicates how a telephone number should be listed. - `address` AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in USA and CAN - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `e911Address` E911AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `latitude` string: -90 through 90, 4-6 decimals - `longitude` string: -180 through 180, 4-6 decimals - `language` string: Optional, see /v2/ref/language for supported languages - `tnSettings` TelephoneNumberAccountBareX - `phoneNumber` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'LINE_APPEARANCE' | 'LINE_HUNTGROUP' | 'TELEPHONE' | 'VFAX' | 'BUSINESS_LINE' | 'BUSINESS_LINE_HUNT_GROUP' | 'CALL_GROUP' | 'CALL_QUEUE' | 'AUTO_ATTENDANT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER' - `referenceId` string - `functionType` 'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN' - `canAcceptSMS` boolean - `operationalStatus` 'ACTIVE' | 'STAGED' - `portId` string - `servicePackageType` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `tollFree` boolean - `id` string - `tags` string[]: Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number. - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `archived` boolean - `alianzaOrderId` string - `smsSettings` SmsSettingsX - `smsLoaDocumentVersionId` string - `updatedAt` string, date-time - `campaignId` string - `smsLoa` FileDataBase64X - `contentType` string - `name` string - `contentBase64` string - `enableSMS` boolean - `createdAt` string, date-time - `authorizingPerson` string - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED' - `smsCarrierId` string - `campaignName` string - `remoteCampaignId` string - `id` string - `port` PortX - `id` string - `partitionId` string - `accountId` string - `telephoneNumbers` string[] - `status` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED' - `sendLoa` boolean - `loaSaved` boolean - `carrierId` string - `carrierType` 'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER' - `customerServiceRecord` CustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `crdDate` string, date-time - `billingTelephoneNumber` string - `portingWireType` 'Wireless' | 'Wireline' - `portingAuthorizedName` string - `wirelessAccountNumber` string - `wirelessPin` string - `focDate` string, date-time - `focDateTimeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland' - `createdDate` string, date-time - `completedDate` string, date-time - `cancelType` 'NORMAL' | 'EXPIDITED' | 'BY_CARRIER' - `telecomSettings` TelecomSettingsX - `notes` string - `currentCarrier` string - `currentCarrierName` string - `localReseller` string - `loaDate` string, date-time - `disconnectInternetService` boolean - `disconnectTelevisionService` boolean - `tnData` object - `hotCutPortId` string - `portNow` boolean - `canAcceptSMS` boolean - `smsCallbackUrl` string - `smsSettings` SmsSettingsX - `smsLoaDocumentVersionId` string - `updatedAt` string, date-time - `campaignId` string - `smsLoa` FileDataBase64X - `contentType` string - `name` string - `contentBase64` string - `enableSMS` boolean - `createdAt` string, date-time - `authorizingPerson` string - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED' - `smsCarrierId` string - `campaignName` string - `remoteCampaignId` string - `tags` string[] - `holdActivation` boolean ## Response `200` Successful operation - EndUserActivationV2X - `device` DeviceX - `id` string, required: Not required for creating a new device line - `deviceTypeId` string, required: Identifies the equipment as well as the features that the device supports. Refers to deviceType.id. See also: Get All Device Types and Get Device Type by ID - `accountId` string, required: Not required for creating a new device line - `partitionId` string, required: Not required for creating a new device line - `macAddress` string: The 48-bit hexadecimal address assigned to the device by the manufacturer. Required if the device line refers to a physical device. Must not be claimed in another device request. - `deviceName` string, required - `emergencyNumber` string: Required if emergencyNumberReservationId is absent - `emergencyNumberReservationId` string: Required if emergencyNumber is absent - `faxEnabled` boolean, required - `lineNumber` integer, required: Required for POST & PUT operations only - `userId` string, required - `sipPassword` string - `sipUsername` string: Required to be globally unique if specified - `zipcode` string - `state` string - `lineType` 'Line' | 'AdvancedSharedLine' | 'ReferencedUser' | 'IntercomLine' | 'PresenceBlfUser' | 'SpeedDialUser' | 'SpeedDialTn' | 'CallParkingSpot' | 'SipPaging' | 'Custom' - `referenceId` string: Changes Depending on LineType. If LineType.Line then this should be null. If LineType.ReferencedUser, PresenceBlfUser, or SpeedDialUser then this should be a valid userid. If LineType.SpeedDialTn then this should be a valid phone number. - `provisioningRequest` ProvisioningRequestX - `id` string: The 48-bit hexadecimal address assigned to the device by the manufacturer. - `requestDate` string, date-time: The ISO 8601 formatted date string indicating when the device last tried to retrieve provisioning data. - `httpStatus` integer: The http status of the device's most recent request for provisioning. - `deviceId` string: DeviceId, reference to device.id - `ipAddress` string - `userAgent` string: The user agent that was used to retrieve the provisioning data. - `user` EndUserV2X - `id` string - `username` string: If the userProductPlan is ADVANCED or PROFESSIONAL, do not use an email as a username as this will result in loss of access to the softphone client. - `firstName` string - `lastName` string - `emailAddress` string: Must be a valid email address - `mustChangePassword` boolean - `languageTag` string: RFC-5646 Language tag. Refer to supported languages for a list of supported values. - `partitionId` string - `accountId` string - `callingPlans` CallingPlanX[]: callingPlans - `id` string - `referenceId` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'ACCOUNT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER' - `callingPlanProductId` string - `endDate` string, date-time - `startDate` string, date-time - `planMinutes` integer - `secondsRemaining` integer - `devices` DeviceX[]: devices - `id` string, required: Not required for creating a new device line - `deviceTypeId` string, required: Identifies the equipment as well as the features that the device supports. Refers to deviceType.id. See also: Get All Device Types and Get Device Type by ID - `accountId` string, required: Not required for creating a new device line - `partitionId` string, required: Not required for creating a new device line - `macAddress` string: The 48-bit hexadecimal address assigned to the device by the manufacturer. Required if the device line refers to a physical device. Must not be claimed in another device request. - `deviceName` string, required - `emergencyNumber` string: Required if emergencyNumberReservationId is absent - `emergencyNumberReservationId` string: Required if emergencyNumber is absent - `faxEnabled` boolean, required - `lineNumber` integer, required: Required for POST & PUT operations only - `userId` string, required - `sipPassword` string - `sipUsername` string: Required to be globally unique if specified - `zipcode` string - `state` string - `lineType` 'Line' | 'AdvancedSharedLine' | 'ReferencedUser' | 'IntercomLine' | 'PresenceBlfUser' | 'SpeedDialUser' | 'SpeedDialTn' | 'CallParkingSpot' | 'SipPaging' | 'Custom' - `referenceId` string: Changes Depending on LineType. If LineType.Line then this should be null. If LineType.ReferencedUser, PresenceBlfUser, or SpeedDialUser then this should be a valid userid. If LineType.SpeedDialTn then this should be a valid phone number. - `provisioningRequest` ProvisioningRequestX - `id` string: The 48-bit hexadecimal address assigned to the device by the manufacturer. - `requestDate` string, date-time: The ISO 8601 formatted date string indicating when the device last tried to retrieve provisioning data. - `httpStatus` integer: The http status of the device's most recent request for provisioning. - `deviceId` string: DeviceId, reference to device.id - `ipAddress` string - `userAgent` string: The user agent that was used to retrieve the provisioning data. - `timeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland', required - `extension` string - `callerIdConfig` CallerIdConfigX - `callerIdNumber` string - `externalCallerIdVisible` boolean, required - `extensionCallerIdVisible` boolean, required - `callerIdNumberReservationId` string - `callerIdName` string - `callHandlingSettings` CallHandlingSettingsX - `callWaitingEnabled` boolean - `doNotDisturbEnabled` boolean - `callHandlingOptionType` 'RingPhone' | 'ForwardAlways' | 'SimultaneousRing' | 'FindMeFollowMe' - `forwardAlwaysToNumber` string - `forwardAlwaysToNumberDescription` string - `ringPhoneCallHandling` RingPhoneCallHandlingX - `busyCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `noAnswerCallHandling` CallHandlingWithTimeoutX - `type` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `timeout` integer - `forwardToNumber` string - `description` string - `unregisteredCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `simultaneousRingCallHandling` SimultaneousRingCallHandlingX - `forwardToNumberList` string[] - `forwardToTimedNumberList` SimultaneousRingEndpointX[]: Mutually exclusive with forwardToNumberList; if both are sent, this list takes precedence when non-empty. Endpoint delays must be in chronological order with no gaps between active windows. The first endpoint delay must be less than or equal to noAnswerCallHandling.timeout. - `toNumber` string - `ringDelay` integer - `ringDuration` integer: When noAnswerCallHandling.type is RingForever, this value is ignored by the service. - `continueOnBusy` boolean - `noAnswerCallHandling` CallHandlingWithTimeoutX - `type` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `timeout` integer - `forwardToNumber` string - `description` string - `continueOnBusy` boolean - `findMeFollowMeCallHandling` FindMeFollowMeCallHandlingX - `findMeEndpoints` FindMeEndpointX[] - `ringUserDevice` boolean - `toNumber` string - `description` string - `timeout` integer - `toUserId` string - `continueOnBusy` boolean: Must be false for the last Find Me endpoint. - `busyCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `timeoutType` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `forwardAlwaysToNumberType` 'Extension' | 'PhoneNumber' | 'ShortCode' - `callScreeningSettings` CallScreeningSettingsX - `anonymousCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `anonymousRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `tollFreeCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `tollFreeRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `defaultCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `defaultRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `customCallScreenList` CustomCallScreenX[] - `telephoneNumber` string - `blockType` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `forwardTn` string - `newCppId` string - `mediaFriends` MediaFriendsX - `enabled` boolean - `host` string - `toNumber` string - `callHandlingSchedules` CallHandlingScheduleX[] - `schedule` ScheduleX - `name` string - `type` 'CUSTOM' | 'WEEKLY' - `weekly` object - `custom` CustomScheduleX[] - `date` string, date-time, required - `startTime` string, required - `endTime` string, required - `callHandling` CallHandlingSettingsX - `callWaitingEnabled` boolean - `doNotDisturbEnabled` boolean - `callHandlingOptionType` 'RingPhone' | 'ForwardAlways' | 'SimultaneousRing' | 'FindMeFollowMe' - `forwardAlwaysToNumber` string - `forwardAlwaysToNumberDescription` string - `ringPhoneCallHandling` RingPhoneCallHandlingX - `busyCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `noAnswerCallHandling` CallHandlingWithTimeoutX - `type` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `timeout` integer - `forwardToNumber` string - `description` string - `unregisteredCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `simultaneousRingCallHandling` SimultaneousRingCallHandlingX - `forwardToNumberList` string[] - `forwardToTimedNumberList` SimultaneousRingEndpointX[]: Mutually exclusive with forwardToNumberList; if both are sent, this list takes precedence when non-empty. Endpoint delays must be in chronological order with no gaps between active windows. The first endpoint delay must be less than or equal to noAnswerCallHandling.timeout. - `toNumber` string - `ringDelay` integer - `ringDuration` integer: When noAnswerCallHandling.type is RingForever, this value is ignored by the service. - `continueOnBusy` boolean - `noAnswerCallHandling` CallHandlingWithTimeoutX - `type` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `timeout` integer - `forwardToNumber` string - `description` string - `continueOnBusy` boolean - `findMeFollowMeCallHandling` FindMeFollowMeCallHandlingX - `findMeEndpoints` FindMeEndpointX[] - `ringUserDevice` boolean - `toNumber` string - `description` string - `timeout` integer - `toUserId` string - `continueOnBusy` boolean: Must be false for the last Find Me endpoint. - `busyCallHandling` CallHandlingX - `type` 'Forward' | 'Voicemail' | 'Busy' - `forwardToNumber` string - `description` string - `timeoutType` 'Forward' | 'Voicemail' | 'Busy' | 'RingForever' - `forwardAlwaysToNumberType` 'Extension' | 'PhoneNumber' | 'ShortCode' - `voicemailBoxId` string - `endUserType` 'ADMIN' | 'ADVANCED_ADMIN' | 'BASIC_ADMIN' | 'STANDARD' | 'STANDARD_ADMIN' | 'SUPER_ADMIN' - `userProductPlan` 'STANDARD' | 'ADVANCED' | 'PROFESSIONAL' - `softphoneClientType` 'STRETTO' | 'CYMBUS' - `pinLockedOut` boolean - `privacySettings` EndUserPrivacySettingsX - `directoryPrivacyEnabled` boolean - `autoAttendantDialByExtensionPrivacyEnabled` boolean - `autoAttendantDialByNamePrivacyEnabled` boolean - `autoAnswerPrivacyEnabled` boolean - `welcomeEmailSent` string, date-time - `blockEmail` boolean - `allowPortalAccess` boolean - `tags` string - `group` UserGroupX - `id` string - `name` string - `description` string - `telephoneNumberAccount` TelephoneNumberAccountV2X - `phoneNumber` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'LINE_APPEARANCE' | 'LINE_HUNTGROUP' | 'TELEPHONE' | 'VFAX' | 'BUSINESS_LINE' | 'BUSINESS_LINE_HUNT_GROUP' | 'CALL_GROUP' | 'CALL_QUEUE' | 'AUTO_ATTENDANT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER': What kind of destination gets calls from this number. - `referenceId` string: The id of the destination which gets calls from this number. You can think of this as a variable refkey; what it points to depends on the referenceType. - `functionType` 'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN' - `canAcceptSMS` boolean - `operationalStatus` 'ACTIVE' | 'STAGED' - `portId` string - `servicePackageType` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `accountId` string - `partitionId` string - `customerServiceRecord` CustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `carrierStatus` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED' - `orderVersion` string - `e911Address` E911AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `latitude` string: -90 through 90, 4-6 decimals - `longitude` string: -180 through 180, 4-6 decimals - `language` string: Optional, see /v2/ref/language for supported languages - `temporaryNumber` string - `directoryListing` DirectoryListingX - `listed` boolean - `type` 'ERROR' | 'LIST_PUBLISH' | 'LIST_NOT_PUBLISH' | 'NOT_LIST_NOT_PUBLISH' | 'PORTED' | 'COMPLEX': Indicates how a telephone number should be listed. - `address` AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in USA and CAN - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `assignAsCallerId` boolean - `byotnCarrierId` string - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7': Default ringtype for this phone - `carrierId` string - `tollFree` boolean - `id` string - `tags` string[]: Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number. - `dynamicTelephoneNumberActivation` DynamicTelephoneNumberActivationX - `partitionId` string - `accountId` string - `carrierId` string - `orderId` string - `tnQuantity` integer - `deviceId` string - `userId` string - `customerServiceRecord` LatLongCustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `latitude` number, double - `longitude` number, double - `directoryListing` DirectoryListingX - `listed` boolean - `type` 'ERROR' | 'LIST_PUBLISH' | 'LIST_NOT_PUBLISH' | 'NOT_LIST_NOT_PUBLISH' | 'PORTED' | 'COMPLEX': Indicates how a telephone number should be listed. - `address` AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in USA and CAN - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `e911Address` E911AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `latitude` string: -90 through 90, 4-6 decimals - `longitude` string: -180 through 180, 4-6 decimals - `language` string: Optional, see /v2/ref/language for supported languages - `tnSettings` TelephoneNumberAccountBareX - `phoneNumber` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'LINE_APPEARANCE' | 'LINE_HUNTGROUP' | 'TELEPHONE' | 'VFAX' | 'BUSINESS_LINE' | 'BUSINESS_LINE_HUNT_GROUP' | 'CALL_GROUP' | 'CALL_QUEUE' | 'AUTO_ATTENDANT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER' - `referenceId` string - `functionType` 'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN' - `canAcceptSMS` boolean - `operationalStatus` 'ACTIVE' | 'STAGED' - `portId` string - `servicePackageType` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `tollFree` boolean - `id` string - `tags` string[]: Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number. - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `archived` boolean - `alianzaOrderId` string - `smsSettings` SmsSettingsX - `smsLoaDocumentVersionId` string - `updatedAt` string, date-time - `campaignId` string - `smsLoa` FileDataBase64X - `contentType` string - `name` string - `contentBase64` string - `enableSMS` boolean - `createdAt` string, date-time - `authorizingPerson` string - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED' - `smsCarrierId` string - `campaignName` string - `remoteCampaignId` string - `id` string - `port` PortX - `id` string - `partitionId` string - `accountId` string - `telephoneNumbers` string[] - `status` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED' - `sendLoa` boolean - `loaSaved` boolean - `carrierId` string - `carrierType` 'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER' - `customerServiceRecord` CustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `crdDate` string, date-time - `billingTelephoneNumber` string - `portingWireType` 'Wireless' | 'Wireline' - `portingAuthorizedName` string - `wirelessAccountNumber` string - `wirelessPin` string - `focDate` string, date-time - `focDateTimeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland' - `createdDate` string, date-time - `completedDate` string, date-time - `cancelType` 'NORMAL' | 'EXPIDITED' | 'BY_CARRIER' - `telecomSettings` TelecomSettingsX - `notes` string - `currentCarrier` string - `currentCarrierName` string - `localReseller` string - `loaDate` string, date-time - `disconnectInternetService` boolean - `disconnectTelevisionService` boolean - `tnData` object - `hotCutPortId` string - `portNow` boolean - `canAcceptSMS` boolean - `smsCallbackUrl` string - `smsSettings` SmsSettingsX - `smsLoaDocumentVersionId` string - `updatedAt` string, date-time - `campaignId` string - `smsLoa` FileDataBase64X - `contentType` string - `name` string - `contentBase64` string - `enableSMS` boolean - `createdAt` string, date-time - `authorizingPerson` string - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED' - `smsCarrierId` string - `campaignName` string - `remoteCampaignId` string - `tags` string[] - `holdActivation` boolean ## Other responses - `400`: Invalid end user activation object(s) supplied - `404`: Account not found --- [API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/7223246c352c?raw)