openapi: 3.1.0 info: contact: email: support@telnyx.com description: Telnyx provides global communications and connectivity APIs for developers — including SIP trunking, programmable voice, SMS, MMS, WhatsApp Business Messaging, Call Control, Fax, Wireless (IoT & eSIM), Phone Numbers (DID provisioning & porting), Emergency Services, and Network APIs for private interconnects and edge connectivity. Build, scale, and manage voice, messaging, and data networks with Telnyx's carrier-grade global infrastructure and API-first platform. title: Telnyx Access Tokens Porting Orders API version: 2.0.0 x-endpoint-cost: light servers: - description: Version 2.0.0 of the Telnyx API url: https://api.telnyx.com/v2 security: - bearerAuth: [] tags: - description: Endpoints related to porting orders management. name: Porting Orders paths: /porting/events: get: description: Returns a list of all porting events. operationId: listPortingEvents parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[type], filter[porting_order_id], filter[created_at][gte], filter[created_at][lte]' explode: true in: query name: filter schema: properties: created_at: description: Created at date range filtering operations properties: gte: description: Filter by created at greater than or equal to. example: '2021-01-01T00:00:00Z' format: date-time type: string lte: description: Filter by created at less than or equal to. example: '2021-01-01T00:00:00Z' format: date-time type: string type: object porting_order_id: description: Filter by porting order ID. example: 34dc46a9-53ed-4e01-9454-26227ea13326 format: uuid type: string type: description: Filter by event type. enum: - porting_order.deleted - porting_order.loa_updated - porting_order.messaging_changed - porting_order.status_changed - porting_order.sharing_token_expired - porting_order.new_comment - porting_order.split example: porting_order.deleted type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingEventsResponse' '422': description: Unprocessable entity. Check the 'detail' field in response for details. '500': description: Internal server error summary: List all porting events tags: - Porting Orders x-latency-category: responsive /porting/events/{id}: get: description: Show a specific porting event. operationId: showPortingEvent parameters: - description: Identifies the porting event. in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingEventResponse' '404': description: Not found '500': description: Internal server error summary: Show a porting event tags: - Porting Orders x-latency-category: responsive /porting/events/{id}/republish: post: description: Republish a specific porting event. operationId: republishPortingEvent parameters: - description: Identifies the porting event. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No content '404': description: Not found '500': description: Internal server error summary: Republish a porting event tags: - Porting Orders x-latency-category: responsive /porting/loa_configurations: get: description: List the LOA configurations. operationId: ListLoaConfigurations parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' responses: '200': $ref: '#/components/responses/ListPortingLOAConfigurations' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: List LOA configurations tags: - Porting Orders x-latency-category: responsive post: description: Create a LOA configuration. operationId: CreateLoaConfiguration requestBody: $ref: '#/components/requestBodies/CreatePortingLOAConfiguration' responses: '201': $ref: '#/components/responses/CreatePortingLOAConfiguration' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Create a LOA configuration tags: - Porting Orders x-latency-category: responsive /porting/loa_configurations/preview: post: description: Preview the LOA template that would be generated without need to create LOA configuration. operationId: PreviewLoaConfigurationParams requestBody: $ref: '#/components/requestBodies/CreatePortingLOAConfiguration' responses: '200': $ref: '#/components/responses/DownloadLOATemplate' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Preview the LOA configuration parameters tags: - Porting Orders x-latency-category: responsive /porting/loa_configurations/{id}: delete: description: Delete a specific LOA configuration. operationId: DeleteLoaConfiguration parameters: - description: Identifies a LOA configuration. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No content '404': description: Resource not found '500': description: Internal server error summary: Delete a LOA configuration tags: - Porting Orders x-latency-category: responsive get: description: Retrieve a specific LOA configuration. operationId: GetLoaConfiguration parameters: - description: Identifies a LOA configuration. in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingLOAConfiguration' '404': description: Resource not found '500': description: Internal server error summary: Retrieve a LOA configuration tags: - Porting Orders x-latency-category: responsive patch: description: Update a specific LOA configuration. operationId: UpdateLoaConfiguration parameters: - description: Identifies a LOA configuration. in: path name: id required: true schema: format: uuid type: string requestBody: $ref: '#/components/requestBodies/CreatePortingLOAConfiguration' responses: '200': $ref: '#/components/responses/UpdatePortingLOAConfiguration' '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Update a LOA configuration tags: - Porting Orders x-latency-category: responsive /porting/loa_configurations/{id}/preview: get: description: Preview a specific LOA configuration. operationId: PreviewLoaConfiguration parameters: - description: Identifies a LOA configuration. in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/DownloadLOATemplate' '404': description: Resource not found '500': description: Internal server error summary: Preview a LOA configuration tags: - Porting Orders x-latency-category: responsive /porting/reports: get: description: List the reports generated about porting operations. operationId: ListPortingReports parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]' explode: true in: query name: filter schema: properties: report_type: description: Filter reports of a specific type enum: - export_porting_orders_csv example: export_porting_orders_csv type: string status: description: Filter reports of a specific status enum: - pending - completed example: completed type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingReports' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: List porting related reports tags: - Porting Orders x-latency-category: responsive post: description: Generate reports about porting operations. operationId: CreatePortingReport requestBody: $ref: '#/components/requestBodies/CreatePortingReport' responses: '201': $ref: '#/components/responses/CreatePortingReport' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Create a porting related report tags: - Porting Orders x-latency-category: responsive /porting/reports/{id}: get: description: Retrieve a specific report generated. operationId: GetPortingReport parameters: - description: Identifies a report. in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingReport' '404': description: Resource not found '500': description: Internal server error summary: Retrieve a report tags: - Porting Orders x-latency-category: responsive /porting/uk_carriers: get: description: List available carriers in the UK. operationId: listPortingUKCarriers responses: '200': $ref: '#/components/responses/ListPortingUKCarriersResponse' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: List available carriers in the UK tags: - Porting Orders x-latency-category: responsive /porting_orders: get: description: Returns a list of your porting order. operationId: ListPortingOrders parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' - $ref: '#/components/parameters/QueryIncludePhoneNumbers' - 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]' explode: true in: query name: filter schema: properties: activation_settings: properties: fast_port_eligible: description: Filter results by fast port eligible type: boolean foc_datetime_requested: description: FOC datetime range filtering operations properties: gt: description: Filter results by foc date later than this value example: '2021-03-25T10:00:00.000Z' type: string lt: description: Filter results by foc date earlier than this value example: '2021-03-25T10:00:00.000Z' type: string type: object type: object customer_group_reference: description: Filter results by customer_group_reference type: string customer_reference: description: Filter results by customer_reference type: string end_user: properties: admin: properties: auth_person_name: description: Filter results by authorized person type: string entity_name: description: Filter results by person or company name type: string type: object type: object misc: properties: type: $ref: '#/components/schemas/PortingOrderType' description: Filter results by porting order type type: object parent_support_key: description: Filter results by parent_support_key type: string phone_numbers: properties: carrier_name: description: Filter results by old service provider type: string country_code: description: Filter results by country ISO 3166-1 alpha-2 code type: string phone_number: description: Phone number pattern filtering operations properties: contains: description: Filter results by full or partial phone_number type: string type: object type: object type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at - activation_settings.foc_datetime_requested - -activation_settings.foc_datetime_requested example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingOrder' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: List all porting orders tags: - Porting Orders x-latency-category: responsive post: description: Creates a new porting order object. operationId: CreatePortingOrder requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePortingOrder' required: true responses: '201': $ref: '#/components/responses/ListDraftPortingOrdersWithoutPagination' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Create a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/exception_types: get: description: Returns a list of all possible exception types for a porting order. operationId: ListExceptionTypes parameters: [] responses: '200': $ref: '#/components/responses/ListPortingOrdersExceptionTypes' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: List all exception types tags: - Porting Orders x-latency-category: responsive /porting_orders/phone_number_configurations: get: description: Returns a list of phone number configurations paginated. operationId: ListPhoneNumberConfigurations parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_order.status][in][], filter[porting_phone_number][in][], filter[user_bundle_id][in][]' explode: true in: query name: filter schema: properties: porting_order: properties: status: description: Filter results by specific porting order statuses items: enum: - activation-in-progress - cancel-pending - cancelled - draft - exception - foc-date-confirmed - in-process - ported - submitted example: in-process type: string type: array type: object porting_phone_number: description: Filter results by a list of porting phone number IDs items: example: 5d6f7ede-1961-4717-bfb5-db392c5efc2d format: uuid type: string type: array user_bundle_id: description: Filter results by a list of user bundle IDs items: example: 5d6f7ede-1961-4717-bfb5-db392c5efc2d format: uuid type: string type: array type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingPhoneNumberConfigurations' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: List all phone number configurations tags: - Porting Orders x-latency-category: responsive post: description: Creates a list of phone number configurations. operationId: CreatePhoneNumberConfigurations requestBody: $ref: '#/components/requestBodies/CreatePortingPhoneNumberConfigurations' responses: '201': $ref: '#/components/responses/CreatePortingPhoneNumberConfigurations' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Create a list of phone number configurations tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}: delete: description: Deletes an existing porting order. This operation is restrict to porting orders in draft state. operationId: DeletePortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '204': description: No content '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Delete a porting order tags: - Porting Orders x-latency-category: responsive get: description: Retrieves the details of an existing porting order. operationId: GetPortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/QueryIncludePhoneNumbers' responses: '200': $ref: '#/components/responses/ShowPortingOrder' '401': description: Unauthorized summary: Retrieve a porting order tags: - Porting Orders x-latency-category: responsive patch: description: 'Edits the details of an existing porting order. Any or all of a porting orders attributes may be included in the resource object included in a PATCH request. If 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.' operationId: UpdatePortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePortingOrder' required: true responses: '200': $ref: '#/components/responses/UpdatePortingOrderResponse' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Edit a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/actions/activate: post: description: Activate each number in a porting order asynchronously. This operation is limited to US FastPort orders only. operationId: ActivatePortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '202': $ref: '#/components/responses/ShowPortingOrdersActivationJob' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Activate every number in a porting order asynchronously. tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/actions/cancel: post: description: Cancel a porting order operationId: CancelPortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '200': $ref: '#/components/responses/CancelPortingOrderResponse' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Cancel a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/actions/confirm: post: description: Confirm and submit your porting order. operationId: ConfirmPortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '200': $ref: '#/components/responses/ConfirmPortingOrderResponse' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Submit a porting order. tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/actions/share: post: description: Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users. operationId: SharePortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' requestBody: $ref: '#/components/requestBodies/SharePortingOrder' responses: '201': $ref: '#/components/responses/SharePortingOrder' '401': description: Unauthorized '404': description: Porting Order not found summary: Share a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/activation_jobs: get: description: Returns a list of your porting activation jobs. operationId: ListPortingOrderActivationJobs parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/porting-order_PageConsolidated' responses: '200': $ref: '#/components/responses/ListPortingOrdersActivationJobs' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: List all porting activation jobs tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/activation_jobs/{activationJobId}: get: description: Returns a porting activation job. operationId: GetPortingOrdersActivationJob parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/PathPortingOrdersActivationJobID' responses: '200': $ref: '#/components/responses/ShowPortingOrdersActivationJob' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Retrieve a porting activation job tags: - Porting Orders x-latency-category: responsive patch: description: Updates the activation time of a porting activation job. operationId: UpdatePortingOrdersActivationJob parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/PathPortingOrdersActivationJobID' requestBody: $ref: '#/components/requestBodies/UpdatePortingOrdersActivationJob' responses: '200': $ref: '#/components/responses/ShowPortingOrdersActivationJob' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Update a porting activation job tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/additional_documents: get: description: Returns a list of additional documents for a porting order. operationId: ListAdditionalDocuments parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[document_type]' explode: true in: query name: filter schema: properties: document_type: description: Filter additional documents by a list of document types items: enum: - loa - invoice - csr - other example: loa type: string type: array type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingAdditionalDocuments' '401': description: Unauthorized '404': description: Resource not found summary: List additional documents tags: - Porting Orders x-latency-category: responsive post: description: Creates a list of additional documents for a porting order. operationId: CreateAdditionalDocuments parameters: - $ref: '#/components/parameters/PathPortingOrderID' requestBody: $ref: '#/components/requestBodies/CreatePortingAdditionalDocuments' responses: '201': $ref: '#/components/responses/CreatePortingAdditionalDocuments' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create a list of additional documents tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/additional_documents/{additional_document_id}: delete: description: Deletes an additional document for a porting order. operationId: DeleteAdditionalDocument parameters: - $ref: '#/components/parameters/PathPortingOrderID' - description: Additional document identification. in: path name: additional_document_id required: true schema: format: uuid type: string responses: '204': description: No content '401': description: Unauthorized '404': description: Resource not found summary: Delete an additional document tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/allowed_foc_windows: get: description: Returns a list of allowed FOC dates for a porting order. operationId: ListAllowedFocWindows parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '200': $ref: '#/components/responses/ListAllowedFocWindows' '401': description: Unauthorized summary: List allowed FOC dates tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/comments: get: description: Returns a list of all comments of a porting order. operationId: ListPortingOrderComments parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/porting-order_PageConsolidated' responses: '200': $ref: '#/components/responses/ListPortingOrdersComments' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: List all comments of a porting order tags: - Porting Orders x-latency-category: responsive post: description: Creates a new comment for a porting order. operationId: CreatePortingOrderComment parameters: - $ref: '#/components/parameters/PathPortingOrderID' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePortingOrderComment' required: true responses: '201': $ref: '#/components/responses/ShowPortingOrdersComment' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Create a comment for a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/loa_template: get: description: Download a porting order loa template operationId: GetPortingOrderLoaTemplate parameters: - $ref: '#/components/parameters/PathPortingOrderID' - description: The identifier of the LOA configuration to use for the template. If not provided, the default LOA configuration will be used. example: a36c2277-446b-4d11-b4ea-322e02a5c08d in: query name: loa_configuration_id required: false schema: format: uuid type: string responses: '200': $ref: '#/components/responses/DownloadLOATemplate' '401': description: Unauthorized summary: Download a porting order loa template tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/requirements: get: description: Returns a list of all requirements based on country/number type for this porting order. operationId: ListPortingOrderRequirements parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/porting-order_PageConsolidated' responses: '200': $ref: '#/components/responses/ListPortingOrderRequirements' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: List porting order requirements tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/sub_request: get: description: Retrieve the associated V1 sub_request_id and port_request_id operationId: GetPortingOrderSubRequest parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '200': $ref: '#/components/responses/SubRequestByPortingOrder' '401': description: Unauthorized '404': description: Porting Order not found summary: Retrieve the associated V1 sub_request_id and port_request_id tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/verification_codes: get: description: Returns a list of verification codes for a porting order. operationId: ListVerificationCodes parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[verified]' explode: true in: query name: filter schema: properties: verified: description: Filter verification codes that have been verified or not example: true type: boolean type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingVerificationCodes' '401': description: Unauthorized '404': description: Resource not found summary: List verification codes tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/verification_codes/send: post: description: Send the verification code for all porting phone numbers. operationId: SendPortingVerificationCodes parameters: - $ref: '#/components/parameters/PathPortingOrderID' requestBody: $ref: '#/components/requestBodies/SendPortingVerificationCodes' responses: '204': description: No content '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Send the verification codes tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/verification_codes/verify: post: description: Verifies the verification code for a list of phone numbers. operationId: VerifyPortingVerificationCodes parameters: - $ref: '#/components/parameters/PathPortingOrderID' requestBody: $ref: '#/components/requestBodies/VerifyPortingVerificationCodes' responses: '200': $ref: '#/components/responses/VerifyPortingVerificationCodes' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Verify the verification code for a list of phone numbers tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/action_requirements: get: description: Returns a list of action requirements for a specific porting order. operationId: listPortingActionRequirements parameters: - description: The ID of the porting order in: path name: porting_order_id required: true schema: type: string - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[id][in][], filter[requirement_type_id], filter[action_type], filter[status]' explode: true in: query name: filter schema: properties: action_type: description: Filter action requirements by action type enum: - au_id_verification type: string id: description: Filter action requirements by a list of IDs items: format: uuid type: string type: array requirement_type_id: description: Filter action requirements by requirement type ID format: uuid type: string status: description: Filter action requirements by status enum: - created - pending - completed - cancelled - failed type: string type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at - updated_at - -updated_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingActionRequirements' '401': description: Unauthorized '404': description: Porting order not found '500': description: Internal server error summary: List action requirements for a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/action_requirements/{id}/initiate: post: description: Initiates a specific action requirement for a porting order. operationId: initiatePortingActionRequirement parameters: - description: The ID of the porting order in: path name: porting_order_id required: true schema: type: string - description: The ID of the action requirement in: path name: id required: true schema: type: string requestBody: $ref: '#/components/requestBodies/InitiatePortingActionRequirement' responses: '200': $ref: '#/components/responses/ShowPortingActionRequirement' '400': description: Bad request '401': description: Unauthorized '404': description: Porting order or action requirement not found '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Initiate an action requirement tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/associated_phone_numbers: get: description: 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. operationId: listPortingAssociatedPhoneNumbers parameters: - description: Identifies the Porting Order associated with the phone numbers in: path name: porting_order_id required: true schema: format: uuid type: string - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[action]' explode: true in: query name: filter schema: properties: action: description: Filter results by action type enum: - keep - disconnect example: keep type: string phone_number: description: Filter results by a phone number. It should be in E.164 format. example: '+441234567890' type: string type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: default: -created_at description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order enum: - -created_at - created_at example: -created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingAssociatedPhoneNumbers' '401': description: Unauthorized '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: List all associated phone numbers tags: - Porting Orders x-latency-category: responsive post: description: 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. operationId: createPortingAssociatedPhoneNumber parameters: - description: Identifies the Porting Order associated with the phone number in: path name: porting_order_id required: true schema: format: uuid type: string requestBody: $ref: '#/components/requestBodies/CreatePortingAssociatedPhoneNumber' responses: '201': $ref: '#/components/responses/ShowPortingAssociatedPhoneNumber' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create an associated phone number tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/associated_phone_numbers/{id}: delete: description: Deletes an associated phone number from a porting order. operationId: deletePortingAssociatedPhoneNumber parameters: - description: Identifies the Porting Order associated with the phone number in: path name: porting_order_id required: true schema: format: uuid type: string - description: Identifies the associated phone number to be deleted in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingAssociatedPhoneNumber' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Delete an associated phone number tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/phone_number_blocks: get: description: Returns a list of all phone number blocks of a porting order. operationId: listPortingPhoneNumberBlocks parameters: - description: Identifies the Porting Order associated with the phone number blocks in: path name: porting_order_id required: true schema: format: uuid type: string - $ref: '#/components/parameters/porting-order_FilterConsolidated' - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order enum: - -created_at - created_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingPhoneNumberBlocks' '401': description: Unauthorized '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: List all phone number blocks tags: - Porting Orders x-latency-category: responsive post: description: Creates a new phone number block. operationId: createPortingPhoneNumberBlock parameters: - description: Identifies the Porting Order associated with the phone number block in: path name: porting_order_id required: true schema: format: uuid type: string requestBody: $ref: '#/components/requestBodies/CreatePortingPhoneNumberBlock' responses: '201': $ref: '#/components/responses/ShowPortingPhoneNumberBlock' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create a phone number block tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/phone_number_blocks/{id}: delete: description: Deletes a phone number block. operationId: deletePortingPhoneNumberBlock parameters: - description: Identifies the Porting Order associated with the phone number block in: path name: porting_order_id required: true schema: format: uuid type: string - description: Identifies the phone number block to be deleted in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingPhoneNumberBlock' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Delete a phone number block tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/phone_number_extensions: get: description: Returns a list of all phone number extensions of a porting order. operationId: listPortingPhoneNumberExtensions parameters: - description: Identifies the Porting Order associated with the phone number extensions in: path name: porting_order_id required: true schema: format: uuid type: string - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_phone_number_id]' explode: true in: query name: filter schema: properties: porting_phone_number_id: description: Filter results by porting phone number id example: 04f8f1b9-310c-4a3c-963e-7dfc54765140 format: uuid type: string type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order enum: - -created_at - created_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingPhoneNumberExtensions' '401': description: Unauthorized '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: List all phone number extensions tags: - Porting Orders x-latency-category: responsive post: description: Creates a new phone number extension. operationId: createPortingPhoneNumberExtension parameters: - description: Identifies the Porting Order associated with the phone number extension in: path name: porting_order_id required: true schema: format: uuid type: string requestBody: $ref: '#/components/requestBodies/CreatePortingPhoneNumberExtension' responses: '201': $ref: '#/components/responses/ShowPortingPhoneNumberExtension' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create a phone number extension tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/phone_number_extensions/{id}: delete: description: Deletes a phone number extension. operationId: deletePortingPhoneNumberExtension parameters: - description: Identifies the Porting Order associated with the phone number extension in: path name: porting_order_id required: true schema: format: uuid type: string - description: Identifies the phone number extension to be deleted in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingPhoneNumberExtension' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Delete a phone number extension tags: - Porting Orders x-latency-category: responsive /porting_phone_numbers: get: description: Returns a list of your porting phone numbers. operationId: ListPortingPhoneNumbers parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_order_status]' explode: true in: query name: filter schema: properties: porting_order_status: description: Filter results by porting order status enum: - draft - in-process - submitted - exception - foc-date-confirmed - cancel-pending - ported - cancelled example: in-process type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingPhoneNumbers' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: List all porting phone numbers tags: - Porting Orders x-latency-category: responsive components: responses: ListPortingActionRequirements: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingActionRequirement' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingLOAConfigurations: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingLOAConfiguration' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ShowPortingPhoneNumberBlock: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingPhoneNumberBlock' type: object description: Successful response ShowPortingOrder: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingOrder' meta: properties: phone_numbers_url: description: Link to list all phone numbers example: /v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222 type: string type: object type: object description: Successful response ShowPortingOrdersActivationJob: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingOrdersActivationJob' type: object description: Successful response ShowPortingLOAConfiguration: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingLOAConfiguration' type: object description: Successful response ShowPortingPhoneNumberExtension: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingPhoneNumberExtension' type: object description: Successful response ListPortingReports: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingReport' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingOrder: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingOrder' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ShowPortingOrdersComment: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingOrdersComment' type: object description: Successful response ListPortingEventsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingEvent' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ShowPortingActionRequirement: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingActionRequirement' type: object description: Successful response ListPortingPhoneNumbers: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingPhoneNumber' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object text/csv: schema: example: "phone_number,phone_number_type,porting_order_id,support_key,porting_order_status\r\n+12003155566,local,5f940c35-ef28-4408-bb95-af73b047d589,sr_a12345,draft\r\n" type: string description: Successful response ListPortingOrdersActivationJobs: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingOrdersActivationJob' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListAllowedFocWindows: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingOrdersAllowedFocWindow' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response CreatePortingReport: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingReport' type: object description: Successful response ListPortingPhoneNumberBlocks: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingPhoneNumberBlock' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingAdditionalDocuments: content: application/json: schema: example: data: - created_at: '2023-06-01T10:00:00.00000Z' document_id: 40bc547a-7f96-4cd5-926a-da4842671e88 document_type: loa id: 2acd1061-33cb-49b8-8014-beb6dc3fedbf porting_order_id: 9d7b3b8e-4e67-4837-9c44-d110cd2c82a1 record_type: porting_additional_document updated_at: '2023-06-01T10:00:00.00000Z' meta: page_number: 1 page_size: 25 total_pages: 1 total_results: 1 properties: data: items: $ref: '#/components/schemas/PortingAdditionalDocument' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingUKCarriersResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingUKCarrier' type: array type: object description: Successful response UpdatePortingOrderResponse: content: application/json: schema: example: data: activation_settings: activation_status: null fast_port_eligible: true foc_datetime_actual: null foc_datetime_requested: '2022-04-08T15:00:00Z' created_at: '2022-03-24T14:22:28Z' customer_group_reference: Group-789 customer_reference: Test1234 description: FP Telnyx documents: invoice: null loa: null end_user: admin: account_number: 123abc auth_person_name: Porter McPortersen II billing_phone_number: '+13035551234' business_identifier: abc123 entity_name: Porter McPortersen pin_passcode: '1234' tax_identifier: 1234abcd location: administrative_area: TX country_code: US extended_address: 14th Floor locality: Austin postal_code: '78701' street_address: 600 Congress Avenue id: eef10fb8-f3df-4c67-97c5-e18179723222 messaging: enable_messaging: true messaging_capable: true messaging_port_completed: false messaging_port_status: pending misc: new_billing_phone_number: null remaining_numbers_action: null type: full old_service_provider_ocn: Unreal Communications parent_support_key: null phone_number_configuration: billing_group_id: null connection_id: '1752379429071357070' emergency_address_id: null messaging_profile_id: null tags: [] phone_number_type: local porting_phone_numbers_count: 1 record_type: porting_order requirements: [] requirements_met: false status: details: [] value: draft support_key: null updated_at: '2022-03-24T14:26:53Z' user_feedback: user_comment: null user_rating: null user_id: 40d68ba2-0847-4df2-be9c-b0e0cb673e75 webhook_url: https://example.com/porting_webhooks meta: phone_numbers_url: /v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222 properties: data: $ref: '#/components/schemas/PortingOrder' meta: properties: phone_numbers_url: description: Link to list all phone numbers type: string type: object type: object description: Successful response DownloadLOATemplate: content: application/pdf: schema: example: '%PDF-1.4...' format: binary type: string description: Successful response SubRequestByPortingOrder: content: application/json: schema: properties: data: $ref: '#/components/schemas/GetSubRequestByPortingOrder' type: object description: Successful response ListDraftPortingOrdersWithoutPagination: content: application/json: schema: example: data: - activation_settings: activation_status: null fast_port_eligible: true foc_datetime_actual: null foc_datetime_requested: null created_at: '2022-03-17T18:01:01Z' customer_group_reference: null customer_reference: null description: FP Telnyx documents: invoice: null loa: null end_user: admin: account_number: null auth_person_name: null billing_phone_number: null business_identifier: null entity_name: null pin_passcode: null tax_identifier: null location: administrative_area: null country_code: null extended_address: null locality: null postal_code: null street_address: null id: b0ea6d6f-de31-4079-a536-992e0c98b037 messaging: enable_messaging: false messaging_capable: true messaging_port_completed: false messaging_port_status: not_applicable misc: null old_service_provider_ocn: Unreal Communications parent_support_key: null phone_number_configuration: billing_group_id: null connection_id: null emergency_address_id: null messaging_profile_id: null tags: [] phone_number_type: local phone_numbers: - activation_status: Activate RDY phone_number: '{e.164 TN}' phone_number_type: local portability_status: confirmed porting_order_id: b0ea6d6f-de31-4079-a536-992e0c98b037 porting_order_status: draft record_type: porting_phone_number requirements_status: requirement-info-pending support_key: sr_10b316 porting_phone_numbers_count: 1 record_type: porting_order requirements: [] requirements_met: false status: details: [] value: draft support_key: null updated_at: '2022-03-17T18:01:01Z' user_feedback: user_comment: null user_rating: null user_id: 40d68ba2-0847-4df2-be9c-b0e0cb673e75 webhook_url: null properties: data: items: $ref: '#/components/schemas/PortingOrder' type: array type: object description: Successful response ListPortingAssociatedPhoneNumbers: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingAssociatedPhoneNumber' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ConfirmPortingOrderResponse: content: application/json: schema: example: data: activation_settings: activation_status: null fast_port_eligible: true foc_datetime_actual: null foc_datetime_requested: '2022-04-08T15:00:00Z' created_at: '2022-03-24T14:22:28Z' customer_group_reference: Group-789 customer_reference: Test1234 description: FP Telnyx documents: invoice: 3a5b98a0-5049-47c3-96e1-aa6c8d119117 loa: 3a5b98a0-5049-47c3-96e1-aa6c8d119117 end_user: admin: account_number: 123abc auth_person_name: Porter McPortersen II billing_phone_number: '+13035551234' business_identifier: abc123 entity_name: Porter McPortersen pin_passcode: '1234' tax_identifier: 1234abcd location: administrative_area: TX country_code: US extended_address: 14th Floor locality: Austin postal_code: '78701' street_address: 600 Congress Avenue id: eef10fb8-f3df-4c67-97c5-e18179723222 messaging: enable_messaging: false messaging_capable: true messaging_port_completed: false messaging_port_status: not_applicable misc: new_billing_phone_number: null remaining_numbers_action: null type: full old_service_provider_ocn: Unreal Communications parent_support_key: pr_4bec1a phone_number_configuration: billing_group_id: null connection_id: '1752379429071357070' emergency_address_id: null messaging_profile_id: null tags: [] phone_number_type: local porting_phone_numbers_count: 1 record_type: porting_order requirements: [] requirements_met: true status: details: [] value: in-process support_key: sr_10b316 updated_at: '2022-03-24T16:42:43Z' user_feedback: user_comment: null user_rating: null user_id: 40d68ba2-0847-4df2-be9c-b0e0cb673e75 webhook_url: https://example.com/porting_webhooks meta: phone_numbers_url: /v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222 properties: data: $ref: '#/components/schemas/PortingOrder' meta: properties: phone_numbers_url: description: Link to list all phone numbers type: string type: object type: object description: Successful response ListPortingPhoneNumberExtensions: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingPhoneNumberExtension' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response CreatePortingLOAConfiguration: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingLOAConfiguration' type: object description: Successful response ShowPortingAssociatedPhoneNumber: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingAssociatedPhoneNumber' type: object description: Successful response ShowPortingEventResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingEvent' type: object description: Successful response VerifyPortingVerificationCodes: content: application/json: schema: example: data: - created_at: '2020-10-22T15:00:00.000Z' id: 52090326-6533-4421-bcf4-bd0117cf3954 phone_number: '+61424000001' porting_order_id: f28e6ecc-29a8-430b-bd0b-d93055f70604 updated_at: '2020-10-22T15:00:00.000Z' verified: true - created_at: '2020-10-22T15:00:00.000Z' id: cf076b8e-645b-4040-8209-543c5909775f phone_number: '+61424000002' porting_order_id: f28e6ecc-29a8-430b-bd0b-d93055f70604 updated_at: '2020-10-22T15:00:00.000Z' verified: false properties: data: items: $ref: '#/components/schemas/PortingVerificationCode' type: array type: object description: Successful response ListPortingOrdersComments: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingOrdersComment' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ShowPortingReport: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingReport' type: object description: Successful response ListPortingOrdersExceptionTypes: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingOrdersExceptionType' type: array type: object description: Successful response UpdatePortingLOAConfiguration: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingLOAConfiguration' type: object description: Successful response CreatePortingPhoneNumberConfigurations: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingPhoneNumberConfiguration' type: array type: object description: Successful response SharePortingOrder: content: application/json: example: data: created_at: '2023-07-20T22:11:17.292573Z' expires_at: '2023-07-20T23:11:17Z' expires_in_seconds: 3600 id: 03a35311-ad92-46b3-95d7-8ad6dccf2d7c permissions: - porting_order.document.read - porting_order.document.update porting_order_id: fd4b86c8-497d-4c6d-9609-a789e4e14cfe record_type: porting_order_sharing_token token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODk4OTQ2NzcsImlzdCI6MTY4OTg5MTA3NywicGVybWlzc2lvbnMiOlsicG9ydGluZ19vcmRlci5kb2N1bWVudC5yZWFkIl0sInBvcnRpbmdfb3JkZXJfaWQiOiJmZDRiODZjOC00OTdkLTRjNmQtOTYwOS1hNzg5ZTRlMTRjZmUifQ.CT0HRF6OLj7VPZ8p5Y_0S8rOL8SEUznwJJkR-YReKwc schema: properties: data: $ref: '#/components/schemas/PortingOrderSharingToken' type: object description: Successful response ListPortingVerificationCodes: content: application/json: schema: example: data: - created_at: '2020-10-22T15:00:00.000Z' id: 52090326-6533-4421-bcf4-bd0117cf3954 phone_number: '+61424000001' porting_order_id: f28e6ecc-29a8-430b-bd0b-d93055f70604 updated_at: '2020-10-22T15:00:00.000Z' verified: true - created_at: '2020-10-22T15:00:00.000Z' id: cf076b8e-645b-4040-8209-543c5909775f phone_number: '+61424000002' porting_order_id: f28e6ecc-29a8-430b-bd0b-d93055f70604 updated_at: '2020-10-22T15:00:00.000Z' verified: false meta: page_number: 1 page_size: 2 total_pages: 1 total_results: 2 properties: data: items: $ref: '#/components/schemas/PortingVerificationCode' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response CreatePortingAdditionalDocuments: content: application/json: schema: example: data: - created_at: '2023-06-01T10:00:00.00000Z' document_id: 40bc547a-7f96-4cd5-926a-da4842671e88 document_type: loa id: 2acd1061-33cb-49b8-8014-beb6dc3fedbf porting_order_id: 9d7b3b8e-4e67-4837-9c44-d110cd2c82a1 record_type: porting_additional_document updated_at: '2023-06-01T10:00:00.00000Z' properties: data: items: $ref: '#/components/schemas/PortingAdditionalDocument' type: array type: object description: Successful response CancelPortingOrderResponse: content: application/json: schema: example: data: activation_settings: activation_status: null fast_port_eligible: true foc_datetime_actual: null foc_datetime_requested: '2022-04-08T15:00:00Z' created_at: '2022-03-24T14:22:28Z' customer_group_reference: Group-789 customer_reference: Test1234 description: FP Telnyx documents: invoice: 3a5b98a0-5049-47c3-96e1-aa6c8d119117 loa: 3a5b98a0-5049-47c3-96e1-aa6c8d119117 end_user: admin: account_number: 123abc auth_person_name: Porter McPortersen II billing_phone_number: '+13035551234' business_identifier: abc123 entity_name: Porter McPortersen pin_passcode: '1234' tax_identifier: 1234abcd location: administrative_area: TX country_code: US extended_address: 14th Floor locality: Austin postal_code: '78701' street_address: 600 Congress Avenue id: eef10fb8-f3df-4c67-97c5-e18179723222 misc: new_billing_phone_number: null remaining_numbers_action: null type: full old_service_provider_ocn: Unreal Communications parent_support_key: pr_4bec1a phone_number_configuration: billing_group_id: null connection_id: '1752379429071357070' emergency_address_id: null messaging_profile_id: null tags: [] phone_number_type: local porting_phone_numbers_count: 1 record_type: porting_order requirements: [] requirements_met: true status: details: [] value: cancel-pending support_key: sr_10b316 updated_at: '2022-03-24T16:43:35Z' user_feedback: user_comment: null user_rating: null user_id: 40d68ba2-0847-4df2-be9c-b0e0cb673e75 webhook_url: https://example.com/porting_webhooks meta: phone_numbers_url: /v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222 properties: data: $ref: '#/components/schemas/PortingOrder' meta: properties: phone_numbers_url: description: Link to list all phone numbers type: string type: object type: object description: Successful response ListPortingOrderRequirements: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingOrderRequirementDetail' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingPhoneNumberConfigurations: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingPhoneNumberConfiguration' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response schemas: PortingEventDeletedPayload: properties: available_notification_methods: description: Indicates the notification methods used. items: enum: - email - webhook - webhook_v1 type: string type: array event_type: description: Identifies the event type enum: - porting_order.deleted example: porting_order.deleted type: string id: description: Uniquely identifies the event. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string payload: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string customer_reference: description: Identifies the customer reference associated with the porting order. example: my-ref-001 type: string deleted_at: description: ISO 8601 formatted date indicating when the porting order was deleted. example: '2021-03-19T10:07:15.527Z' format: date-time type: string id: description: Identifies the porting order that was deleted. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_event readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object payload_status: description: The status of the payload generation. enum: - created - completed example: created type: string porting_order_id: description: Identifies the porting order associated with the event. example: 9471c873-e3eb-4ca1-957d-f9a451334d52 format: uuid type: string type: object PortingOrdersExceptionType: properties: code: description: Identifier of an exception type enum: - ACCOUNT_NUMBER_MISMATCH - AUTH_PERSON_MISMATCH - BTN_ATN_MISMATCH - ENTITY_NAME_MISMATCH - FOC_EXPIRED - FOC_REJECTED - LOCATION_MISMATCH - LSR_PENDING - MAIN_BTN_PORTING - OSP_IRRESPONSIVE - OTHER - PASSCODE_PIN_INVALID - PHONE_NUMBER_HAS_SPECIAL_FEATURE - PHONE_NUMBER_MISMATCH - PHONE_NUMBER_NOT_PORTABLE - PORT_TYPE_INCORRECT - PORTING_ORDER_SPLIT_REQUIRED - POSTAL_CODE_MISMATCH - RATE_CENTER_NOT_PORTABLE - SV_CONFLICT - SV_UNKNOWN_FAILURE example: ENTITY_NAME_MISMATCH type: string description: description: Description of an exception type example: Entity name does not match that on the CSR type: string type: object PortingOrderActivationStatus: description: Activation status enum: - New - Pending - Conflict - Cancel Pending - Failed - Concurred - Activate RDY - Disconnect Pending - Concurrence Sent - Old - Sending - Active - Cancelled example: Active type: string UpdatePortingOrderRequirement: description: Specifies a value for a requirement on the Porting Order. properties: field_value: description: identifies the document or provides the text value that satisfies this requirement example: 9787fb5f-cbe5-4de4-b765-3303774ee9fe type: string requirement_type_id: description: Identifies the requirement type that the `field_value` fulfills example: 59b0762a-b274-4f76-ac32-4d5cf0272e66 type: string required: - field_value - requirement_type_id type: object PortingEventMessagingChangedPayload: properties: available_notification_methods: description: Indicates the notification methods used. items: enum: - email - webhook - webhook_v1 type: string type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string event_type: description: Identifies the event type enum: - porting_order.messaging_changed example: porting_order.messaging_changed type: string id: description: Uniquely identifies the event. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string payload: description: The webhook payload for the porting_order.messaging_changed event properties: customer_reference: description: Identifies the customer reference associated with the porting order. example: my-ref-001 type: string id: description: Identifies the porting order that was moved. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string messaging: description: The messaging portability status of the porting order. properties: enable_messaging: description: Indicates whether Telnyx will port messaging capabilities from the losing carrier. If false, any messaging capabilities will stay with their current provider. example: true type: boolean messaging_capable: description: Indicates whether the porting order is messaging capable. example: true type: boolean messaging_port_completed: description: Indicates whether the messaging port is completed. example: true type: boolean messaging_port_status: description: Indicates the messaging port status of the porting order. enum: - not_applicable - pending - activating - exception - canceled - partial_port_complete - ported example: ported type: string type: object support_key: description: Identifies the support key associated with the porting order. example: sr_b1a2c3 type: string type: object payload_status: description: The status of the payload generation. enum: - created - completed example: created type: string porting_order_id: description: Identifies the porting order associated with the event. example: 9471c873-e3eb-4ca1-957d-f9a451334d52 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_event readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingOrderUserFeedback: properties: user_comment: description: A comment related to the customer rating. example: I loved my experience porting numbers with Telnyx type: - string - 'null' user_rating: description: Once an order is ported, cancellation is requested or the request is cancelled, the user may rate their experience example: 5 type: - integer - 'null' type: object PortingEventWithoutWebhook: properties: available_notification_methods: description: Indicates the notification methods used. items: enum: - email - webhook - webhook_v1 type: string type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string event_type: description: Identifies the event type enum: - porting_order.loa_updated - porting_order.sharing_token_expired example: porting_order.loa_updated type: string id: description: Uniquely identifies the event. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string payload: type: 'null' payload_status: description: The status of the payload generation. enum: - created - completed example: created type: string porting_order_id: description: Identifies the porting order associated with the event. example: 9471c873-e3eb-4ca1-957d-f9a451334d52 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_event readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingOrdersAllowedFocWindow: properties: ended_at: description: ISO 8601 formatted date indicating the end of the range of foc window example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string record_type: description: Identifies the type of the resource. example: porting_order readOnly: true type: string started_at: description: ISO 8601 formatted date indicating the start of the range of foc window. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string title: PortingOrdersAllowedFocWindow type: object PortingPhoneNumberConfiguration: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string id: description: Uniquely identifies this phone number configuration example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string porting_phone_number_id: description: Identifies the associated porting phone number example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_phone_number_configuration readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string user_bundle_id: description: Identifies the associated user bundle example: daa4308e-742f-4867-97f2-3073db13319a format: uuid type: string type: object PortingVerificationCode: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string id: description: Uniquely identifies this porting verification code example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string phone_number: description: E164 formatted phone number example: '+13035550987' type: string porting_order_id: description: Identifies the associated porting order example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_verification_code readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string verified: description: Indicates whether the verification code has been verified example: true type: boolean type: object PaginationMeta: properties: page_number: example: 2 type: integer page_size: example: 25 type: integer total_pages: example: 3 type: integer total_results: example: 55 type: integer type: object PortingOrdersActivationJob: properties: activate_at: description: ISO 8601 formatted date indicating when the activation job should be executed. This time should be between some activation window. example: '2021-03-19T10:07:15.527Z' format: date-time type: string activation_type: description: Specifies the type of this activation job enum: - scheduled - on-demand type: string activation_windows: description: List of allowed activation windows for this activation job items: properties: end_at: description: ISO 8601 formatted date indicating when the activation window ends example: '2021-03-19T10:07:15.527Z' format: date-time type: string start_at: description: ISO 8601 formatted date indicating when the activation window starts example: '2021-03-19T10:07:15.527Z' format: date-time type: string type: object type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string id: description: Uniquely identifies this activation job example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid readOnly: true type: string record_type: description: Identifies the type of the resource. example: porting_activation_job readOnly: true type: string status: description: Specifies the status of this activation job enum: - created - in-process - completed - failed type: string updated_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string type: object PortabilityStatus: description: Specifies whether Telnyx is able to confirm portability this number in the United States & Canada. International phone numbers are provisional by default. enum: - pending - confirmed - provisional example: confirmed type: string PortingPhoneNumberBlock: properties: activation_ranges: description: Specifies the activation ranges for this porting phone number block. The activation range must be within the phone number range and should not overlap with other activation ranges. items: properties: end_at: description: Specifies the end of the activation range. It must be no more than the end of the phone number range. example: '+4930244999910' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the activation range. Must be greater or equal the start of the phone number range. example: '+4930244999901' pattern: ^\+\d{7,15}$ type: string type: object type: array country_code: description: Specifies the country code for this porting phone number block. It is a two-letter ISO 3166-1 alpha-2 country code. example: DE type: string created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string id: description: Uniquely identifies this porting phone number block. example: f24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid readOnly: true type: string phone_number_range: description: Specifies the phone number range for this porting phone number block. properties: end_at: description: Specifies the end of the phone number range for this porting phone number block. example: '+4930244999910' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the phone number range for this porting phone number block. example: '+4930244999901' pattern: ^\+\d{7,15}$ type: string type: object phone_number_type: description: Specifies the phone number type for this porting phone number block. enum: - landline - local - mobile - national - shared_cost - toll_free example: local type: string record_type: description: Identifies the type of the resource. example: porting_phone_number_block readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was last updated. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string type: object PortingOrderPhoneNumberConfiguration: properties: billing_group_id: description: identifies the billing group to set on the numbers when ported example: f1486bae-f067-460c-ad43-73a92848f902 type: - string - 'null' connection_id: description: identifies the connection to set on the numbers when ported example: f1486bae-f067-460c-ad43-73a92848f902 type: - string - 'null' emergency_address_id: description: identifies the emergency address to set on the numbers when ported example: f1486bae-f067-460c-ad43-73a92848f902 type: - string - 'null' messaging_profile_id: description: identifies the messaging profile to set on the numbers when ported example: f1486bae-f067-460c-ad43-73a92848f901 type: - string - 'null' tags: example: - abc - '123' items: description: Tag to set on the numbers when ported type: string type: array type: object PortingOrderEndUserLocation: properties: administrative_area: description: State, province, or similar of billing address example: TX type: - string - 'null' country_code: description: ISO3166-1 alpha-2 country code of billing address example: US type: - string - 'null' extended_address: description: Second line of billing address example: 14th Floor type: - string - 'null' locality: description: City or municipality of billing address example: Austin type: - string - 'null' postal_code: description: Postal Code of billing address example: '78701' type: - string - 'null' street_address: description: First line of billing address example: 600 Congress Avenue type: - string - 'null' type: object PortingOrderRequirementDetail: properties: field_type: description: Type of value expected on field_value field enum: - document - textual example: document type: string field_value: description: Identifies the document that satisfies this requirement example: 9787fb5f-cbe5-4de4-b765-3303774ee9fe type: string record_type: description: Identifies the type of the resource. example: porting_requirement type: string requirement_status: description: Status of the requirement example: approved type: string requirement_type: description: Identifies the requirement type that meets this requirement properties: acceptance_criteria: additionalProperties: true description: The acceptance criteria for the requirement type example: acceptable_values: [] type: object description: description: A description of the requirement type example: A copy of the latest phone bill from the current provider type: string example: description: An example of the requirement type example: Most recent phone bill type: string id: description: Identifies the requirement type example: 53970723-fbff-4f46-a975-f62be6c1a585 type: string name: description: The name of the requirement type example: Latest Invoice type: string type: description: The type of the requirement type example: document type: string type: object type: object PortingPhoneNumberExtension: properties: activation_ranges: description: Specifies the activation ranges for this porting phone number extension. The activation range must be within the extension range and should not overlap with other activation ranges. items: properties: end_at: description: Specifies the end of the activation range. It must be no more than the end of the extension range. example: 10 type: integer start_at: description: Specifies the start of the activation range. Must be greater or equal the start of the extension range. example: 1 type: integer type: object type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string extension_range: description: Specifies the extension range for this porting phone number extension. properties: end_at: description: Specifies the end of the extension range for this porting phone number extension. example: 10 type: integer start_at: description: Specifies the start of the extension range for this porting phone number extension. example: 1 type: integer type: object id: description: Uniquely identifies this porting phone number extension. example: f24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid readOnly: true type: string porting_phone_number_id: description: Identifies the porting phone number associated with this porting phone number extension. example: f24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_phone_number_extension readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was last updated. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string type: object PortingEventNewCommentEvent: properties: available_notification_methods: description: Indicates the notification methods used. items: enum: - email - webhook - webhook_v1 type: string type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string event_type: description: Identifies the event type enum: - porting_order.new_comment example: porting_order.new_comment type: string id: description: Uniquely identifies the event. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string payload: description: The webhook payload for the porting_order.new_comment event properties: comment: description: The comment that was added to the porting order. properties: body: description: The body of the comment. example: This is a comment. type: string id: description: Identifies the comment. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string inserted_at: description: ISO 8601 formatted date indicating when the comment was created. example: '2021-03-19T10:07:15.527Z' format: date-time type: string user_id: description: Identifies the user that create the comment. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string user_type: description: Identifies the type of the user that created the comment. enum: - user - admin - system example: user type: string type: object porting_order_id: description: Identifies the porting order that the comment was added to. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string support_key: description: Identifies the support key associated with the porting order. example: sr_b1a2c3 type: string type: object payload_status: description: The status of the payload generation. enum: - created - completed example: created type: string porting_order_id: description: Identifies the porting order associated with the event. example: 9471c873-e3eb-4ca1-957d-f9a451334d52 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_event readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingEvent: discriminator: mapping: porting_order.deleted: '#/components/schemas/PortingEventDeletedPayload' porting_order.loa_updated: '#/components/schemas/PortingEventWithoutWebhook' porting_order.messaging_changed: '#/components/schemas/PortingEventMessagingChangedPayload' porting_order.new_comment: '#/components/schemas/PortingEventNewCommentEvent' porting_order.sharing_token_expired: '#/components/schemas/PortingEventWithoutWebhook' porting_order.split: '#/components/schemas/PortingEventSplitEvent' porting_order.status_changed: '#/components/schemas/PortingEventStatusChangedEvent' propertyName: event_type oneOf: - $ref: '#/components/schemas/PortingEventDeletedPayload' - $ref: '#/components/schemas/PortingEventMessagingChangedPayload' - $ref: '#/components/schemas/PortingEventStatusChangedEvent' - $ref: '#/components/schemas/PortingEventNewCommentEvent' - $ref: '#/components/schemas/PortingEventSplitEvent' - $ref: '#/components/schemas/PortingEventWithoutWebhook' type: object PortingLOAConfiguration: properties: address: description: The address of the company. properties: city: description: The locality of the company example: Austin type: string country_code: description: The country code of the company example: US pattern: ^[A-Z]{2}$ type: string extended_address: description: The extended address of the company example: 14th Floor type: string state: description: The administrative area of the company example: TX pattern: ^[A-Z]{2}$ type: string street_address: description: The street address of the company example: 600 Congress Avenue type: string zip_code: description: The postal code of the company example: '78701' pattern: ^[0-9]{5}(?:-[0-9]{4})?$ type: string type: object company_name: description: The name of the company example: Telnyx type: string contact: description: The contact information of the company. properties: email: description: The email address of the contact example: testing@telnyx.com type: string phone_number: description: The phone number of the contact example: '+12003270001' pattern: ^\+\d{11,15}$ type: string type: object created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string id: description: Uniquely identifies the LOA configuration. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string logo: description: The logo to be used in the LOA. properties: content_type: description: The content type of the logo. enum: - image/png example: image/png type: string document_id: description: Identifies the document that contains the logo. example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string type: object name: description: The name of the LOA configuration example: My LOA Configuration type: string organization_id: description: The organization that owns the LOA configuration example: f1486bae-f067-460c-ad43-73a92848f902 type: string record_type: description: Identifies the type of the resource. example: porting_loa_configuration readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingOrderEndUserAdmin: properties: account_number: description: The authorized person's account number with the current service provider example: 123abc type: - string - 'null' auth_person_name: description: Name of person authorizing the porting order example: Porter McPortersen II type: - string - 'null' billing_phone_number: description: Billing phone number associated with these phone numbers example: '13035551234' type: - string - 'null' business_identifier: description: European business identification number. Applicable only in the European Union example: abc123 type: - string - 'null' entity_name: description: Person Name or Company name requesting the port example: Porter McPortersen type: - string - 'null' pin_passcode: description: PIN/passcode possibly required by the old service provider for extra verification example: '1234' type: - string - 'null' tax_identifier: description: European tax identification number. Applicable only in the European Union example: 1234abcd type: - string - 'null' type: object PortingOrder: properties: activation_settings: $ref: '#/components/schemas/PortingOrderActivationSettings' additional_steps: description: For specific porting orders, we may require additional steps to be taken before submitting the porting order. items: enum: - associated_phone_numbers - phone_number_verification_codes type: string type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string customer_group_reference: description: A customer-specified group reference for customer bookkeeping purposes example: Group-456 type: - string - 'null' customer_reference: description: A customer-specified reference number for customer bookkeeping purposes example: Acct 123abc type: - string - 'null' description: description: A description of the porting order example: FP Telnyx readOnly: true type: string documents: $ref: '#/components/schemas/PortingOrderDocuments' end_user: $ref: '#/components/schemas/PortingOrderEndUser' id: description: Uniquely identifies this porting order example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid readOnly: true type: string messaging: $ref: '#/components/schemas/PortingOrderMessaging' misc: anyOf: - $ref: '#/components/schemas/PortingOrderMisc' - type: 'null' old_service_provider_ocn: description: Identifies the old service provider example: Unreal Communications readOnly: true type: string parent_support_key: description: A key to reference for the porting order group when contacting Telnyx customer support. This information is not available for porting orders in `draft` state example: pr_123abc readOnly: true type: - string - 'null' phone_number_configuration: $ref: '#/components/schemas/PortingOrderPhoneNumberConfiguration' phone_number_type: description: The type of the phone number enum: - landline - local - mobile - national - shared_cost - toll_free example: local type: string phone_numbers: description: List of phone numbers associated with this porting order items: $ref: '#/components/schemas/PortingPhoneNumber' type: array porting_phone_numbers_count: description: Count of phone numbers associated with this porting order example: 1 readOnly: true type: integer record_type: description: Identifies the type of the resource. example: porting_order readOnly: true type: string requirements: description: List of documentation requirements for porting numbers. Can be set directly or via the `requirement_group_id` parameter. items: $ref: '#/components/schemas/PortingOrderRequirement' type: array requirements_met: description: Is true when the required documentation is met example: false type: boolean status: $ref: '#/components/schemas/PortingOrderStatus' support_key: description: A key to reference this porting order when contacting Telnyx customer support. This information is not available in draft porting orders. example: sr_123abc readOnly: true type: - string - 'null' updated_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string user_feedback: $ref: '#/components/schemas/PortingOrderUserFeedback' user_id: description: Identifies the user (or organization) who requested the porting order example: 40d68ba2-0847-4df2-be9c-b0e0cb673e75 format: uuid type: string webhook_url: example: https://example.com/porting_webhooks format: uri type: - string - 'null' type: object PortingPhoneNumber: properties: activation_status: $ref: '#/components/schemas/PortingOrderActivationStatus' phone_number: description: E164 formatted phone number example: '13035550987' type: string phone_number_type: description: The type of the phone number enum: - landline - local - mobile - national - shared_cost - toll_free example: local type: string portability_status: $ref: '#/components/schemas/PortabilityStatus' porting_order_id: description: Identifies the associated port request example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string porting_order_status: description: The current status of the porting order enum: - draft - in-process - submitted - exception - foc-date-confirmed - cancel-pending - ported - cancelled example: in-process type: string record_type: description: Identifies the type of the resource. example: porting_phone_number readOnly: true type: string requirements_status: description: The current status of the requirements in a INTL porting order enum: - requirement-info-pending - requirement-info-under-review - requirement-info-exception - approved example: approved type: string support_key: description: A key to reference this porting order when contacting Telnyx customer support example: sr_a12345 type: string type: object PortingOrderSharingToken: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string expires_at: description: ISO 8601 formatted date indicating when the sharing token expires. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string expires_in_seconds: description: The number of seconds until the sharing token expires example: 3600 minimum: 1 type: integer id: description: Uniquely identifies this sharing token example: 0a4b78a0-d416-4761-94f7-46c72ec56547 format: uuid type: string permissions: description: The permissions granted to the sharing token example: - porting_order.document.read - porting_order.document.update items: enum: - porting_order.document.read - porting_order.document.update type: string type: array porting_order_id: description: Identifies the porting order resource being shared example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_order_sharing_token readOnly: true type: string token: description: A signed JWT token that can be used to access the shared resource example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODk4OTQ2NzcsImlzdCI6MTY4OTg5MTA3NywicGVybWlzc2lvbnMiOlsicG9ydGluZ19vcmRlci5kb2N1bWVudC5yZWFkIl0sInBvcnRpbmdfb3JkZXJfaWQiOiJmZDRiODZjOC00OTdkLTRjNmQtOTYwOS1hNzg5ZTRlMTRjZmUifQ.CT0HRF6OLj7VPZ8p5Y_0S8rOL8SEUznwJJkR-YReKwc type: string type: object PortingOrdersComment: properties: body: description: Body of comment example: Great experience so far type: string created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527Z' format: date-time type: string id: example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string porting_order_id: example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_comment type: string user_type: description: Indicates whether this comment was created by a Telnyx Admin, user, or system enum: - admin - user - system example: user type: string type: object PortingAdditionalDocument: properties: content_type: description: The content type of the related document. example: text/plain type: string created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string document_id: description: Identifies the associated document example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string document_type: description: Identifies the type of additional document enum: - loa - invoice - csr - other example: loa type: string filename: description: The filename of the related document. example: file.txt type: string id: description: Uniquely identifies this additional document example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string porting_order_id: description: Identifies the associated porting order example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_additional_document readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object UpdatePortingOrder: properties: activation_settings: properties: foc_datetime_requested: description: ISO 8601 formatted Date/Time requested for the FOC date example: '2021-03-19T10:07:15.527Z' format: date-time type: string type: object customer_group_reference: type: string customer_reference: type: string documents: $ref: '#/components/schemas/PortingOrderDocuments' end_user: $ref: '#/components/schemas/PortingOrderEndUser' messaging: properties: enable_messaging: description: Indicates whether Telnyx will port messaging capabilities from the losing carrier. If false, any messaging capabilities will stay with their current provider. example: true type: boolean type: object misc: anyOf: - $ref: '#/components/schemas/PortingOrderMisc' - type: 'null' phone_number_configuration: $ref: '#/components/schemas/PortingOrderPhoneNumberConfiguration' requirement_group_id: description: If present, we will read the current values from the specified Requirement Group into the Documents and Requirements for this Porting Order. Note that any future changes in the Requirement Group would have no impact on this Porting Order. We will return an error if a specified Requirement Group conflicts with documents or requirements in the same request. example: DE748D99-06FA-4D90-9F9A-F4B62696BADA format: uuid type: string requirements: description: 'List of requirements for porting numbers. ' items: $ref: '#/components/schemas/UpdatePortingOrderRequirement' type: array user_feedback: $ref: '#/components/schemas/PortingOrderUserFeedback' webhook_url: format: uri type: string title: UpdatePortingOrder type: object PortingAssociatedPhoneNumber: properties: action: description: Specifies the action to take with this phone number during partial porting. enum: - keep - disconnect example: keep type: string country_code: description: Specifies the country code for this associated phone number. It is a two-letter ISO 3166-1 alpha-2 country code. example: GB type: string created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string id: description: Uniquely identifies this associated phone number. example: f24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid readOnly: true type: string phone_number_range: description: Specifies the phone number range for this associated phone number. properties: end_at: description: Specifies the end of the phone number range for this associated phone number. example: '+441234567899' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the phone number range for this associated phone number. example: '+441234567890' pattern: ^\+\d{7,15}$ type: string type: object phone_number_type: description: Specifies the phone number type for this associated phone number. enum: - landline - local - mobile - national - shared_cost - toll_free example: local type: string porting_order_id: description: Identifies the porting order associated with this phone number. example: a24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_associated_phone_number readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was last updated. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string type: object PortingActionRequirement: properties: action_type: description: The type of action required example: document_upload type: string action_url: description: Optional URL for the action example: https://example.com/action type: - string - 'null' cancel_reason: description: Reason for cancellation if status is 'cancelled' example: null type: - string - 'null' created_at: description: ISO 8601 formatted date-time indicating when the resource was created example: '2018-02-02T22:25:27.521Z' format: date-time type: string id: description: Identifies the action requirement example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 type: string porting_order_id: description: The ID of the porting order this action requirement belongs to example: 12ade33a-21c0-473b-b055-b3c836e1c292 type: string record_type: description: Identifies the type of the resource enum: - porting_action_requirement example: porting_action_requirement type: string requirement_type_id: description: The ID of the requirement type example: 53970723-fbff-4f46-a975-f62be6c1a585 type: string status: description: Current status of the action requirement enum: - created - pending - completed - cancelled - failed example: created type: string updated_at: description: ISO 8601 formatted date-time indicating when the resource was updated example: '2018-02-02T22:25:27.521Z' format: date-time type: string type: object PortingReport: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string document_id: description: Identifies the document that was uploaded when report was generated. This field is only populated when the report is under completed status. example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string id: description: Uniquely identifies the report. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string params: oneOf: - $ref: '#/components/schemas/ExportPortingOrdersCSVReport' record_type: description: Identifies the type of the resource. example: porting_report readOnly: true type: string report_type: description: Identifies the type of report enum: - export_porting_orders_csv example: export_porting_orders_csv type: string status: description: The current status of the report generation. enum: - pending - completed example: completed type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object CreatePortingOrder: properties: customer_group_reference: description: A customer-specified group reference for customer bookkeeping purposes example: Group-456 type: string customer_reference: description: A customer-specified reference number for customer bookkeeping purposes example: Acct 123abc type: - string - 'null' phone_numbers: description: The list of +E.164 formatted phone numbers example: - '+13035550000' - '+13035550001' - '+13035550002' items: type: string type: array required: - phone_numbers title: CreatePortingOrder type: object PortingOrderMessaging: description: Information about messaging porting process. properties: enable_messaging: description: Indicates whether Telnyx will port messaging capabilities from the losing carrier. If false, any messaging capabilities will stay with their current provider. example: true type: boolean messaging_capable: description: Indicates whether the porting order can also port messaging capabilities. example: true type: boolean messaging_port_completed: description: Indicates whether the messaging porting has been completed. example: false type: boolean messaging_port_status: description: The current status of the messaging porting. enum: - not_applicable - pending - activating - exception - canceled - partial_port_complete - ported example: pending type: string type: object PortingOrderType: description: A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted. enum: - full - partial example: full type: string PortingEventSplitEvent: properties: available_notification_methods: description: Indicates the notification methods used. items: enum: - email - webhook - webhook_v1 type: string type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string event_type: description: Identifies the event type enum: - porting_order.split example: porting_order.split type: string id: description: Uniquely identifies the event. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string payload: description: The webhook payload for the porting_order.split event properties: from: description: The porting order that was split. properties: id: description: Identifies the porting order that was split. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string type: object porting_phone_numbers: description: The list of porting phone numbers that were moved to the new porting order. items: properties: id: description: Identifies the porting phone number that was moved. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string type: object type: array to: description: The new porting order that the phone numbers was moved to. properties: id: description: Identifies the porting order that was split. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string type: object type: object payload_status: description: The status of the payload generation. enum: - created - completed example: created type: string porting_order_id: description: Identifies the porting order associated with the event. example: 9471c873-e3eb-4ca1-957d-f9a451334d52 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_event readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingOrderMisc: properties: new_billing_phone_number: description: New billing phone number for the remaining numbers. Used in case the current billing phone number is being ported to Telnyx. This will be set on your account with your current service provider and should be one of the numbers remaining on that account. type: - string - 'null' remaining_numbers_action: description: 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'. enum: - keep - disconnect - null example: disconnect type: - string - 'null' type: $ref: '#/components/schemas/PortingOrderType' type: object GetSubRequestByPortingOrder: properties: port_request_id: description: Identifies the Port Request associated with the Porting Order example: 59b0762a-b274-4f76-ac32-4d5cf0272e66 type: string sub_request_id: description: Identifies the Sub Request associated with the Porting Order example: 9787fb5f-cbe5-4de4-b765-3303774ee9fe type: string type: object ExportPortingOrdersCSVReport: description: The parameters for generating a porting orders CSV report. properties: filters: description: The filters to apply to the export porting order CSV report. properties: created_at__gt: description: The date and time the porting order was created after. format: date-time type: string created_at__lt: description: The date and time the porting order was created before. format: date-time type: string customer_reference__in: description: The customer reference of the porting orders to include in the report. items: example: my-customer-reference type: string type: array status__in: description: The status of the porting orders to include in the report. items: enum: - draft - in-process - submitted - exception - foc-date-confirmed - cancel-pending - ported - cancelled type: string type: array type: object required: - filters type: object PortingOrderDocuments: description: Can be specified directly or via the `requirement_group_id` parameter. properties: invoice: description: Returned ID of the submitted Invoice via the Documents endpoint example: ce74b771-d23d-4960-81ec-8741b3862146 format: uuid type: - string - 'null' loa: description: Returned ID of the submitted LOA via the Documents endpoint example: 64ffb720-04c7-455b-92d6-20fcca92e935 format: uuid type: - string - 'null' type: object CreatePortingOrderComment: properties: body: example: Please, let me know when the port completes type: string type: object AUIdVerificationParams: description: Required information for initiating the action requirement for AU ID verification. properties: first_name: description: The first name of the person that will perform the verification flow. example: John type: string last_name: description: The last name of the person that will perform the verification flow. example: Doe type: string required: - first_name - last_name type: object PortingUKCarrier: properties: alternative_cupids: description: Alternative CUPIDs of the carrier. items: description: An alternative CUPID of the carrier. example: '895' type: string type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string cupid: description: The CUPID of the carrier. This is a 3 digit number code that identifies the carrier in the UK. example: '895' type: string id: description: Identifies the UK carrier. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string name: description: The name of the carrier. example: Telnyx UK Limited type: string record_type: description: Identifies the type of the resource. example: porting_uk_carrier type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingOrderStatus: description: Porting order status properties: details: description: A list of 0 or more details about this porting order's status items: $ref: '#/components/schemas/PortingOrdersExceptionType' type: array value: description: The current status of the porting order enum: - draft - in-process - submitted - exception - foc-date-confirmed - ported - cancelled - cancel-pending example: ported type: string type: object PortingOrderEndUser: properties: admin: $ref: '#/components/schemas/PortingOrderEndUserAdmin' location: $ref: '#/components/schemas/PortingOrderEndUserLocation' type: object PortingOrderActivationSettings: properties: activation_status: anyOf: - $ref: '#/components/schemas/PortingOrderActivationStatus' - type: 'null' fast_port_eligible: description: Indicates whether this porting order is eligible for FastPort example: true readOnly: true type: boolean foc_datetime_actual: description: ISO 8601 formatted Date/Time of the FOC date example: '2021-03-19T10:07:15.527Z' format: date-time type: - string - 'null' foc_datetime_requested: description: ISO 8601 formatted Date/Time requested for the FOC date example: '2021-03-19T10:07:15.527Z' format: date-time type: - string - 'null' type: object PortingEventStatusChangedEvent: properties: available_notification_methods: description: Indicates the notification methods used. items: enum: - email - webhook - webhook_v1 type: string type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string event_type: description: Identifies the event type enum: - porting_order.status_changed example: porting_order.status_changed type: string id: description: Uniquely identifies the event. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string payload: description: The webhook payload for the porting_order.status_changed event properties: customer_reference: description: Identifies the customer reference associated with the porting order. example: my-ref-001 type: string id: description: Identifies the porting order that was moved. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string status: $ref: '#/components/schemas/PortingOrderStatus' support_key: description: Identifies the support key associated with the porting order. example: sr_b1a2c3 type: string updated_at: description: ISO 8601 formatted date indicating when the porting order was moved. example: '2021-03-19T10:07:15.527Z' format: date-time type: string webhook_url: description: The URL to send the webhook to. example: https://example.com/webhook type: string type: object payload_status: description: The status of the payload generation. enum: - created - completed example: created type: string porting_order_id: description: Identifies the porting order associated with the event. example: 9471c873-e3eb-4ca1-957d-f9a451334d52 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_event readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingOrderRequirement: properties: field_type: description: Type of value expected on field_value field enum: - document example: document type: string field_value: description: identifies the document that satisfies this requirement example: 9787fb5f-cbe5-4de4-b765-3303774ee9fe type: string record_type: description: Identifies the type of the resource. example: porting_requirement type: string requirement_type_id: description: Identifies the requirement type that meets this requirement example: 59b0762a-b274-4f76-ac32-4d5cf0272e66 type: string type: object parameters: PathPortingOrderID: description: Porting Order id in: path name: id required: true schema: format: uuid type: string QueryIncludePhoneNumbers: description: Include the first 50 phone number objects in the results in: query name: include_phone_numbers required: false schema: default: true type: boolean porting-order_FilterConsolidated: 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]' explode: true in: query name: filter schema: properties: activation_status: $ref: '#/components/schemas/PortingOrderActivationStatus' description: Filter results by activation status phone_number: description: Filter results by a list of phone numbers items: example: '+12003151212' type: string type: array portability_status: $ref: '#/components/schemas/PortabilityStatus' description: Filter results by portability status porting_order_id: description: Filter results by a list of porting order ids items: example: f3575e15-32ce-400e-a4c0-dd78800c20b0 format: uuid type: string type: array status: description: 'Filter porting orders by status(es). Originally: filter[status], filter[status][in][]' oneOf: - description: Filter by single status enum: - draft - in-process - submitted - exception - foc-date-confirmed - cancel-pending - ported - cancelled example: in-process type: string - description: Filter by multiple statuses (in operation) example: - in-process - submitted items: enum: - draft - in-process - submitted - exception - foc-date-confirmed - cancel-pending - ported - cancelled type: string type: array support_key: description: 'Filter results by support key(s). Originally: filter[support_key][eq], filter[support_key][in][]' oneOf: - description: Filter by exact support key match (eq operation) example: sr_a12345 type: string - description: Filter by multiple support keys (in operation) items: example: sr_a12345 type: string type: array type: object style: deepObject PathPortingOrdersActivationJobID: description: Activation Job Identifier in: path name: activationJobId required: true schema: format: uuid type: string porting-order_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject requestBodies: CreatePortingLOAConfiguration: content: application/json: schema: description: The parameters for creating a new LOA configuration. properties: address: description: The address of the company. properties: city: description: The locality of the company example: Austin type: string country_code: description: The country code of the company example: US pattern: ^[A-Z]{2}$ type: string extended_address: description: The extended address of the company example: 14th Floor type: string state: description: The administrative area of the company example: TX pattern: ^[A-Z]{2}$ type: string street_address: description: The street address of the company example: 600 Congress Avenue type: string zip_code: description: The postal code of the company example: '78701' pattern: ^[0-9]{5}(?:-[0-9]{4})?$ type: string required: - street_address - city - state - zip_code - country_code type: object company_name: description: The name of the company example: Telnyx type: string contact: description: The contact information of the company. properties: email: description: The email address of the contact example: testing@telnyx.com type: string phone_number: description: The phone number of the contact example: '+12003270001' pattern: ^\+\d{11,15}$ type: string required: - email - phone_number type: object logo: description: The logo of the LOA configuration properties: document_id: description: The document identification format: uuid type: string required: - document_id type: object name: description: The name of the LOA configuration example: My LOA Configuration type: string required: - name - logo - company_name - address - contact type: object required: true CreatePortingPhoneNumberConfigurations: content: application/json: schema: properties: phone_number_configurations: items: properties: porting_phone_number_id: description: Identifies the porting phone number to be configured. example: 927f4687-318c-44bc-9f2f-22a5898143a4 format: uuid type: string user_bundle_id: description: Identifies the user bundle to be associated with the porting phone number. example: ff901545-3e27-462a-ba9d-2b34654cab82 format: uuid type: string required: - porting_phone_number_id - user_bundle_id type: object maxItems: 20 type: array type: object description: A list of phone number configuration parameters required: true CreatePortingAdditionalDocuments: content: application/json: schema: example: additional_documents: - document_id: 22771a52-c43a-4539-80db-9dd9ec36e237 document_type: loa - document_id: d91474e6-4ebc-4ec1-b379-c596eeb405d6 document_type: invoice properties: additional_documents: items: properties: document_id: description: The document identification format: uuid type: string document_type: description: The type of document being created. enum: - loa - invoice - csr - other type: string type: object maxItems: 100 type: array type: object description: A list of additional document parameters required: true SharePortingOrder: content: application/json: schema: example: expires_in_seconds: 3600 permissions: porting_order.document.read properties: expires_in_seconds: description: The number of seconds the token will be valid for maximum: 172800 minimum: 1 type: integer permissions: description: The permissions the token will have enum: - porting_order.document.read - porting_order.document.update type: string type: object required: true CreatePortingAssociatedPhoneNumber: content: application/json: schema: properties: action: description: Specifies the action to take with this phone number during partial porting. enum: - keep - disconnect example: keep type: string phone_number_range: properties: end_at: description: Specifies the end of the phone number range for this associated phone number. example: '+441234567899' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the phone number range for this associated phone number. example: '+441234567890' pattern: ^\+\d{7,15}$ type: string type: object required: - phone_number_range - action type: object required: true CreatePortingPhoneNumberExtension: content: application/json: schema: properties: activation_ranges: description: Specifies the activation ranges for this porting phone number extension. The activation range must be within the extension range and should not overlap with other activation ranges. items: properties: end_at: description: Specifies the end of the activation range. It must be no more than the end of the extension range. example: 10 type: integer start_at: description: Specifies the start of the activation range. Must be greater or equal the start of the extension range. example: 1 type: integer required: - start_at - end_at type: object type: array extension_range: properties: end_at: description: Specifies the end of the extension range for this porting phone number extension. example: 10 type: integer start_at: description: Specifies the start of the extension range for this porting phone number extension. example: 1 type: integer required: - start_at - end_at type: object porting_phone_number_id: description: Identifies the porting phone number associated with this porting phone number extension. example: f24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid type: string required: - porting_phone_number_id - extension_range - activation_ranges type: object required: true InitiatePortingActionRequirement: content: application/json: schema: properties: params: oneOf: - $ref: '#/components/schemas/AUIdVerificationParams' required: - params type: object description: Parameters for initiating the action requirement required: true UpdatePortingOrdersActivationJob: content: application/json: schema: properties: activate_at: description: The desired activation time. The activation time should be between any of the activation windows. example: '2019-01-01T00:00:00Z' format: date-time type: string type: object required: true CreatePortingReport: content: application/json: schema: description: The parameters for generating a new porting related report. properties: params: oneOf: - $ref: '#/components/schemas/ExportPortingOrdersCSVReport' report_type: description: Identifies the type of report enum: - export_porting_orders_csv example: export_porting_orders_csv type: string required: - report_type - params type: object required: true VerifyPortingVerificationCodes: content: application/json: schema: example: verification_codes: - code: '12345' phone_number: '+61424000001' - code: '54321' phone_number: '+61424000002' properties: verification_codes: items: properties: code: type: string phone_number: type: string type: object maxItems: 100 type: array type: object description: A list of phone numbers and their verification codes required: true SendPortingVerificationCodes: content: application/json: schema: example: phone_numbers: - '+61424000001' - '+61424000002' verification_method: sms properties: phone_numbers: items: type: string maxItems: 100 type: array verification_method: enum: - sms - call type: string type: object description: A list of phone numbers to send the verification codes to and the method to send them by required: false CreatePortingPhoneNumberBlock: content: application/json: schema: properties: activation_ranges: description: Specifies the activation ranges for this porting phone number block. The activation range must be within the block range and should not overlap with other activation ranges. items: properties: end_at: description: Specifies the end of the activation range. It must be no more than the end of the extension range. example: '+4930244999910' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the activation range. Must be greater or equal the start of the extension range. example: '+4930244999901' pattern: ^\+\d{7,15}$ type: string required: - start_at - end_at type: object type: array phone_number_range: properties: end_at: description: Specifies the end of the phone number range for this porting phone number block. example: '+4930244999910' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the phone number range for this porting phone number block. example: '+4930244999901' pattern: ^\+\d{7,15}$ type: string required: - start_at - end_at type: object required: - phone_number_range - activation_ranges type: object required: true securitySchemes: bearerAuth: scheme: bearer type: http branded-calling_bearerAuth: description: API key passed as a Bearer token in the Authorization header scheme: bearer type: http oauthClientAuth: description: OAuth 2.0 authentication for Telnyx API and MCP integrations flows: authorizationCode: authorizationUrl: https://api.telnyx.com/v2/oauth/authorize refreshUrl: https://api.telnyx.com/v2/oauth/token scopes: admin: Administrative access to Telnyx resources tokenUrl: https://api.telnyx.com/v2/oauth/token clientCredentials: scopes: admin: Administrative access to Telnyx resources tokenUrl: https://api.telnyx.com/v2/oauth/token type: oauth2 outbound-voice-profiles_bearerAuth: bearerFormat: JWT scheme: bearer type: http pronunciation-dicts_bearerAuth: description: Telnyx API v2 key. Obtain from https://portal.telnyx.com scheme: bearer type: http stored-payment-transactions_bearerAuth: bearerFormat: JWT scheme: bearer type: http