Retrieves the details of an existing porting order.
643 matches
100 actions
Telnyx
100 actions
- Fetch message body by id.GETv1.0.0
- Get a credentialGETv1.0.0
- Get a Private Wireless GatewayGETv1.0.0
- Get a Wireless Detail Record (WDR) ReportGETv1.0.0
- Get all outbound voice profilesGETv1.0.0
- Get all Private Wireless GatewaysGETv1.0.0
- Get all Wireless Detail Records (WDRs) ReportsGETv1.0.0
- Get OTA updateGETv1.0.0
- Get UserGETv1.0.0
- getCdrRequestsGETv1.0.0
- getMdrRequestGETv1.0.0
- getRequestGETv1.0.0
- getRequestsGETv1.0.0
- getUsageAggregationsSyncGETv1.0.0
- getUsageReportGETv1.0.0
- getUsageReportsGETv1.0.0
- getUsageReportSyncGETv1.0.0
- getUsageReportSync_1GETv1.0.0
- List all addressesGETv1.0.0
- List all billing groupsGETv1.0.0
- List all comments for a portout requestGETv1.0.0
- List all comments of a porting orderGETv1.0.0
- List all credentialsGETv1.0.0
- List all document linksGETv1.0.0
- List all documentsGETv1.0.0
- List all exception typesGETv1.0.0
- List all Fax ApplicationsGETv1.0.0
- List all Notifications EventsGETv1.0.0
- List all Notifications Events ConditionsGETv1.0.0
- List all Notifications ProfilesGETv1.0.0
- List all porting activation jobsGETv1.0.0
- List all porting phone numbersGETv1.0.0
- List all requirement typesGETv1.0.0
- List all requirementsGETv1.0.0
- List all SSO authentication providersGETv1.0.0
- List all tagsGETv1.0.0
- List all TeXML ApplicationsGETv1.0.0
- List all Verify profilesGETv1.0.0
- List call control applicationsGETv1.0.0
- List call eventsGETv1.0.0
- List conference participantsGETv1.0.0
- List conferencesGETv1.0.0
- List connectionsGETv1.0.0
- List credential connectionsGETv1.0.0
- List FQDN connectionsGETv1.0.0
- List FQDNsGETv1.0.0
- List Ip connectionsGETv1.0.0
- List IpsGETv1.0.0
- List messaging hosted number ordersGETv1.0.0
- List messaging profile metricsGETv1.0.0
- List messaging profilesGETv1.0.0
- List messaging URL domainsGETv1.0.0
- List notification channelsGETv1.0.0
- List notification settingsGETv1.0.0
- List number block ordersGETv1.0.0
- List number order documentsGETv1.0.0
- List number reservationsGETv1.0.0
- List OTA updatesGETv1.0.0
- List phone numbers associated with a messaging profileGETv1.0.0
- List phone numbers with messaging settingsGETv1.0.0
- List phone numbers with voice settingsGETv1.0.0
- List recordingsGETv1.0.0
- List short codesGETv1.0.0
- List short codes associated with a messaging profileGETv1.0.0
- List sub number ordersGETv1.0.0
- List verifications by phone numberGETv1.0.0
- Lists accounts managed by the current user.GETv1.0.0
- Lists the phone number blocks jobsGETv1.0.0
- Lists the phone numbers jobsGETv1.0.0
- Retrieve a billing groupGETv1.0.0
- Retrieve a call control applicationGETv1.0.0
- Retrieve a call from a queueGETv1.0.0
- Retrieve a call queueGETv1.0.0
- Retrieve a call statusGETv1.0.0
- Retrieve a commentGETv1.0.0
- Retrieve a conferenceGETv1.0.0
- Retrieve a connectionGETv1.0.0
- Retrieve a credential connectionGETv1.0.0
- Retrieve a documentGETv1.0.0
- Retrieve a document requirementGETv1.0.0
- Retrieve a Fax ApplicationGETv1.0.0
- Retrieve a ledger billing group reportGETv1.0.0
- Retrieve a list of portout requestsGETv1.0.0
- Retrieve a managed accountGETv1.0.0
- Retrieve a porting activation jobGETv1.0.0
- Retrieve a porting orderGETv1.0.0
- Retrieve a portout requestGETv1.0.0
- Retrieve a requirement typesGETv1.0.0
- Retrieve a TeXML ApplicationGETv1.0.0
- Retrieve all commentsGETv1.0.0
- Retrieve an addressGETv1.0.0
- Retrieve an authentication providerGETv1.0.0
- Retrieve an FQDNGETv1.0.0
- Retrieve an FQDN connectionGETv1.0.0
- Retrieve an IpGETv1.0.0
- Retrieve an Ip connectionGETv1.0.0
- Retrieve calls from a queueGETv1.0.0
- Retrieve stored mediaGETv1.0.0
- Retrieve user balance detailsGETv1.0.0
- Retrieve your inbound channelsGETv1.0.0
Other/Telnyx
Retrieve a porting order
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"include_phone_numbers": {
"type": "boolean"
}
},
"required": [
"id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"activation_settings": {
"type": "object",
"properties": {
"activation_status": {
"type": "string",
"description": "Activation status",
"enum": [
"New",
"Pending",
"Conflict",
"Cancel Pending",
"Failed",
"Concurred",
"Activate RDY",
"Disconnect Pending",
"Concurrence Sent",
"Old",
"Sending",
"Active",
"Canceled"
]
},
"fast_port_eligible": {
"type": "boolean",
"description": "Indicates whether this porting order is eligible for FastPort"
},
"foc_datetime_actual": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 formatted Date/Time of the FOC date"
},
"foc_datetime_requested": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 formatted Date/Time requested for the FOC date"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 formatted date indicating when the resource was created."
},
"end_user": {
"type": "object",
"properties": {
"admin": {
"type": "object",
"properties": {
"account_number": {
"type": "string",
"description": "The authorized person's account number with the current service provider"
},
"auth_person_name": {
"type": "string",
"description": "Name of person authorizing the porting order"
},
"billing_phone_number": {
"type": "string",
"description": "Billing phone number associated with these phone numbers"
},
"business_identifier": {
"type": "string",
"description": "European business identification number. Applicable only in the European Union"
},
"entity_name": {
"type": "string",
"description": "Person Name or Company name requesting the port"
},
"pin_passcode": {
"type": "string",
"description": "PIN/passcode possibly required by the old service provider for extra verification"
},
"tax_identifier": {
"type": "string",
"description": "European tax identification number. Applicable only in the European Union"
}
}
},
"location": {
"type": "object",
"properties": {
"administrative_area": {
"type": "string",
"description": "State, province, or similar of billing address"
},
"country_code": {
"type": "string",
"description": "ISO3166-1 alpha-2 country code of billing address"
},
"extended_address": {
"type": "string",
"description": "Second line of billing address"
},
"locality": {
"type": "string",
"description": "City or municipality of billing address"
},
"postal_code": {
"type": "string",
"description": "Postal Code of billing address"
},
"street_address": {
"type": "string",
"description": "First line of billing address"
}
}
}
}
},
"id": {
"type": "string",
"format": "uuid",
"description": "Uniquely identifies this porting order"
},
"misc": {
"type": "object",
"properties": {
"new_billing_phone_number": {
"type": "string",
"description": "New billing phone number for the remaining numbers. Used in case the current billing phone number is being ported to Telnyx. This will be set on your account with your current service provider and should be one of the numbers remaining on that account."
},
"remaining_numbers_action": {
"type": "string",
"description": "Remaining numbers can be either kept with their current service provider or disconnected. 'new_billing_telephone_number' is required when 'remaining_numbers_action' is 'keep'.",
"enum": [
"keep",
"disconnect"
]
},
"type": {
"type": "string",
"description": "A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted.",
"enum": [
"full",
"partial"
]
}
}
},
"old_service_provider_ocn": {
"type": "string",
"description": "Identifies the old service provider"
},
"phone_number_configuration": {
"type": "object",
"properties": {
"connection_id": {
"type": "string",
"description": "identifies the connection to set on the numbers when ported"
},
"emergency_address_id": {
"type": "string",
"description": "identifies the emergency address to set on the numbers when ported"
},
"messaging_profile_id": {
"type": "string",
"description": "identifies the messaging profile to set on the numbers when ported"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"description": "Tag to set on the numbers when ported"
}
}
}
},
"porting_phone_numbers_count": {
"type": "integer",
"description": "Count of phone numbers associated with this porting order"
},
"record_type": {
"type": "string",
"description": "Identifies the type of the resource."
},
"requirements": {
"type": "array",
"description": "List of documentation requirements for porting numbers.",
"items": {
"type": "object",
"properties": {
"field_type": {
"type": "string",
"description": "Type of value expected on field_value field",
"enum": [
"document"
]
},
"field_value": {
"type": "string",
"description": "identifies the document that satisfies this requirement"
},
"record_type": {
"type": "string",
"description": "Identifies the type of the resource."
},
"requirement_type_id": {
"type": "string",
"description": "Identifies the requirement type that meets this requirement"
}
}
}
},
"status": {
"type": "object",
"description": "Porting order status",
"properties": {
"details": {
"type": "array",
"description": "A list of 0 or more details about this porting order's status",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Identifier of an exception type",
"enum": [
"ACCOUNT_NUMBER_MISMATCH",
"AUTH_PERSON_MISMATCH",
"BTN_ATN_MISMATCH",
"ENTITY_NAME_MISMATCH",
"FOC_EXPIRED",
"FOC_REJECTED",
"LOCATION_MISMATCH",
"LSR_PENDING",
"MAIN_BTN_PORTING",
"OSP_IRRESPONSIVE",
"OTHER",
"PASSCODE_PIN_INVALID",
"PHONE_NUMBER_HAS_SPECIAL_FEATURE",
"PHONE_NUMBER_MISMATCH",
"PHONE_NUMBER_NOT_PORTABLE",
"PORT_TYPE_INCORRECT",
"PORTING_ORDER_SPLIT_REQUIRED",
"PORTING_ORDER_SPLIT_REQUIRED",
"POSTAL_CODE_MISMATCH",
"RATE_CENTER_NOT_PORTABLE",
"SV_CONFLICT",
"SV_UNKNOWN_FAILURE"
]
},
"description": {
"type": "string",
"description": "Description of an exception type"
}
}
}
},
"value": {
"type": "string",
"description": "The current status of the porting order",
"enum": [
"draft",
"in-process",
"submitted",
"exception",
"foc-date-confirmed",
"ported",
"canceled",
"cancel-pending"
]
}
}
},
"support_key": {
"type": "string",
"description": "A key to reference this porting order when contacting Telnyx customer support"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 formatted date indicating when the resource was created."
},
"user_feedback": {
"type": "object",
"properties": {
"user_comment": {
"type": "string",
"description": "A comment related to the customer rating."
},
"user_rating": {
"type": "integer",
"description": "Once an order is ported, cancellation is requested or the request is canceled, the user may rate their experience"
}
}
},
"user_reference": {
"type": "string",
"description": "A customer-specified reference number for customer bookkeeping purposes"
},
"webhook_url": {
"type": "string",
"format": "uri"
}
}
},
"meta": {
"type": "object",
"properties": {
"phone_numbers_url": {
"type": "string",
"description": "Link to list all phone numbers"
}
}
}
}
}