Retrieve a port request
GET/origination/porting/port_requests/:id
Retrieves the details of an existing port request.
Request
Path Parameters
Port Request id
Query Parameters
Default value: true
Include phone number objects in the results
Include sub request objects in the results
Responses
200: Port Request Response
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
Array [
]
]
phone_numbers
undefined[]
Phone numbers associated with this port request
E164 formatted phone number
Service type of the phone number. '0' for wireline, '1' for wireless and '2' for VOIP
Name of underlying carrier
Possible values: [nanp_generic, nanp_toll_free]
Category of phone number
Id of associated sub request
Status of associated sub request. If no associated sub request this field will be null
Possible values: [pending, confirmed, provisional]
Specifies whether Telnyx was able to confirm portability for the rate center for this number
Phone numbers associated with this port request
Key to reference when contacting Telnyx support
ISO 8601 formatted date indicating when the resource was created.
ISO 8601 formatted date indicating when the resource was updated.
phone_number_counts_by_status
object[]
required
Possible values: [unassigned, in-process, submitted, exception, foc-date-confirmed, ported, cancelled, cancel-pending]
Sub request status
Count of phone numbers with this status
sub_requests
undefined[]
phone_numbers
undefined[]
Phone numbers associated with this port request
E164 formatted phone number
Service type of the phone number. '0' for wireline, '1' for wireless and '2' for VOIP
Name of underlying carrier
Possible values: [nanp_generic, nanp_toll_free]
Category of phone number
Id of associated sub request
Status of associated sub request. If no associated sub request this field will be null
Possible values: [pending, confirmed, provisional]
Specifies whether Telnyx was able to confirm portability for the rate center for this number
Phone numbers associated with this port request
ISO 8601 formatted Date/Time of the FOC date
Possible values: [unassigned, in-process, submitted, exception, foc-date-confirmed, ported, cancelled, cancel-pending]
Status of sub request
Key to reference when contacting Telnyx support
Number of phone numbers attached to this sub request
Names of underlying carriers for phone numbers on this sub request
ISO 8601 formatted Date/Time requested for the FOC date
Person Name or Company name requesting the port
Name of person authorizing the port request
Billing phone number associated with these phone numbers
First line of billing address
Second line of billing address
City of billing address
Two character state abbreviation of billing address
Postal Code of billing address
ISO3166-1 alpha-2 country code of billing address
ISO 8601 formatted date indicating when the resource was created.
ISO 8601 formatted date indicating when the resource was updated.
Identifies the connection to set on the numbers when the port completes
Identifies the messaging profile to set on the numbers when the port completes
porting_option
object
required
Options for the processing of numbers with your current service provider.
Possible values: [partial, full]
A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted.
Possible values: [keep, disconnect]
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'.
New billing telephone numbers for the remaining numbers. This will be set on your account with your current service provider and should be one of the numbers remaining on that account.
Options for the processing of numbers with your current service provider.
PIN/passcode for accounts that have wireless type numbers
The authorized person's account number with the current service provider
Description of draft sub request
European tax identification number. Applicable only in the European Union
European business identification number. Applicable only in the European Union
Once a sub request is ported, cancellation is requested or the sub request is cancelled, the user may rate their experience
A comment related to the customer rating.
{
"id": "string",
"phone_numbers": [
{
"phone_number": "string",
"svtype": "string",
"carrier_name": "string",
"coverage_category": "nanp_generic",
"sub_request_id": "string",
"sub_request_status": "string",
"portability_status": "pending"
}
],
"support_key": "string",
"created_at": "string",
"updated_at": "string",
"phone_number_counts_by_status": [
{
"status": "unassigned",
"count": 0
}
],
"sub_requests": [
{
"id": "string",
"phone_numbers": [
{
"phone_number": "string",
"svtype": "string",
"carrier_name": "string",
"coverage_category": "nanp_generic",
"sub_request_id": "string",
"sub_request_status": "string",
"portability_status": "pending"
}
],
"foc_date": "string",
"status": "unassigned",
"support_key": "string",
"phone_number_count": 0,
"underlying_carrier_names": [
"string"
],
"foc_date_requested_by_user": "string",
"person_or_company_name": "string",
"auth_person_name": "string",
"billing_phone_number": "string",
"street_address": "string",
"extended_address": "string",
"locality": "string",
"administrative_area": "string",
"postal_code": "string",
"country_code": "string",
"created_at": "string",
"updated_at": "string",
"default_connection_id": "string",
"default_message_profile_id": "string",
"porting_option": {
"type": "partial",
"remaining_numbers_action": "keep",
"new_billing_phone_number": "string"
},
"pin_passcode": "string",
"account_number": "string",
"description": "string",
"tax_identifier": "string",
"business_identifier": "string",
"customer_rating": 0,
"customer_rating_comment": "string"
}
]
}
401: Unauthorized
404: Resource not found
422: Unprocessable entity. Check message field in response for details.