{ "opencollection": "1.0.0", "info": { "name": "Telnyx Access Tokens Porting Orders API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Porting Orders", "type": "folder" }, "items": [ { "info": { "name": "List all porting events", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/events", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[type], filter[porting_order_id], filter[created_at][gte], filter[created_at][lte]" } ] }, "docs": "Returns a list of all porting events." }, { "info": { "name": "Show a porting event", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/events/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the porting event." } ] }, "docs": "Show a specific porting event." }, { "info": { "name": "Republish a porting event", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting/events/:id/republish", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the porting event." } ] }, "docs": "Republish a specific porting event." }, { "info": { "name": "List LOA configurations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/loa_configurations", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "List the LOA configurations." }, { "info": { "name": "Create a LOA configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting/loa_configurations", "body": { "type": "json", "data": "{}" } }, "docs": "Create a LOA configuration." }, { "info": { "name": "Preview the LOA configuration parameters", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting/loa_configurations/preview", "body": { "type": "json", "data": "{}" } }, "docs": "Preview the LOA template that would be generated without need to create LOA configuration." }, { "info": { "name": "Retrieve a LOA configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/loa_configurations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a LOA configuration." } ] }, "docs": "Retrieve a specific LOA configuration." }, { "info": { "name": "Update a LOA configuration", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/porting/loa_configurations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a LOA configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific LOA configuration." }, { "info": { "name": "Delete a LOA configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting/loa_configurations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a LOA configuration." } ] }, "docs": "Delete a specific LOA configuration." }, { "info": { "name": "Preview a LOA configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/loa_configurations/:id/preview", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a LOA configuration." } ] }, "docs": "Preview a specific LOA configuration." }, { "info": { "name": "List porting related reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/reports", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]" } ] }, "docs": "List the reports generated about porting operations." }, { "info": { "name": "Create a porting related report", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting/reports", "body": { "type": "json", "data": "{}" } }, "docs": "Generate reports about porting operations." }, { "info": { "name": "Retrieve a report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/reports/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a report." } ] }, "docs": "Retrieve a specific report generated." }, { "info": { "name": "List available carriers in the UK", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/uk_carriers" }, "docs": "List available carriers in the UK." }, { "info": { "name": "List all porting orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "include_phone_numbers", "value": "", "type": "query", "description": "Include the first 50 phone number objects in the results" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[customer_reference], filter[customer_group_reference], filter[parent_support_key], filter[phone_numbers.country_code], filter[phone_numbers.carrier_name], filter[misc.type], filter[end_user.admin.entity_name], filter[end_user.admin.auth_person_name], filter[activation_settings.fast_port_eligible], filter[activation_settings.foc_datetime_requested][gt], filter[activation_settings.foc_datetime_requested][lt], filter[phone_numbers.phone_number][contains]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of your porting order." }, { "info": { "name": "Create a porting order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new porting order object." }, { "info": { "name": "List all exception types", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/exception_types" }, "docs": "Returns a list of all possible exception types for a porting order." }, { "info": { "name": "List all phone number configurations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/phone_number_configurations", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[porting_order.status][in][], filter[porting_phone_number][in][], filter[user_bundle_id][in][]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of phone number configurations paginated." }, { "info": { "name": "Create a list of phone number configurations", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/phone_number_configurations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of phone number configurations." }, { "info": { "name": "Retrieve a porting order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "include_phone_numbers", "value": "", "type": "query", "description": "Include the first 50 phone number objects in the results" } ] }, "docs": "Retrieves the details of an existing porting order." }, { "info": { "name": "Edit a porting order", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/porting_orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits the details of an existing porting order.\n\nAny or all of a porting orders attributes may be included in the resource object included in a PATCH request.\n\nIf a request does not include all of the attributes for a resource, the system will interpret the missing attributes as if they were included with their current values. To explicitly set something to null, it must be included in the request with a null value." }, { "info": { "name": "Delete a porting order", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting_orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Deletes an existing porting order. This operation is restrict to porting orders in draft state." }, { "info": { "name": "Activate every number in a porting order asynchronously.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/actions/activate", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Activate each number in a porting order asynchronously. This operation is limited to US FastPort orders only." }, { "info": { "name": "Cancel a porting order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/actions/cancel", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Cancel a porting order" }, { "info": { "name": "Submit a porting order.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/actions/confirm", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Confirm and submit your porting order." }, { "info": { "name": "Share a porting order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/actions/share", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users." }, { "info": { "name": "List all porting activation jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/activation_jobs", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Returns a list of your porting activation jobs." }, { "info": { "name": "Retrieve a porting activation job", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/activation_jobs/:activationJobId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "activationJobId", "value": "", "type": "path", "description": "Activation Job Identifier" } ] }, "docs": "Returns a porting activation job." }, { "info": { "name": "Update a porting activation job", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/porting_orders/:id/activation_jobs/:activationJobId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "activationJobId", "value": "", "type": "path", "description": "Activation Job Identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the activation time of a porting activation job." }, { "info": { "name": "List additional documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/additional_documents", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[document_type]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of additional documents for a porting order." }, { "info": { "name": "Create a list of additional documents", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/additional_documents", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of additional documents for a porting order." }, { "info": { "name": "Delete an additional document", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting_orders/:id/additional_documents/:additional_document_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "additional_document_id", "value": "", "type": "path", "description": "Additional document identification." } ] }, "docs": "Deletes an additional document for a porting order." }, { "info": { "name": "List allowed FOC dates", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/allowed_foc_windows", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Returns a list of allowed FOC dates for a porting order." }, { "info": { "name": "List all comments of a porting order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/comments", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Returns a list of all comments of a porting order." }, { "info": { "name": "Create a comment for a porting order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/comments", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new comment for a porting order." }, { "info": { "name": "Download a porting order loa template", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/loa_template", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "loa_configuration_id", "value": "a36c2277-446b-4d11-b4ea-322e02a5c08d", "type": "query", "description": "The identifier of the LOA configuration to use for the template. If not provided, the default LOA configuration will be used." } ] }, "docs": "Download a porting order loa template" }, { "info": { "name": "List porting order requirements", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/requirements", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Returns a list of all requirements based on country/number type for this porting order." }, { "info": { "name": "Retrieve the associated V1 sub_request_id and port_request_id", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/sub_request", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Retrieve the associated V1 sub_request_id and port_request_id" }, { "info": { "name": "List verification codes", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/verification_codes", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[verified]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of verification codes for a porting order." }, { "info": { "name": "Send the verification codes", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/verification_codes/send", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Send the verification code for all porting phone numbers." }, { "info": { "name": "Verify the verification code for a list of phone numbers", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/verification_codes/verify", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verifies the verification code for a list of phone numbers." }, { "info": { "name": "List action requirements for a porting order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/action_requirements", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "The ID of the porting order" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[id][in][], filter[requirement_type_id], filter[action_type], filter[status]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of action requirements for a specific porting order." }, { "info": { "name": "Initiate an action requirement", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/action_requirements/:id/initiate", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "The ID of the porting order" }, { "name": "id", "value": "", "type": "path", "description": "The ID of the action requirement" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a specific action requirement for a porting order." }, { "info": { "name": "List all associated phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/associated_phone_numbers", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone numbers" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[action]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of all associated phone numbers for a porting order. Associated phone numbers are used for partial porting in GB to specify which phone numbers should be kept or disconnected." }, { "info": { "name": "Create an associated phone number", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/associated_phone_numbers", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new associated phone number for a porting order. This is used for partial porting in GB to specify which phone numbers should be kept or disconnected." }, { "info": { "name": "Delete an associated phone number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/associated_phone_numbers/:id", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number" }, { "name": "id", "value": "", "type": "path", "description": "Identifies the associated phone number to be deleted" } ] }, "docs": "Deletes an associated phone number from a porting order." }, { "info": { "name": "List all phone number blocks", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_blocks", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number blocks" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[porting_order_id], filter[support_key], filter[status], filter[phone_number], filter[activation_status], filter[portability_status]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of all phone number blocks of a porting order." }, { "info": { "name": "Create a phone number block", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_blocks", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number block" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new phone number block." }, { "info": { "name": "Delete a phone number block", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_blocks/:id", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number block" }, { "name": "id", "value": "", "type": "path", "description": "Identifies the phone number block to be deleted" } ] }, "docs": "Deletes a phone number block." }, { "info": { "name": "List all phone number extensions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_extensions", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number extensions" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[porting_phone_number_id]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of all phone number extensions of a porting order." }, { "info": { "name": "Create a phone number extension", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_extensions", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number extension" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new phone number extension." }, { "info": { "name": "Delete a phone number extension", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_extensions/:id", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number extension" }, { "name": "id", "value": "", "type": "path", "description": "Identifies the phone number extension to be deleted" } ] }, "docs": "Deletes a phone number extension." }, { "info": { "name": "List all porting phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_phone_numbers", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[porting_order_status]" } ] }, "docs": "Returns a list of your porting phone numbers." } ] } ], "bundled": true }