Alianza Telephone Number API
The Telephone Number API from Alianza — 28 operation(s) for telephone number.
The Telephone Number API from Alianza — 28 operation(s) for telephone number.
openapi: 3.2.0
info:
title: Alianza Telephone Number API
version: '2'
description: 'Operations tagged Telephone Number across 2 of this provider''s published API definitions: alianza-apidocs-swagger2-original.json, alianza-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.d2.alianza.com
description: Development
- url: https://api.q2.alianza.com
description: QA
- url: https://api.b2.alianza.com
description: Beta
- url: https://api.alianza.com
description: Production
tags:
- name: Telephone Number
paths:
/v2/partition/{partitionId}/telephonenumber:
get:
tags:
- Telephone Number
operationId: retrieve_5
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
responseSchema:
type: array
items:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
content:
application/json:
schema:
type: array
items:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
responsesObject:
'200':
description: successful operation
headers: {}
responseSchema:
type: array
items:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
schema:
type: array
items:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
post:
tags:
- Telephone Number
summary: Create telephone number
description: Use to create a telephone number
operationId: createTelephoneNumber
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
content:
application/json:
schema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
'400':
description: Invalid telephone number object supplied
'404':
description: Error
responsesObject:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
schema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
'400':
description: Invalid telephone number object supplied
'404':
description: Error
requestBody:
content:
application/json:
schema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
description: Telephone number object
required: true
/v2/partition/{partitionId}/telephonenumber/{tn}:
get:
tags:
- Telephone Number
summary: Retrieve telephone number
description: Use to retrieve information about a telephone number
operationId: retrieveTelephoneNumber
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: tn
in: path
description: Telephone number
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
content:
application/json:
schema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
'400':
description: Invalid telephone number supplied
'404':
description: Telephone number not found
responsesObject:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
schema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
'400':
description: Invalid telephone number supplied
'404':
description: Telephone number not found
delete:
tags:
- Telephone Number
summary: Delete telephone number
description: Use to delete a telephone number
operationId: delete_2
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: tn
in: path
description: Telephone number
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
type: string
content:
application/json:
schema:
type: string
'400':
description: Invalid telephone number supplied
'404':
description: Error
responsesObject:
'200':
description: successful operation
responseSchema:
type: string
schema:
type: string
'400':
description: Invalid telephone number supplied
'404':
description: Error
/v2/partition/{partitionId}/telephonenumber/search:
get:
tags:
- Telephone Number
summary: Telephone number search
description: Use to search for a telephone number
operationId: search_1
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: q
in: query
description: 'Query Field: q=18015551212, q=84062, q=ALBANY, q=ALBANY.NY, LAT_LONG does not use this field'
required: false
schema:
type: string
- name: functiontype
in: query
description: Function Type, default ELS
required: false
schema:
type: string
enum:
- ELS
- TollFree
- TemporaryNumber
- SPTN
default: ELS
- name: type
in: query
description: Search Type, default POSTALCODE_OR_TN
required: false
schema:
type: string
enum:
- POSTALCODE_OR_TN
- TN
- POSTALCODE
- LAT_LONG
- RATECENTER
- RATECENTER_CARRIER
default: POSTALCODE_OR_TN
- name: lat
in: query
description: Latitude, requires type=LAT_LONG
required: false
schema:
type: number
format: double
- name: long
in: query
description: Latitude, requires type=LAT_LONG
required: false
schema:
type: number
format: double
- name: maxResults
in: query
description: Number of results to return
required: false
schema:
type: integer
format: int32
responses:
'200':
description: successful operation
responseSchema:
type: array
items:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
content:
application/json:
schema:
type: array
items:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
'400':
description: Invalid search term supplied
'404':
description: Error
responsesObject:
'200':
description: successful operation
responseSchema:
type: array
items:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
schema:
type: array
items:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
'400':
description: Invalid search term supplied
'404':
description: Error
/v2/partition/{partitionId}/telephonenumber/{tn}/availability:
get:
tags:
- Telephone Number
summary: Retrieve telephone number availability
description: Use to retrieve information about a telephone number availability
operationId: retrieveTelephoneNumberAvailability
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: tn
in: path
description: Telephone number
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberAvailabilityX
$ref: '#/components/schemas/TelephoneNumberAvailabilityX'
content:
application/json:
schema:
originalRef: TelephoneNumberAvailabilityX
$ref: '#/components/schemas/TelephoneNumberAvailabilityX'
responsesObject:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberAvailabilityX
$ref: '#/components/schemas/TelephoneNumberAvailabilityX'
schema:
originalRef: TelephoneNumberAvailabilityX
$ref: '#/components/schemas/TelephoneNumberAvailabilityX'
/v2/partition/{partitionId}/telephonenumber/bulkimport:
post:
tags:
- Telephone Number
summary: Bulk telephone number import
description: Use to import telephone numbers in bulk
operationId: bulkInsert
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
type: array
items:
type: string
content:
application/json:
schema:
type: array
items:
type: string
'400':
description: Invalid telephone number list supplied
'404':
description: Error
responsesObject:
'200':
description: successful operation
responseSchema:
type: array
items:
type: string
schema:
type: array
items:
type: string
'400':
description: Invalid telephone number list supplied
'404':
description: Error
deprecated: true
requestBody:
content:
multipart/form-data:
schema:
originalRef: MultipartFormDataInput
$ref: '#/components/schemas/MultipartFormDataInput_2'
description: Telephone number list
required: true
/v2/partition/{partitionId}/telephonenumber/bulkimport_2:
post:
tags:
- Telephone Number
summary: Bulk telephone number import
description: Use to import telephone numbers in bulk
operationId: bulkInsert2
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
content:
application/json:
schema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
'202':
description: Use Jobs API to check status
responsesObject:
'200':
description: successful operation
responseSchema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
schema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
'202':
description: Use Jobs API to check status
requestBody:
content:
application/json:
schema:
originalRef: JobUploadKey
$ref: '#/components/schemas/JobUploadKey'
description: Use Jobs API to upload file
/v2/partition/{partitionId}/telephonenumber/exportstatussearch:
get:
tags:
- Telephone Number
summary: Export as CSV telephone number status search
description: Use to export the searched status of a telephone number as a CSV file
operationId: exportStatusSearch
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: dateType
in: query
description: Type of data
required: false
schema:
type: string
enum:
- FOCDate
- UpdatedDate
- CreatedDate
- name: startDate
in: query
description: Start date
required: false
schema:
type: string
- name: endDate
in: query
description: End date
required: false
schema:
type: string
- name: statusType
in: query
description: Status type
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- PENDING
- IN_PROGRESS
- REJECTED
- FOC_RECEIVED
- FOC_REMOVED
- CANCELLED
- CANCEL_PENDING
- CARRIER_CANCELLED
- DELETE_PENDING
- DELETE_SCHEDULED
- COMPLETED
- CORRECTED_COMPLETED
- COOLDOWN
- HOT_CUT_PORT
- ON_HOLD
- RESELLER_PENDING
- name: eventType
in: query
description: Service activation event type
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- PORT_REQUEST
- CSR_CHANGE_REQUEST
- ACTIVATION
- NINE_ONE_ONE_ADDRESS
- DISCONNECT
- DYNAMIC_RESERVATION
- BYOTN_REQUEST
- SERVICE_PROVIDER_TN
- name: accountId
in: query
description: Account ID
required: false
schema:
type: string
- name: telephoneNumber
in: query
description: Telephone number
required: false
schema:
type: string
- name: includeSubTns
in: query
description: Include Sub Tns
required: false
schema:
type: boolean
default: true
responses:
'400':
description: Invalid search term supplied
'404':
description: Error
responsesObject:
'400':
description: Invalid search term supplied
'404':
description: Error
/v2/partition/{partitionId}/telephonenumber/exportstatussearch_2:
get:
tags:
- Telephone Number
summary: Export as CSV telephone number status search
description: Use to export the searched status of a telephone number as a CSV file
operationId: exportStatusSearch2
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: dateType
in: query
description: Type of data
required: false
schema:
type: string
enum:
- FOCDate
- UpdatedDate
- CreatedDate
- name: startDate
in: query
description: Start date
required: false
schema:
type: string
- name: endDate
in: query
description: End date
required: false
schema:
type: string
- name: statusType
in: query
description: Status type
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: eventType
in: query
description: Service activation event type
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: accountId
in: query
description: Account ID
required: false
schema:
type: string
- name: telephoneNumber
in: query
description: Telephone number
required: false
schema:
type: string
- name: includeSubTns
in: query
description: Include Sub Tns
required: false
schema:
type: boolean
default: true
responses:
'200':
description: successful operation
responseSchema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
content:
application/json:
schema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
'202':
description: Use Jobs API to check status
'400':
description: Invalid search term supplied
'404':
description: Error
responsesObject:
'200':
description: successful operation
responseSchema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
schema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
'202':
description: Use Jobs API to check status
'400':
description: Invalid search term supplied
'404':
description: Error
/v2/partition/{partitionId}/telephonenumber/{tn}/cooldown/recover:
put:
tags:
- Telephone Number
summary: Delete telephone number cooldown
description: Use to delete a cooldown for a telephone number
operationId: cooldownRecover
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: tn
in: path
description: Telephone number
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
content:
application/json:
schema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
'400':
description: Invalid telephone number object supplied
'404':
description: Error
responsesObject:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
schema:
originalRef: TelephoneNumberViewX
$ref: '#/components/schemas/TelephoneNumberViewX_2'
'400':
description: Invalid telephone number object supplied
'404':
description: Error
/v2/partition/{partitionId}/telephonenumber/{tn}/reserve:
put:
tags:
- Telephone Number
summary: Reserve a telephone number
description: Use to reserve a telephone number so another use cannot get it
operationId: reserve
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: tn
in: path
description: Telephone number
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberReservedX
$ref: '#/components/schemas/TelephoneNumberReservedX'
content:
application/json:
schema:
originalRef: TelephoneNumberReservedX
$ref: '#/components/schemas/TelephoneNumberReservedX'
'400':
description: Invalid telephone number object supplied
'404':
description: Error
responsesObject:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberReservedX
$ref: '#/components/schemas/TelephoneNumberReservedX'
schema:
originalRef: TelephoneNumberReservedX
$ref: '#/components/schemas/TelephoneNumberReservedX'
'400':
description: Invalid telephone number object supplied
'404':
description: Error
delete:
tags:
- Telephone Number
summary: Delete a reserve on telephone number
description: Use to delete a reservation on a telephone number making it available for use by another
operationId: releaseReservation
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: tn
in: path
description: Telephone number
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
type: string
content:
application/json:
schema:
type: string
'400':
description: Invalid telephone number object supplied
'404':
description: Error
responsesObject:
'200':
description: successful operation
responseSchema:
type: string
schema:
type: string
'400':
description: Invalid telephone number object supplied
'404':
description: Error
/v2/partition/{partitionId}/telephonenumber/statussearch:
get:
tags:
- Telephone Number
summary: Telephone number status search
description: Use to search for the status of a telephone number
operationId: statusSearch
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: dateType
in: query
description: Type of data
required: false
schema:
type: string
enum:
- FOCDate
- UpdatedDate
- CreatedDate
- name: startDate
in: query
description: Start date
required: false
schema:
type: string
- name: endDate
in: query
description: End date
required: false
schema:
type: string
- name: statusType
in: query
description: Status type
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- PENDING
- IN_PROGRESS
- REJECTED
- FOC_RECEIVED
- FOC_REMOVED
- CANCELLED
- CANCEL_PENDING
- CARRIER_CANCELLED
- DELETE_PENDING
- DELETE_SCHEDULED
- COMPLETED
- CORRECTED_COMPLETED
- COOLDOWN
- HOT_CUT_PORT
- ON_HOLD
- RESELLER_PENDING
- name: eventType
in: query
description: Service activation event type
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- PORT_REQUEST
- CSR_CHANGE_REQUEST
- ACTIVATION
- NINE_ONE_ONE_ADDRESS
- DISCONNECT
- DYNAMIC_RESERVATION
- BYOTN_REQUEST
- SERVICE_PROVIDER_TN
- name: accountId
in: query
description: Account ID
required: false
schema:
type: string
- name: telephoneNumber
in: query
description: Telephone number
required: false
schema:
type: string
- name: firstResultIndex
in: query
description: First result index
required: false
schema:
type: integer
format: int32
default: 0
- name: maxResult
in: query
description: Max results
required: false
schema:
type: integer
format: int32
default: 50
responses:
'200':
description: successful operation
responseSchema:
originalRef: ServiceActivationEventResponseX
$ref: '#/components/schemas/ServiceActivationEventResponseX_2'
content:
application/json:
schema:
originalRef: ServiceActivationEventResponseX
$ref: '#/components/schemas/ServiceActivationEventResponseX_2'
'400':
description: Invalid search term supplied
'404':
description: Error
responsesObject:
'200':
description: successful operation
responseSchema:
originalRef: ServiceActivationEventResponseX
$ref: '#/components/schemas/ServiceActivationEventResponseX_2'
schema:
originalRef: ServiceActivationEventResponseX
$ref: '#/components/schemas/ServiceActivationEventResponseX_2'
'400':
description: Invalid search term supplied
'404':
description: Error
/v2/partition/{partitionId}/telephonenumber/{tn}/fmfmcheck:
get:
tags:
- Telephone Number
operationId: isTnOffNet
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: tn
in: path
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
responseSchema:
type: boolean
content:
application/json:
schema:
type: boolean
responsesObject:
'200':
description: successful operation
headers: {}
responseSchema:
type: boolean
schema:
type: boolean
/v2/partition/{partitionId}/telephonenumber/export:
get:
tags:
- Telephone Number
operationId: getInventoryPlan
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
responseSchema:
type: string
content:
text/csv:
schema:
type: string
responsesObject:
'200':
description: successful operation
headers: {}
responseSchema:
type: string
schema:
type: string
/v2/partition/{partitionId}/telephonenumber/export_2:
get:
tags:
- Telephone Number
summary: Export telephone numbers as csv
description: ''
operationId: getInventoryPlan2
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
content:
application/json:
schema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
'202':
description: Use Jobs API to check status
responsesObject:
'200':
description: successful operation
responseSchema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
schema:
originalRef: Job
$ref: '#/components/schemas/Job_2'
'202':
description: Use Jobs API to check status
/v2/partition/{partitionId}/account/{accountId}/telephonenumber/{tn}:
get:
tags:
- Telephone Number
summary: Retrieve a telephone number on an account
description: Use to retrieve a specific telephone number on an account
operationId: retrieveTelephoneNumberOnAccount
parameters:
- name: X-AUTH-TOKEN
in: header
required: false
schema:
type: string
- name: partitionId
in: path
description: ID of partition
required: true
schema:
type: string
- name: accountId
in: path
description: ID of account
required: true
schema:
type: string
- name: tn
in: path
description: Telephone number
required: true
schema:
type: string
responses:
'200':
description: successful operation
responseSchema:
originalRef: TelephoneNumberAccountV2X
$ref: '#/components/schemas/TelephoneNumberAccountV2X_2'
co
# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/alianza/refs/heads/main/openapi/alianza-telephone-number-api-openapi.yml