naftiko: 1.0.0-alpha2 info: label: Telnyx API — Porting Orders description: 'Telnyx API — Porting Orders. 53 operations. Lead operation: List all porting events. Self-contained Naftiko capability covering one Telnyx business surface.' tags: - Telnyx - Porting Orders created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: TELNYX_API_KEY: TELNYX_API_KEY capability: consumes: - type: http namespace: telnyx-porting-orders baseUri: https://api.telnyx.com/v2 description: Telnyx API — Porting Orders business capability. Self-contained, no shared references. resources: - name: porting-events path: /porting/events operations: - name: listportingevents method: GET description: List all porting events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: filter in: query type: object description: 'Consolidated filter parameter (deepObject style). Originally: filter[type], filter[porting_order_id], filter[created_at][gte], filter[created_at][lte]' - name: porting-events-id path: /porting/events/{id} operations: - name: showportingevent method: GET description: Show a porting event outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Identifies the porting event. required: true - name: porting-events-id-republish path: /porting/events/{id}/republish operations: - name: republishportingevent method: POST description: Republish a porting event outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Identifies the porting event. required: true - name: porting-loa_configurations path: /porting/loa_configurations operations: - name: listloaconfigurations method: GET description: List LOA configurations outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createloaconfiguration method: POST description: Create a LOA configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: porting-loa_configurations-preview path: /porting/loa_configurations/preview operations: - name: previewloaconfigurationparams method: POST description: Preview the LOA configuration parameters outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: porting-loa_configurations-id path: /porting/loa_configurations/{id} operations: - name: deleteloaconfiguration method: DELETE description: Delete a LOA configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Identifies a LOA configuration. required: true - name: getloaconfiguration method: GET description: Retrieve a LOA configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Identifies a LOA configuration. required: true - name: updateloaconfiguration method: PATCH description: Update a LOA configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Identifies a LOA configuration. required: true - name: body in: body type: object description: Request body (JSON). required: false - name: porting-loa_configurations-id-preview path: /porting/loa_configurations/{id}/preview operations: - name: previewloaconfiguration method: GET description: Preview a LOA configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Identifies a LOA configuration. required: true - name: porting-reports path: /porting/reports operations: - name: listportingreports method: GET description: List porting related reports outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: filter in: query type: object description: 'Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]' - name: createportingreport method: POST description: Create a porting related report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: porting-reports-id path: /porting/reports/{id} operations: - name: getportingreport method: GET description: Retrieve a report outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Identifies a report. required: true - name: porting-uk_carriers path: /porting/uk_carriers operations: - name: listportingukcarriers method: GET description: List available carriers in the UK outputRawFormat: json outputParameters: - name: result type: object value: $. - name: porting_orders path: /porting_orders operations: - name: listportingorders method: GET description: List all porting orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: filter in: query type: object description: 'Consolidated filter parameter (deepObject style). Originally: filter[customer_reference], filter[customer_group_reference], filter[parent_support_key], filter[p' - name: sort in: query type: object description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' - name: createportingorder method: POST description: Create a porting order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: porting_orders-exception_types path: /porting_orders/exception_types operations: - name: listexceptiontypes method: GET description: List all exception types outputRawFormat: json outputParameters: - name: result type: object value: $. - name: porting_orders-phone_number_configurations path: /porting_orders/phone_number_configurations operations: - name: listphonenumberconfigurations method: GET description: List all phone number configurations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: filter in: query type: object description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_order.status][in][], filter[porting_phone_number][in][], filter[user_bundle_id][in]' - name: sort in: query type: object description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' - name: createphonenumberconfigurations method: POST description: Create a list of phone number configurations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: porting_orders-id path: /porting_orders/{id} operations: - name: deleteportingorder method: DELETE description: Delete a porting order outputRawFormat: json outputParameters: - name: result type: object value: $. - name: getportingorder method: GET description: Retrieve a porting order outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateportingorder method: PATCH description: Edit a porting order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: porting_orders-id-actions-activate path: /porting_orders/{id}/actions/activate operations: - name: activateportingorder method: POST description: Activate every number in a porting order asynchronously. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: porting_orders-id-actions-cancel path: /porting_orders/{id}/actions/cancel operations: - name: cancelportingorder method: POST description: Cancel a porting order outputRawFormat: json outputParameters: - name: result type: object value: $. - name: porting_orders-id-actions-confirm path: /porting_orders/{id}/actions/confirm operations: - name: confirmportingorder method: POST description: Submit a porting order. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: porting_orders-id-actions-share path: /porting_orders/{id}/actions/share operations: - name: shareportingorder method: POST description: Share a porting order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: porting_orders-id-activation_jobs path: /porting_orders/{id}/activation_jobs operations: - name: listportingorderactivationjobs method: GET description: List all porting activation jobs outputRawFormat: json outputParameters: - name: result type: object value: $. - name: porting_orders-id-activation_jobs-activationJobId path: /porting_orders/{id}/activation_jobs/{activationJobId} operations: - name: getportingordersactivationjob method: GET description: Retrieve a porting activation job outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateportingordersactivationjob method: PATCH description: Update a porting activation job outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: porting_orders-id-additional_documents path: /porting_orders/{id}/additional_documents operations: - name: listadditionaldocuments method: GET description: List additional documents outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: filter in: query type: object description: 'Consolidated filter parameter (deepObject style). Originally: filter[document_type]' - name: sort in: query type: object description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' - name: createadditionaldocuments method: POST description: Create a list of additional documents outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: porting_orders-id-additional_documents-additional_document_id path: /porting_orders/{id}/additional_documents/{additional_document_id} operations: - name: deleteadditionaldocument method: DELETE description: Delete an additional document outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: additional_document_id in: path type: string description: Additional document identification. required: true - name: porting_orders-id-allowed_foc_windows path: /porting_orders/{id}/allowed_foc_windows operations: - name: listallowedfocwindows method: GET description: List allowed FOC dates outputRawFormat: json outputParameters: - name: result type: object value: $. - name: porting_orders-id-comments path: /porting_orders/{id}/comments operations: - name: listportingordercomments method: GET description: List all comments of a porting order outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createportingordercomment method: POST description: Create a comment for a porting order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: porting_orders-id-loa_template path: /porting_orders/{id}/loa_template operations: - name: getportingorderloatemplate method: GET description: Download a porting order loa template outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loa_configuration_id in: query type: string description: The identifier of the LOA configuration to use for the template. If not provided, the default LOA configuration will be used. - name: porting_orders-id-requirements path: /porting_orders/{id}/requirements operations: - name: listportingorderrequirements method: GET description: List porting order requirements outputRawFormat: json outputParameters: - name: result type: object value: $. - name: porting_orders-id-sub_request path: /porting_orders/{id}/sub_request operations: - name: getportingordersubrequest method: GET description: Retrieve the associated V1 sub_request_id and port_request_id outputRawFormat: json outputParameters: - name: result type: object value: $. - name: porting_orders-id-verification_codes path: /porting_orders/{id}/verification_codes operations: - name: listverificationcodes method: GET description: List verification codes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: filter in: query type: object description: 'Consolidated filter parameter (deepObject style). Originally: filter[verified]' - name: sort in: query type: object description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' - name: porting_orders-id-verification_codes-send path: /porting_orders/{id}/verification_codes/send operations: - name: sendportingverificationcodes method: POST description: Send the verification codes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: porting_orders-id-verification_codes-verify path: /porting_orders/{id}/verification_codes/verify operations: - name: verifyportingverificationcodes method: POST description: Verify the verification code for a list of phone numbers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: false - name: porting_orders-porting_order_id-action_requirements path: /porting_orders/{porting_order_id}/action_requirements operations: - name: listportingactionrequirements method: GET description: List action requirements for a porting order outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: The ID of the porting order required: true - name: filter in: query type: object description: 'Consolidated filter parameter (deepObject style). Originally: filter[id][in][], filter[requirement_type_id], filter[action_type], filter[status]' - name: sort in: query type: object description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' - name: porting_orders-porting_order_id-action_requirements-id-initiate path: /porting_orders/{porting_order_id}/action_requirements/{id}/initiate operations: - name: initiateportingactionrequirement method: POST description: Initiate an action requirement outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: The ID of the porting order required: true - name: id in: path type: string description: The ID of the action requirement required: true - name: body in: body type: object description: Request body (JSON). required: false - name: porting_orders-porting_order_id-associated_phone_numbers path: /porting_orders/{porting_order_id}/associated_phone_numbers operations: - name: listportingassociatedphonenumbers method: GET description: List all associated phone numbers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: Identifies the Porting Order associated with the phone numbers required: true - name: filter in: query type: object description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[action]' - name: sort in: query type: object description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' - name: createportingassociatedphonenumber method: POST description: Create an associated phone number outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: Identifies the Porting Order associated with the phone number required: true - name: body in: body type: object description: Request body (JSON). required: false - name: porting_orders-porting_order_id-associated_phone_numbers-id path: /porting_orders/{porting_order_id}/associated_phone_numbers/{id} operations: - name: deleteportingassociatedphonenumber method: DELETE description: Delete an associated phone number outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: Identifies the Porting Order associated with the phone number required: true - name: id in: path type: string description: Identifies the associated phone number to be deleted required: true - name: porting_orders-porting_order_id-phone_number_blocks path: /porting_orders/{porting_order_id}/phone_number_blocks operations: - name: listportingphonenumberblocks method: GET description: List all phone number blocks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: Identifies the Porting Order associated with the phone number blocks required: true - name: sort in: query type: object description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' - name: createportingphonenumberblock method: POST description: Create a phone number block outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: Identifies the Porting Order associated with the phone number block required: true - name: body in: body type: object description: Request body (JSON). required: false - name: porting_orders-porting_order_id-phone_number_blocks-id path: /porting_orders/{porting_order_id}/phone_number_blocks/{id} operations: - name: deleteportingphonenumberblock method: DELETE description: Delete a phone number block outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: Identifies the Porting Order associated with the phone number block required: true - name: id in: path type: string description: Identifies the phone number block to be deleted required: true - name: porting_orders-porting_order_id-phone_number_extensions path: /porting_orders/{porting_order_id}/phone_number_extensions operations: - name: listportingphonenumberextensions method: GET description: List all phone number extensions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: Identifies the Porting Order associated with the phone number extensions required: true - name: filter in: query type: object description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_phone_number_id]' - name: sort in: query type: object description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' - name: createportingphonenumberextension method: POST description: Create a phone number extension outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: Identifies the Porting Order associated with the phone number extension required: true - name: body in: body type: object description: Request body (JSON). required: false - name: porting_orders-porting_order_id-phone_number_extensions-id path: /porting_orders/{porting_order_id}/phone_number_extensions/{id} operations: - name: deleteportingphonenumberextension method: DELETE description: Delete a phone number extension outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: porting_order_id in: path type: string description: Identifies the Porting Order associated with the phone number extension required: true - name: id in: path type: string description: Identifies the phone number extension to be deleted required: true - name: porting_phone_numbers path: /porting_phone_numbers operations: - name: listportingphonenumbers method: GET description: List all porting phone numbers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: filter in: query type: object description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_order_status]' authentication: type: bearer token: '{{env.TELNYX_API_KEY}}' exposes: - type: rest namespace: telnyx-porting-orders-rest port: 8080 description: REST adapter for Telnyx API — Porting Orders. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/porting/events name: porting-events description: REST surface for porting-events. operations: - method: GET name: listportingevents description: List all porting events call: telnyx-porting-orders.listportingevents with: filter: rest.filter outputParameters: - type: object mapping: $. - path: /v1/porting/events/{id} name: porting-events-id description: REST surface for porting-events-id. operations: - method: GET name: showportingevent description: Show a porting event call: telnyx-porting-orders.showportingevent with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/porting/events/{id}/republish name: porting-events-id-republish description: REST surface for porting-events-id-republish. operations: - method: POST name: republishportingevent description: Republish a porting event call: telnyx-porting-orders.republishportingevent with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/porting/loa-configurations name: porting-loa-configurations description: REST surface for porting-loa_configurations. operations: - method: GET name: listloaconfigurations description: List LOA configurations call: telnyx-porting-orders.listloaconfigurations outputParameters: - type: object mapping: $. - method: POST name: createloaconfiguration description: Create a LOA configuration call: telnyx-porting-orders.createloaconfiguration with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting/loa-configurations/preview name: porting-loa-configurations-preview description: REST surface for porting-loa_configurations-preview. operations: - method: POST name: previewloaconfigurationparams description: Preview the LOA configuration parameters call: telnyx-porting-orders.previewloaconfigurationparams with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting/loa-configurations/{id} name: porting-loa-configurations-id description: REST surface for porting-loa_configurations-id. operations: - method: DELETE name: deleteloaconfiguration description: Delete a LOA configuration call: telnyx-porting-orders.deleteloaconfiguration with: id: rest.id outputParameters: - type: object mapping: $. - method: GET name: getloaconfiguration description: Retrieve a LOA configuration call: telnyx-porting-orders.getloaconfiguration with: id: rest.id outputParameters: - type: object mapping: $. - method: PATCH name: updateloaconfiguration description: Update a LOA configuration call: telnyx-porting-orders.updateloaconfiguration with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting/loa-configurations/{id}/preview name: porting-loa-configurations-id-preview description: REST surface for porting-loa_configurations-id-preview. operations: - method: GET name: previewloaconfiguration description: Preview a LOA configuration call: telnyx-porting-orders.previewloaconfiguration with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/porting/reports name: porting-reports description: REST surface for porting-reports. operations: - method: GET name: listportingreports description: List porting related reports call: telnyx-porting-orders.listportingreports with: filter: rest.filter outputParameters: - type: object mapping: $. - method: POST name: createportingreport description: Create a porting related report call: telnyx-porting-orders.createportingreport with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting/reports/{id} name: porting-reports-id description: REST surface for porting-reports-id. operations: - method: GET name: getportingreport description: Retrieve a report call: telnyx-porting-orders.getportingreport with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/porting/uk-carriers name: porting-uk-carriers description: REST surface for porting-uk_carriers. operations: - method: GET name: listportingukcarriers description: List available carriers in the UK call: telnyx-porting-orders.listportingukcarriers outputParameters: - type: object mapping: $. - path: /v1/porting-orders name: porting-orders description: REST surface for porting_orders. operations: - method: GET name: listportingorders description: List all porting orders call: telnyx-porting-orders.listportingorders with: filter: rest.filter sort: rest.sort outputParameters: - type: object mapping: $. - method: POST name: createportingorder description: Create a porting order call: telnyx-porting-orders.createportingorder with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/exception-types name: porting-orders-exception-types description: REST surface for porting_orders-exception_types. operations: - method: GET name: listexceptiontypes description: List all exception types call: telnyx-porting-orders.listexceptiontypes outputParameters: - type: object mapping: $. - path: /v1/porting-orders/phone-number-configurations name: porting-orders-phone-number-configurations description: REST surface for porting_orders-phone_number_configurations. operations: - method: GET name: listphonenumberconfigurations description: List all phone number configurations call: telnyx-porting-orders.listphonenumberconfigurations with: filter: rest.filter sort: rest.sort outputParameters: - type: object mapping: $. - method: POST name: createphonenumberconfigurations description: Create a list of phone number configurations call: telnyx-porting-orders.createphonenumberconfigurations with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id} name: porting-orders-id description: REST surface for porting_orders-id. operations: - method: DELETE name: deleteportingorder description: Delete a porting order call: telnyx-porting-orders.deleteportingorder outputParameters: - type: object mapping: $. - method: GET name: getportingorder description: Retrieve a porting order call: telnyx-porting-orders.getportingorder outputParameters: - type: object mapping: $. - method: PATCH name: updateportingorder description: Edit a porting order call: telnyx-porting-orders.updateportingorder with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/actions/activate name: porting-orders-id-actions-activate description: REST surface for porting_orders-id-actions-activate. operations: - method: POST name: activateportingorder description: Activate every number in a porting order asynchronously. call: telnyx-porting-orders.activateportingorder outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/actions/cancel name: porting-orders-id-actions-cancel description: REST surface for porting_orders-id-actions-cancel. operations: - method: POST name: cancelportingorder description: Cancel a porting order call: telnyx-porting-orders.cancelportingorder outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/actions/confirm name: porting-orders-id-actions-confirm description: REST surface for porting_orders-id-actions-confirm. operations: - method: POST name: confirmportingorder description: Submit a porting order. call: telnyx-porting-orders.confirmportingorder outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/actions/share name: porting-orders-id-actions-share description: REST surface for porting_orders-id-actions-share. operations: - method: POST name: shareportingorder description: Share a porting order call: telnyx-porting-orders.shareportingorder with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/activation-jobs name: porting-orders-id-activation-jobs description: REST surface for porting_orders-id-activation_jobs. operations: - method: GET name: listportingorderactivationjobs description: List all porting activation jobs call: telnyx-porting-orders.listportingorderactivationjobs outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/activation-jobs/{activationjobid} name: porting-orders-id-activation-jobs-activationjobid description: REST surface for porting_orders-id-activation_jobs-activationJobId. operations: - method: GET name: getportingordersactivationjob description: Retrieve a porting activation job call: telnyx-porting-orders.getportingordersactivationjob outputParameters: - type: object mapping: $. - method: PATCH name: updateportingordersactivationjob description: Update a porting activation job call: telnyx-porting-orders.updateportingordersactivationjob with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/additional-documents name: porting-orders-id-additional-documents description: REST surface for porting_orders-id-additional_documents. operations: - method: GET name: listadditionaldocuments description: List additional documents call: telnyx-porting-orders.listadditionaldocuments with: filter: rest.filter sort: rest.sort outputParameters: - type: object mapping: $. - method: POST name: createadditionaldocuments description: Create a list of additional documents call: telnyx-porting-orders.createadditionaldocuments with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/additional-documents/{additional-document-id} name: porting-orders-id-additional-documents-additional-document-id description: REST surface for porting_orders-id-additional_documents-additional_document_id. operations: - method: DELETE name: deleteadditionaldocument description: Delete an additional document call: telnyx-porting-orders.deleteadditionaldocument with: additional_document_id: rest.additional_document_id outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/allowed-foc-windows name: porting-orders-id-allowed-foc-windows description: REST surface for porting_orders-id-allowed_foc_windows. operations: - method: GET name: listallowedfocwindows description: List allowed FOC dates call: telnyx-porting-orders.listallowedfocwindows outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/comments name: porting-orders-id-comments description: REST surface for porting_orders-id-comments. operations: - method: GET name: listportingordercomments description: List all comments of a porting order call: telnyx-porting-orders.listportingordercomments outputParameters: - type: object mapping: $. - method: POST name: createportingordercomment description: Create a comment for a porting order call: telnyx-porting-orders.createportingordercomment with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/loa-template name: porting-orders-id-loa-template description: REST surface for porting_orders-id-loa_template. operations: - method: GET name: getportingorderloatemplate description: Download a porting order loa template call: telnyx-porting-orders.getportingorderloatemplate with: loa_configuration_id: rest.loa_configuration_id outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/requirements name: porting-orders-id-requirements description: REST surface for porting_orders-id-requirements. operations: - method: GET name: listportingorderrequirements description: List porting order requirements call: telnyx-porting-orders.listportingorderrequirements outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/sub-request name: porting-orders-id-sub-request description: REST surface for porting_orders-id-sub_request. operations: - method: GET name: getportingordersubrequest description: Retrieve the associated V1 sub_request_id and port_request_id call: telnyx-porting-orders.getportingordersubrequest outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/verification-codes name: porting-orders-id-verification-codes description: REST surface for porting_orders-id-verification_codes. operations: - method: GET name: listverificationcodes description: List verification codes call: telnyx-porting-orders.listverificationcodes with: filter: rest.filter sort: rest.sort outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/verification-codes/send name: porting-orders-id-verification-codes-send description: REST surface for porting_orders-id-verification_codes-send. operations: - method: POST name: sendportingverificationcodes description: Send the verification codes call: telnyx-porting-orders.sendportingverificationcodes with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{id}/verification-codes/verify name: porting-orders-id-verification-codes-verify description: REST surface for porting_orders-id-verification_codes-verify. operations: - method: POST name: verifyportingverificationcodes description: Verify the verification code for a list of phone numbers call: telnyx-porting-orders.verifyportingverificationcodes with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{porting-order-id}/action-requirements name: porting-orders-porting-order-id-action-requirements description: REST surface for porting_orders-porting_order_id-action_requirements. operations: - method: GET name: listportingactionrequirements description: List action requirements for a porting order call: telnyx-porting-orders.listportingactionrequirements with: porting_order_id: rest.porting_order_id filter: rest.filter sort: rest.sort outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{porting-order-id}/action-requirements/{id}/initiate name: porting-orders-porting-order-id-action-requirements-id-initiate description: REST surface for porting_orders-porting_order_id-action_requirements-id-initiate. operations: - method: POST name: initiateportingactionrequirement description: Initiate an action requirement call: telnyx-porting-orders.initiateportingactionrequirement with: porting_order_id: rest.porting_order_id id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{porting-order-id}/associated-phone-numbers name: porting-orders-porting-order-id-associated-phone-numbers description: REST surface for porting_orders-porting_order_id-associated_phone_numbers. operations: - method: GET name: listportingassociatedphonenumbers description: List all associated phone numbers call: telnyx-porting-orders.listportingassociatedphonenumbers with: porting_order_id: rest.porting_order_id filter: rest.filter sort: rest.sort outputParameters: - type: object mapping: $. - method: POST name: createportingassociatedphonenumber description: Create an associated phone number call: telnyx-porting-orders.createportingassociatedphonenumber with: porting_order_id: rest.porting_order_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{porting-order-id}/associated-phone-numbers/{id} name: porting-orders-porting-order-id-associated-phone-numbers-id description: REST surface for porting_orders-porting_order_id-associated_phone_numbers-id. operations: - method: DELETE name: deleteportingassociatedphonenumber description: Delete an associated phone number call: telnyx-porting-orders.deleteportingassociatedphonenumber with: porting_order_id: rest.porting_order_id id: rest.id outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{porting-order-id}/phone-number-blocks name: porting-orders-porting-order-id-phone-number-blocks description: REST surface for porting_orders-porting_order_id-phone_number_blocks. operations: - method: GET name: listportingphonenumberblocks description: List all phone number blocks call: telnyx-porting-orders.listportingphonenumberblocks with: porting_order_id: rest.porting_order_id sort: rest.sort outputParameters: - type: object mapping: $. - method: POST name: createportingphonenumberblock description: Create a phone number block call: telnyx-porting-orders.createportingphonenumberblock with: porting_order_id: rest.porting_order_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{porting-order-id}/phone-number-blocks/{id} name: porting-orders-porting-order-id-phone-number-blocks-id description: REST surface for porting_orders-porting_order_id-phone_number_blocks-id. operations: - method: DELETE name: deleteportingphonenumberblock description: Delete a phone number block call: telnyx-porting-orders.deleteportingphonenumberblock with: porting_order_id: rest.porting_order_id id: rest.id outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{porting-order-id}/phone-number-extensions name: porting-orders-porting-order-id-phone-number-extensions description: REST surface for porting_orders-porting_order_id-phone_number_extensions. operations: - method: GET name: listportingphonenumberextensions description: List all phone number extensions call: telnyx-porting-orders.listportingphonenumberextensions with: porting_order_id: rest.porting_order_id filter: rest.filter sort: rest.sort outputParameters: - type: object mapping: $. - method: POST name: createportingphonenumberextension description: Create a phone number extension call: telnyx-porting-orders.createportingphonenumberextension with: porting_order_id: rest.porting_order_id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/porting-orders/{porting-order-id}/phone-number-extensions/{id} name: porting-orders-porting-order-id-phone-number-extensions-id description: REST surface for porting_orders-porting_order_id-phone_number_extensions-id. operations: - method: DELETE name: deleteportingphonenumberextension description: Delete a phone number extension call: telnyx-porting-orders.deleteportingphonenumberextension with: porting_order_id: rest.porting_order_id id: rest.id outputParameters: - type: object mapping: $. - path: /v1/porting-phone-numbers name: porting-phone-numbers description: REST surface for porting_phone_numbers. operations: - method: GET name: listportingphonenumbers description: List all porting phone numbers call: telnyx-porting-orders.listportingphonenumbers with: filter: rest.filter outputParameters: - type: object mapping: $. - type: mcp namespace: telnyx-porting-orders-mcp port: 9090 transport: http description: MCP adapter for Telnyx API — Porting Orders. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: list-all-porting-events description: List all porting events hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingevents with: filter: tools.filter outputParameters: - type: object mapping: $. - name: show-porting-event description: Show a porting event hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.showportingevent with: id: tools.id outputParameters: - type: object mapping: $. - name: republish-porting-event description: Republish a porting event hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.republishportingevent with: id: tools.id outputParameters: - type: object mapping: $. - name: list-loa-configurations description: List LOA configurations hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listloaconfigurations outputParameters: - type: object mapping: $. - name: create-loa-configuration description: Create a LOA configuration hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.createloaconfiguration with: body: tools.body outputParameters: - type: object mapping: $. - name: preview-loa-configuration-parameters description: Preview the LOA configuration parameters hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.previewloaconfigurationparams with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-loa-configuration description: Delete a LOA configuration hints: readOnly: false destructive: true idempotent: true call: telnyx-porting-orders.deleteloaconfiguration with: id: tools.id outputParameters: - type: object mapping: $. - name: retrieve-loa-configuration description: Retrieve a LOA configuration hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.getloaconfiguration with: id: tools.id outputParameters: - type: object mapping: $. - name: update-loa-configuration description: Update a LOA configuration hints: readOnly: false destructive: false idempotent: true call: telnyx-porting-orders.updateloaconfiguration with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: preview-loa-configuration description: Preview a LOA configuration hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.previewloaconfiguration with: id: tools.id outputParameters: - type: object mapping: $. - name: list-porting-related-reports description: List porting related reports hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingreports with: filter: tools.filter outputParameters: - type: object mapping: $. - name: create-porting-related-report description: Create a porting related report hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.createportingreport with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieve-report description: Retrieve a report hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.getportingreport with: id: tools.id outputParameters: - type: object mapping: $. - name: list-available-carriers-uk description: List available carriers in the UK hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingukcarriers outputParameters: - type: object mapping: $. - name: list-all-porting-orders description: List all porting orders hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingorders with: filter: tools.filter sort: tools.sort outputParameters: - type: object mapping: $. - name: create-porting-order description: Create a porting order hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.createportingorder with: body: tools.body outputParameters: - type: object mapping: $. - name: list-all-exception-types description: List all exception types hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listexceptiontypes outputParameters: - type: object mapping: $. - name: list-all-phone-number-configurations description: List all phone number configurations hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listphonenumberconfigurations with: filter: tools.filter sort: tools.sort outputParameters: - type: object mapping: $. - name: create-list-phone-number-configurations description: Create a list of phone number configurations hints: readOnly: true destructive: false idempotent: false call: telnyx-porting-orders.createphonenumberconfigurations with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-porting-order description: Delete a porting order hints: readOnly: false destructive: true idempotent: true call: telnyx-porting-orders.deleteportingorder outputParameters: - type: object mapping: $. - name: retrieve-porting-order description: Retrieve a porting order hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.getportingorder outputParameters: - type: object mapping: $. - name: edit-porting-order description: Edit a porting order hints: readOnly: false destructive: false idempotent: true call: telnyx-porting-orders.updateportingorder with: body: tools.body outputParameters: - type: object mapping: $. - name: activate-every-number-porting-order description: Activate every number in a porting order asynchronously. hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.activateportingorder outputParameters: - type: object mapping: $. - name: cancel-porting-order description: Cancel a porting order hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.cancelportingorder outputParameters: - type: object mapping: $. - name: submit-porting-order description: Submit a porting order. hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.confirmportingorder outputParameters: - type: object mapping: $. - name: share-porting-order description: Share a porting order hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.shareportingorder with: body: tools.body outputParameters: - type: object mapping: $. - name: list-all-porting-activation-jobs description: List all porting activation jobs hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingorderactivationjobs outputParameters: - type: object mapping: $. - name: retrieve-porting-activation-job description: Retrieve a porting activation job hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.getportingordersactivationjob outputParameters: - type: object mapping: $. - name: update-porting-activation-job description: Update a porting activation job hints: readOnly: false destructive: false idempotent: true call: telnyx-porting-orders.updateportingordersactivationjob with: body: tools.body outputParameters: - type: object mapping: $. - name: list-additional-documents description: List additional documents hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listadditionaldocuments with: filter: tools.filter sort: tools.sort outputParameters: - type: object mapping: $. - name: create-list-additional-documents description: Create a list of additional documents hints: readOnly: true destructive: false idempotent: false call: telnyx-porting-orders.createadditionaldocuments with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-additional-document description: Delete an additional document hints: readOnly: false destructive: true idempotent: true call: telnyx-porting-orders.deleteadditionaldocument with: additional_document_id: tools.additional_document_id outputParameters: - type: object mapping: $. - name: list-allowed-foc-dates description: List allowed FOC dates hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listallowedfocwindows outputParameters: - type: object mapping: $. - name: list-all-comments-porting-order description: List all comments of a porting order hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingordercomments outputParameters: - type: object mapping: $. - name: create-comment-porting-order description: Create a comment for a porting order hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.createportingordercomment with: body: tools.body outputParameters: - type: object mapping: $. - name: download-porting-order-loa-template description: Download a porting order loa template hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.getportingorderloatemplate with: loa_configuration_id: tools.loa_configuration_id outputParameters: - type: object mapping: $. - name: list-porting-order-requirements description: List porting order requirements hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingorderrequirements outputParameters: - type: object mapping: $. - name: retrieve-associated-v1-sub-request description: Retrieve the associated V1 sub_request_id and port_request_id hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.getportingordersubrequest outputParameters: - type: object mapping: $. - name: list-verification-codes description: List verification codes hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listverificationcodes with: filter: tools.filter sort: tools.sort outputParameters: - type: object mapping: $. - name: send-verification-codes description: Send the verification codes hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.sendportingverificationcodes with: body: tools.body outputParameters: - type: object mapping: $. - name: verify-verification-code-list-phone description: Verify the verification code for a list of phone numbers hints: readOnly: true destructive: false idempotent: false call: telnyx-porting-orders.verifyportingverificationcodes with: body: tools.body outputParameters: - type: object mapping: $. - name: list-action-requirements-porting-order description: List action requirements for a porting order hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingactionrequirements with: porting_order_id: tools.porting_order_id filter: tools.filter sort: tools.sort outputParameters: - type: object mapping: $. - name: initiate-action-requirement description: Initiate an action requirement hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.initiateportingactionrequirement with: porting_order_id: tools.porting_order_id id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: list-all-associated-phone-numbers description: List all associated phone numbers hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingassociatedphonenumbers with: porting_order_id: tools.porting_order_id filter: tools.filter sort: tools.sort outputParameters: - type: object mapping: $. - name: create-associated-phone-number description: Create an associated phone number hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.createportingassociatedphonenumber with: porting_order_id: tools.porting_order_id body: tools.body outputParameters: - type: object mapping: $. - name: delete-associated-phone-number description: Delete an associated phone number hints: readOnly: false destructive: true idempotent: true call: telnyx-porting-orders.deleteportingassociatedphonenumber with: porting_order_id: tools.porting_order_id id: tools.id outputParameters: - type: object mapping: $. - name: list-all-phone-number-blocks description: List all phone number blocks hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingphonenumberblocks with: porting_order_id: tools.porting_order_id sort: tools.sort outputParameters: - type: object mapping: $. - name: create-phone-number-block description: Create a phone number block hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.createportingphonenumberblock with: porting_order_id: tools.porting_order_id body: tools.body outputParameters: - type: object mapping: $. - name: delete-phone-number-block description: Delete a phone number block hints: readOnly: false destructive: true idempotent: true call: telnyx-porting-orders.deleteportingphonenumberblock with: porting_order_id: tools.porting_order_id id: tools.id outputParameters: - type: object mapping: $. - name: list-all-phone-number-extensions description: List all phone number extensions hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingphonenumberextensions with: porting_order_id: tools.porting_order_id filter: tools.filter sort: tools.sort outputParameters: - type: object mapping: $. - name: create-phone-number-extension description: Create a phone number extension hints: readOnly: false destructive: false idempotent: false call: telnyx-porting-orders.createportingphonenumberextension with: porting_order_id: tools.porting_order_id body: tools.body outputParameters: - type: object mapping: $. - name: delete-phone-number-extension description: Delete a phone number extension hints: readOnly: false destructive: true idempotent: true call: telnyx-porting-orders.deleteportingphonenumberextension with: porting_order_id: tools.porting_order_id id: tools.id outputParameters: - type: object mapping: $. - name: list-all-porting-phone-numbers description: List all porting phone numbers hints: readOnly: true destructive: false idempotent: true call: telnyx-porting-orders.listportingphonenumbers with: filter: tools.filter outputParameters: - type: object mapping: $.