Skip to main content

List all port requests

GET 
/origination/porting/port_requests

Returns a list of your port requests.

Request ​

Query Parameters

    page integer

    Default value: 1

    Page number of results to load

    per_page integer

    Default value: 20

    Number of results per page

    search string

    Filter results by support_key (pr_*) or partial phone number

    status string

    Possible values: [incomplete, complete]

    Filter results by status

    include_phone_numbers boolean

    Default value: true

    Include phone number objects in the results

    include_sub_requests boolean

    Include sub request objects in the results

Responses ​

200: Port Requests Response

Response Headers

  • Total

    integer

    Total number of results

  • Total-Pages

    integer

    Total number of pages

Schema

  • Array [

    • id stringrequired

    phone_numbers

    undefined[]

    Phone numbers associated with this port request

  • Array [

    • phone_number stringrequired

    E164 formatted phone number

    svtype stringrequired

    Service type of the phone number. '0' for wireline, '1' for wireless and '2' for VOIP

    carrier_name stringrequired

    Name of underlying carrier

    coverage_category stringrequired

    Possible values: [nanp_generic, nanp_toll_free]

    Category of phone number

    sub_request_id stringrequired

    Id of associated sub request

    sub_request_status stringrequired

    Status of associated sub request. If no associated sub request this field will be null

    portability_status stringrequired

    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

    support_key stringrequired

    Key to reference when contacting Telnyx support

    created_at stringrequired

    ISO 8601 formatted date indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date indicating when the resource was updated.

    phone_number_counts_by_status

    object[]

    required

  • Array [

    • status stringrequired

    Possible values: [unassigned, in-process, submitted, exception, foc-date-confirmed, ported, cancelled, cancel-pending]

    Sub request status

    count integerrequired

    Count of phone numbers with this status

  • ]

    • sub_requests

    undefined[]

  • Array [

    • id stringrequired

    phone_numbers

    undefined[]

    Phone numbers associated with this port request

  • Array [

    • phone_number stringrequired

    E164 formatted phone number

    svtype stringrequired

    Service type of the phone number. '0' for wireline, '1' for wireless and '2' for VOIP

    carrier_name stringrequired

    Name of underlying carrier

    coverage_category stringrequired

    Possible values: [nanp_generic, nanp_toll_free]

    Category of phone number

    sub_request_id stringrequired

    Id of associated sub request

    sub_request_status stringrequired

    Status of associated sub request. If no associated sub request this field will be null

    portability_status stringrequired

    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

    foc_date stringrequired

    ISO 8601 formatted Date/Time of the FOC date

    status stringrequired

    Possible values: [unassigned, in-process, submitted, exception, foc-date-confirmed, ported, cancelled, cancel-pending]

    Status of sub request

    support_key stringrequired

    Key to reference when contacting Telnyx support

    phone_number_count integerrequired

    Number of phone numbers attached to this sub request

    underlying_carrier_names string[]

    Names of underlying carriers for phone numbers on this sub request

    foc_date_requested_by_user stringrequired

    ISO 8601 formatted Date/Time requested for the FOC date

    person_or_company_name stringrequired

    Person Name or Company name requesting the port

    auth_person_name stringrequired

    Name of person authorizing the port request

    billing_phone_number stringrequired

    Billing phone number associated with these phone numbers

    street_address stringrequired

    First line of billing address

    extended_address stringrequired

    Second line of billing address

    locality stringrequired

    City of billing address

    administrative_area stringrequired

    Two character state abbreviation of billing address

    postal_code stringrequired

    Postal Code of billing address

    country_code stringrequired

    ISO3166-1 alpha-2 country code of billing address

    created_at stringrequired

    ISO 8601 formatted date indicating when the resource was created.

    updated_at stringrequired

    ISO 8601 formatted date indicating when the resource was updated.

    default_connection_id stringrequired

    Identifies the connection to set on the numbers when the port completes

    default_message_profile_id stringrequired

    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.

    type stringrequired

    Possible values: [partial, full]

    A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted.

    remaining_numbers_action stringrequired

    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_phone_number stringrequired

    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 stringrequired

    PIN/passcode for accounts that have wireless type numbers

    account_number stringrequired

    The authorized person's account number with the current service provider

    description stringrequired

    Description of draft sub request

    tax_identifier stringrequired

    European tax identification number. Applicable only in the European Union

    business_identifier stringrequired

    European business identification number. Applicable only in the European Union

    customer_rating integer

    Once a sub request is ported, cancellation is requested or the sub request is cancelled, the user may rate their experience

    customer_rating_comment string

    A comment related to the customer rating.

  • ]

  • ]

401: Unauthorized

Request samples

curl -L 'https://api.telnyx.com/origination/porting/port_requests' \
-H 'Accept: application/json'

Response samples

[
  {
    "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"
      }
    ]
  }
]