Skip to main content

Create a draft port request

POST 
/origination/porting/draft_port_requests

Creates a new draft port request object.

Request ​

Body

required

Draft port request to create

    phone_numbers

    undefined[]

    required

    List of phone numbers to port

  • Array [

    • phone_number stringrequired

    E164 formatted phone number

  • ]

    • List of phone numbers to port

Responses ​

201: Draft port request response

Schema

    id stringrequired
    created_at stringrequired

    ISO 8601 formatted date indicating when the resource was created.

    status stringrequired

    Possible values: [pending, submitted]

    Draft port request status

    phone_number_count integerrequired

    Count of phone numbers associated with this draft port request

    phone_numbers

    undefined[]

    Phone numbers associated with this draft 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

    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 draft port request

    sub_requests

    undefined[]

  • Array [

    • id stringrequired
    complete booleanrequired

    True if object contains all necessary information, otherwise false

    phone_numbers

    undefined[]

    Phone numbers associated with this sub 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

    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 sub request

    foc_date_requested_by_user stringrequired

    ISO 8601 formatted Date/Time requested for the FOC date

    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

    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.

    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

  • ]

    • port_request_id stringrequired

    ID the associated Port Request. This field is filled if the draft port request has been submitted.

401: Unauthorized

422: Unprocessable entity. Check message field in response for details.

Request samples

curl -L 'https://api.telnyx.com/origination/porting/draft_port_requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "phone_numbers": [
    {
      "phone_number": "string"
    }
  ]
}'

Response samples

{
  "id": "string",
  "created_at": "string",
  "status": "pending",
  "phone_number_count": 0,
  "phone_numbers": [
    {
      "phone_number": "string",
      "svtype": "string",
      "carrier_name": "string",
      "coverage_category": "nanp_generic",
      "sub_request_id": "string",
      "portability_status": "pending"
    }
  ],
  "sub_requests": [
    {
      "id": "string",
      "complete": true,
      "phone_numbers": [
        {
          "phone_number": "string",
          "svtype": "string",
          "carrier_name": "string",
          "coverage_category": "nanp_generic",
          "sub_request_id": "string",
          "portability_status": "pending"
        }
      ],
      "foc_date_requested_by_user": "string",
      "phone_number_count": 0,
      "underlying_carrier_names": [
        "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",
      "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"
    }
  ],
  "port_request_id": "string"
}