Report

Initiates the creation of a telephone number report CSV

Creates an <a href="#/~schema/Job">asynchronous job</a> that generates a CSV file for download. <span hidden>Please refer to <a href="jobs.html#monitor-job-progress">monitoring job progress</a> and <a href="jobs.html#get-job-output">retrieving job output</a> for instructions on retrieving the report.</span>

The CSV headers are:

  • TelephoneNumber
  • AccountNumber
  • AccountStatus
  • ActivatedDate
  • AddDate
  • Carrier
  • CarrierStatus
  • CooldownExpireDate
  • CooldownRecoveredDate
  • CustomerType
  • DeletedDate
  • DirectoryListingType
  • FunctionType
  • ParentPartitionName
  • PartitionName
  • Port
  • PortCancelType
  • PortCompletionDate
  • PortOutDate
  • RateCenterName
  • RateCenterState
  • ServicePackageType
  • TemporaryNumber
  • TollFree
  • 911first_name
  • 911last_name
  • 911business_name
  • 911street_number
  • 911street_number_suffix
  • 911street_name
  • 911street_suffix
  • 911state
  • 911country
  • 911postal_code
  • 911pre_directional
  • 911post_directional
  • 911city
  • 911latitude
  • 911longitude
  • 911first_name_secondary
  • 911secondary_location_description
  • 911middle_initial
  • 911unit
  • CSRfirst_name
  • CSRlast_name
  • CSRbusiness_name
  • CSRstreet_number
  • CSRstreet_number_suffix
  • CSRstreet_name
  • CSRstreet_suffix
  • CSRstate
  • CSRcountry
  • CSRpostal_code
  • CSRpre_directional
  • CSRpost_directional
  • CSRcity
  • CSRlatitude
  • CSRlongitude
  • CSRfirst_name_secondary
  • CSRsecondary_location_description
  • CSRmiddle_initial
  • CSRunit
get/v2/partition/{partitionId}/report/tn/csv_2

Request

Path parameters

partitionIdstring required

ID of partition. Refers to <a href="#/~schema/PartitionX">partition.id</a>

Query parameters

monthinteger required

Month (Value between 1 and 12)

yearinteger required

4-digit year

Response

Use Jobs API to check status

idstring
namestring
userIdstring
status'PENDING' | 'IN_PROGRESS' | 'DONE' | 'FAILED'
inputKeystring
outputKeystring
startstring date-time
lastUpdatedstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.