Report

Initiates the creation of a telephone number port out 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:

  • AccountNumber
  • AccountStatus
  • ActivatedDate
  • AddDate
  • Carrier
  • CarrierStatus
  • CooldownExpireDate
  • CooldownRecoveredDate
  • CsrCity
  • CsrPostalCode
  • CustomerType
  • DeletedDate
  • FunctionType
  • PartitionName
  • Port
  • PortCancelType
  • PortCompletionDate
  • PortOutDate
  • ServicePackageType
  • TelephoneNumber
  • TemporaryNumber
  • TollFree
get/v2/partition/{partitionId}/report/portout/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.