All URIs are relative to https://api.telnyx.com/v2
| Method | HTTP request | Description |
|---|---|---|
| activatePortingOrder | POST /porting_orders/{id}/actions/activate | Activate every number in a porting order asynchronously. |
| cancelPortingOrder | POST /porting_orders/{id}/actions/cancel | Cancel a porting order |
| confirmPortingOrder | POST /porting_orders/{id}/actions/confirm | Submit a porting order. |
| createAdditionalDocuments | POST /porting_orders/{id}/additional_documents | Create a list of additional documents |
| createComment | POST /porting_orders/{id}/comments | Create a comment for a porting order |
| createLoaConfiguration | POST /porting/loa_configurations | Create a LOA configuration |
| createPhoneNumberConfigurations | POST /porting_orders/phone_number_configurations | Create a list of phone number configurations |
| createPortingOrder | POST /porting_orders | Create a porting order |
| createPortingReport | POST /porting/reports | Create a porting related report |
| deleteAdditionalDocument | DELETE /porting_orders/{id}/additional_documents/{additional_document_id} | Delete an additional document |
| deleteLoaConfiguration | DELETE /porting/loa_configurations/{id} | Delete a LOA configuration |
| deletePortingOrder | DELETE /porting_orders/{id} | Delete a porting order |
| getLoaConfiguration | GET /porting/loa_configurations/{id} | Retrieve a LOA configuration |
| getPortingOrder | GET /porting_orders/{id} | Retrieve a porting order |
| getPortingOrderLoaTemplate | GET /porting_orders/{id}/loa_template | Download a porting order loa template |
| getPortingOrderSubRequest | GET /porting_orders/{id}/sub_request | Retrieve the associated V1 sub_request_id and port_request_id |
| getPortingOrdersActivationJob | GET /porting_orders/{id}/activation_jobs/{activationJobId} | Retrieve a porting activation job |
| getPortingReport | GET /porting/reports/{id} | Retrieve a report |
| listAdditionalDocuments | GET /porting_orders/{id}/additional_documents | List additional documents |
| listAllowedFocWindows | GET /porting_orders/{id}/allowed_foc_windows | List allowed FOC dates |
| listExceptionTypes | GET /porting_orders/exception_types | List all exception types |
| listLoaConfigurations | GET /porting/loa_configurations | List LOA configurations |
| listPhoneNumberConfigurations | GET /porting_orders/phone_number_configurations | List all phone number configurations |
| listPortingOrderActivationJobs | GET /porting_orders/{id}/activation_jobs | List all porting activation jobs |
| listPortingOrderComments | GET /porting_orders/{id}/comments | List all comments of a porting order |
| listPortingOrderRequirements | GET /porting_orders/{id}/requirements | List porting order requirements |
| listPortingOrders | GET /porting_orders | List all porting orders |
| listPortingPhoneNumbers | GET /porting_phone_numbers | List all porting phone numbers |
| listPortingReports | GET /porting/reports | List porting related reports |
| listVerificationCodes | GET /porting_orders/{id}/verification_codes | List verification codes |
| previewLoaConfiguration | GET /porting/loa_configurations/{id}/preview | Preview a LOA configuration |
| previewLoaConfigurationParams | POST /porting/loa_configuration/preview | Preview the LOA configuration parameters |
| sendPortingVerificationCodes | POST /porting_orders/{id}/verification_codes/send | Send the verification codes |
| sharePortingOrder | POST /porting_orders/{id}/actions/share | Share a porting order |
| updateLoaConfiguration | PATCH /porting/loa_configurations/{id} | Update a LOA configuration |
| updatePortingOrder | PATCH /porting_orders/{id} | Edit a porting order |
| updatePortingOrdersActivationJob | PATCH /porting_orders/{id}/activation_jobs/{activationJobId} | Update a porting activation job |
| verifyPortingVerificationCodes | POST /porting_orders/{id}/verification_codes/verify | Verify the verification code for a list of phone numbers |
ActivatePortingOrder202Response activatePortingOrder(id)
Activate every number in a porting order asynchronously.
Activate each number in a porting order asynchronously. This operation is limited to US FastPort orders only.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
ActivatePortingOrder202Response result = apiInstance.activatePortingOrder(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#activatePortingOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id |
ActivatePortingOrder202Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 202 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
CancelPortingOrder200Response cancelPortingOrder(id)
Cancel a porting order
Cancel a porting order
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
CancelPortingOrder200Response result = apiInstance.cancelPortingOrder(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#cancelPortingOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
ConfirmPortingOrder200Response confirmPortingOrder(id)
Submit a porting order.
Confirm and submit your porting order.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
ConfirmPortingOrder200Response result = apiInstance.confirmPortingOrder(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#confirmPortingOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id |
ConfirmPortingOrder200Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
CreateAdditionalDocuments201Response createAdditionalDocuments(id, createAdditionalDocumentsRequest)
Create a list of additional documents
Creates a list of additional documents for a porting order.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
CreateAdditionalDocumentsRequest createAdditionalDocumentsRequest = new CreateAdditionalDocumentsRequest(); // CreateAdditionalDocumentsRequest | A list of additional document parameters
try {
CreateAdditionalDocuments201Response result = apiInstance.createAdditionalDocuments(id, createAdditionalDocumentsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#createAdditionalDocuments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| createAdditionalDocumentsRequest | CreateAdditionalDocumentsRequest | A list of additional document parameters |
CreateAdditionalDocuments201Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
| 404 | Resource not found | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
CreateComment201Response createComment(id, createPortingOrderComment)
Create a comment for a porting order
Creates a new comment for a porting order.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
CreatePortingOrderComment createPortingOrderComment = new CreatePortingOrderComment(); // CreatePortingOrderComment |
try {
CreateComment201Response result = apiInstance.createComment(id, createPortingOrderComment);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#createComment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| createPortingOrderComment | CreatePortingOrderComment |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
CreateLoaConfiguration201Response createLoaConfiguration(previewLoaConfigurationParamsRequest)
Create a LOA configuration
Create a LOA configuration.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
PreviewLoaConfigurationParamsRequest previewLoaConfigurationParamsRequest = new PreviewLoaConfigurationParamsRequest(); // PreviewLoaConfigurationParamsRequest |
try {
CreateLoaConfiguration201Response result = apiInstance.createLoaConfiguration(previewLoaConfigurationParamsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#createLoaConfiguration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| previewLoaConfigurationParamsRequest | PreviewLoaConfigurationParamsRequest |
CreateLoaConfiguration201Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
| 500 | Internal server error | - |
CreatePhoneNumberConfigurations201Response createPhoneNumberConfigurations(createPhoneNumberConfigurationsRequest)
Create a list of phone number configurations
Creates a list of phone number configurations.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
CreatePhoneNumberConfigurationsRequest createPhoneNumberConfigurationsRequest = new CreatePhoneNumberConfigurationsRequest(); // CreatePhoneNumberConfigurationsRequest | A list of phone number configuration parameters
try {
CreatePhoneNumberConfigurations201Response result = apiInstance.createPhoneNumberConfigurations(createPhoneNumberConfigurationsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#createPhoneNumberConfigurations");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| createPhoneNumberConfigurationsRequest | CreatePhoneNumberConfigurationsRequest | A list of phone number configuration parameters |
CreatePhoneNumberConfigurations201Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
CreatePortingOrder201Response createPortingOrder(createPortingOrder)
Create a porting order
Creates a new porting order object.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
CreatePortingOrder createPortingOrder = new CreatePortingOrder(); // CreatePortingOrder |
try {
CreatePortingOrder201Response result = apiInstance.createPortingOrder(createPortingOrder);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#createPortingOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| createPortingOrder | CreatePortingOrder |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
CreatePortingReport201Response createPortingReport(createPortingReportRequest)
Create a porting related report
Generate reports about porting operations.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
CreatePortingReportRequest createPortingReportRequest = new CreatePortingReportRequest(); // CreatePortingReportRequest |
try {
CreatePortingReport201Response result = apiInstance.createPortingReport(createPortingReportRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#createPortingReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| createPortingReportRequest | CreatePortingReportRequest |
CreatePortingReport201Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
| 500 | Internal server error | - |
deleteAdditionalDocument(id, additionalDocumentId)
Delete an additional document
Deletes an additional document for a porting order.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
UUID additionalDocumentId = UUID.randomUUID(); // UUID | Additional document identification.
try {
apiInstance.deleteAdditionalDocument(id, additionalDocumentId);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#deleteAdditionalDocument");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| additionalDocumentId | UUID | Additional document identification. |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No content | - |
| 404 | Resource not found | - |
| 401 | Unauthorized | - |
deleteLoaConfiguration(id)
Delete a LOA configuration
Delete a specific LOA configuration.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Identifies a LOA configuration.
try {
apiInstance.deleteLoaConfiguration(id);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#deleteLoaConfiguration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Identifies a LOA configuration. |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No content | - |
| 404 | Resource not found | - |
| 500 | Internal server error | - |
deletePortingOrder(id)
Delete a porting order
Deletes an existing porting order. This operation is restrict to porting orders in draft state.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
apiInstance.deletePortingOrder(id);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#deletePortingOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No content | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
CreateLoaConfiguration201Response getLoaConfiguration(id)
Retrieve a LOA configuration
Retrieve a specific LOA configuration.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Identifies a LOA configuration.
try {
CreateLoaConfiguration201Response result = apiInstance.getLoaConfiguration(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#getLoaConfiguration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Identifies a LOA configuration. |
CreateLoaConfiguration201Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | Resource not found | - |
| 500 | Internal server error | - |
GetPortingOrder200Response getPortingOrder(id, includePhoneNumbers)
Retrieve a porting order
Retrieves the details of an existing porting order.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
Boolean includePhoneNumbers = true; // Boolean | Include the first 50 phone number objects in the results
try {
GetPortingOrder200Response result = apiInstance.getPortingOrder(id, includePhoneNumbers);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#getPortingOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| includePhoneNumbers | Boolean | Include the first 50 phone number objects in the results | [optional] [default to true] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
File getPortingOrderLoaTemplate(id, loaConfigurationId)
Download a porting order loa template
Download a porting order loa template
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
UUID loaConfigurationId = UUID.fromString("a36c2277-446b-4d11-b4ea-322e02a5c08d"); // UUID | The identifier of the LOA configuration to use for the template. If not provided, the default LOA configuration will be used.
try {
File result = apiInstance.getPortingOrderLoaTemplate(id, loaConfigurationId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#getPortingOrderLoaTemplate");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| loaConfigurationId | UUID | The identifier of the LOA configuration to use for the template. If not provided, the default LOA configuration will be used. | [optional] |
- Content-Type: Not defined
- Accept: application/pdf
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
GetPortingOrderSubRequest200Response getPortingOrderSubRequest(id)
Retrieve the associated V1 sub_request_id and port_request_id
Retrieve the associated V1 sub_request_id and port_request_id
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
GetPortingOrderSubRequest200Response result = apiInstance.getPortingOrderSubRequest(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#getPortingOrderSubRequest");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id |
GetPortingOrderSubRequest200Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 404 | Porting Order not found | - |
ActivatePortingOrder202Response getPortingOrdersActivationJob(id, activationJobId)
Retrieve a porting activation job
Returns a porting activation job.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
UUID activationJobId = UUID.randomUUID(); // UUID | Activation Job Identifier
try {
ActivatePortingOrder202Response result = apiInstance.getPortingOrdersActivationJob(id, activationJobId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#getPortingOrdersActivationJob");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| activationJobId | UUID | Activation Job Identifier |
ActivatePortingOrder202Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
CreatePortingReport201Response getPortingReport(id)
Retrieve a report
Retrieve a specific report generated.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Identifies a report.
try {
CreatePortingReport201Response result = apiInstance.getPortingReport(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#getPortingReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Identifies a report. |
CreatePortingReport201Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | Resource not found | - |
| 500 | Internal server error | - |
ListAdditionalDocuments200Response listAdditionalDocuments(id, pageNumber, pageSize, filterDocumentType, filterDocumentTypeIn, sort)
List additional documents
Returns a list of additional documents for a porting order.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
String filterDocumentType = "loa"; // String | Filter additional documents of a specific document type
List<String> filterDocumentTypeIn = Arrays.asList(); // List<String> | Filter additional documents by a list of document types
String sort = "created_at"; // String | Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
try {
ListAdditionalDocuments200Response result = apiInstance.listAdditionalDocuments(id, pageNumber, pageSize, filterDocumentType, filterDocumentTypeIn, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listAdditionalDocuments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| pageNumber | Integer | The page number to load | [optional] [default to 1] |
| pageSize | Integer | The size of the page | [optional] [default to 20] |
| filterDocumentType | String | Filter additional documents of a specific document type | [optional] [enum: loa, invoice, csr, other] |
| filterDocumentTypeIn | List<String> | Filter additional documents by a list of document types | [optional] [enum: loa, invoice, csr, other] |
| sort | String | Specifies the sort order for results. If not given, results are sorted by created_at in descending order. | [optional] [enum: created_at, -created_at] |
ListAdditionalDocuments200Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | Resource not found | - |
| 401 | Unauthorized | - |
ListAllowedFocWindows200Response listAllowedFocWindows(id)
List allowed FOC dates
Returns a list of allowed FOC dates for a porting order.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
try {
ListAllowedFocWindows200Response result = apiInstance.listAllowedFocWindows(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listAllowedFocWindows");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id |
ListAllowedFocWindows200Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
ListExceptionTypes200Response listExceptionTypes()
List all exception types
Returns a list of all possible exception types for a porting order.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
try {
ListExceptionTypes200Response result = apiInstance.listExceptionTypes();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listExceptionTypes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
ListLoaConfigurations200Response listLoaConfigurations(pageNumber, pageSize)
List LOA configurations
List the LOA configurations.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
ListLoaConfigurations200Response result = apiInstance.listLoaConfigurations(pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listLoaConfigurations");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pageNumber | Integer | The page number to load | [optional] [default to 1] |
| pageSize | Integer | The size of the page | [optional] [default to 20] |
ListLoaConfigurations200Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
| 500 | Internal server error | - |
ListPhoneNumberConfigurations200Response listPhoneNumberConfigurations(pageNumber, pageSize, filterPortingOrderId, filterPortingOrderIdIn, filterUserBundleId, filterUserBundleIdIn, filterPortingPhoneNumber, filterPortingPhoneNumberIn, sort)
List all phone number configurations
Returns a list of phone number configurations paginated.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
UUID filterPortingOrderId = UUID.fromString("f3575e15-32ce-400e-a4c0-dd78800c20b0"); // UUID | Filter results by porting order id
List<UUID> filterPortingOrderIdIn = Arrays.asList(); // List<UUID> | Filter results by a list of porting order ids
UUID filterUserBundleId = UUID.fromString("5d6f7ede-1961-4717-bfb5-db392c5efc2d"); // UUID | Filter results by a specific user bundle ID
List<UUID> filterUserBundleIdIn = Arrays.asList(); // List<UUID> | Filter results by a list of user bundle IDs
UUID filterPortingPhoneNumber = UUID.fromString("5d6f7ede-1961-4717-bfb5-db392c5efc2d"); // UUID | Filter results by a specific porting phone number ID
List<UUID> filterPortingPhoneNumberIn = Arrays.asList(); // List<UUID> | Filter results by a list of porting phone number IDs
String sort = "created_at"; // String | Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
try {
ListPhoneNumberConfigurations200Response result = apiInstance.listPhoneNumberConfigurations(pageNumber, pageSize, filterPortingOrderId, filterPortingOrderIdIn, filterUserBundleId, filterUserBundleIdIn, filterPortingPhoneNumber, filterPortingPhoneNumberIn, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPhoneNumberConfigurations");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pageNumber | Integer | The page number to load | [optional] [default to 1] |
| pageSize | Integer | The size of the page | [optional] [default to 20] |
| filterPortingOrderId | UUID | Filter results by porting order id | [optional] |
| filterPortingOrderIdIn | List<UUID> | Filter results by a list of porting order ids | [optional] |
| filterUserBundleId | UUID | Filter results by a specific user bundle ID | [optional] |
| filterUserBundleIdIn | List<UUID> | Filter results by a list of user bundle IDs | [optional] |
| filterPortingPhoneNumber | UUID | Filter results by a specific porting phone number ID | [optional] |
| filterPortingPhoneNumberIn | List<UUID> | Filter results by a list of porting phone number IDs | [optional] |
| sort | String | Specifies the sort order for results. If not given, results are sorted by created_at in descending order. | [optional] [enum: created_at, -created_at] |
ListPhoneNumberConfigurations200Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
ListPortingOrderActivationJobs200Response listPortingOrderActivationJobs(id, pageNumber, pageSize)
List all porting activation jobs
Returns a list of your porting activation jobs.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
ListPortingOrderActivationJobs200Response result = apiInstance.listPortingOrderActivationJobs(id, pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingOrderActivationJobs");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| pageNumber | Integer | The page number to load | [optional] [default to 1] |
| pageSize | Integer | The size of the page | [optional] [default to 20] |
ListPortingOrderActivationJobs200Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
ListPortingOrderComments200Response listPortingOrderComments(id, pageNumber, pageSize)
List all comments of a porting order
Returns a list of all comments of a porting order.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
ListPortingOrderComments200Response result = apiInstance.listPortingOrderComments(id, pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingOrderComments");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| pageNumber | Integer | The page number to load | [optional] [default to 1] |
| pageSize | Integer | The size of the page | [optional] [default to 20] |
ListPortingOrderComments200Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
ListPortingOrderRequirements200Response listPortingOrderRequirements(id, pageNumber, pageSize)
List porting order requirements
Returns a list of all requirements based on country/number type for this porting order.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
try {
ListPortingOrderRequirements200Response result = apiInstance.listPortingOrderRequirements(id, pageNumber, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingOrderRequirements");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| pageNumber | Integer | The page number to load | [optional] [default to 1] |
| pageSize | Integer | The size of the page | [optional] [default to 20] |
ListPortingOrderRequirements200Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
ListPortingOrders200Response listPortingOrders(pageNumber, pageSize, includePhoneNumbers, filterStatus, filterStatusIn, filterCustomerReference, filterParentSupportKey, filterPhoneNumbersCountryCode, filterPhoneNumbersCarrierName, filterMiscType, filterEndUserAdminEntityName, filterEndUserAdminAuthPersonName, filterActivationSettingsFastPortEligible, filterActivationSettingsFocDatetimeRequestedGt, filterActivationSettingsFocDatetimeRequestedLt, filterPhoneNumbersPhoneNumberContains, sort)
List all porting orders
Returns a list of your porting order.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
Boolean includePhoneNumbers = true; // Boolean | Include the first 50 phone number objects in the results
String filterStatus = "draft"; // String | Filter results by status
String filterStatusIn = "draft"; // String | Filter porting orders by multiple statuses
String filterCustomerReference = "123abc"; // String | Filter results by customer_reference
String filterParentSupportKey = "123abc"; // String | Filter results by parent_support_key
String filterPhoneNumbersCountryCode = "US"; // String | Filter results by country ISO 3166-1 alpha-2 code
String filterPhoneNumbersCarrierName = "Telnyx"; // String | Filter results by old service provider
PortingOrderType filterMiscType = PortingOrderType.fromValue("full"); // PortingOrderType | Filter results by porting order type
String filterEndUserAdminEntityName = "Porter McPortersen"; // String | Filter results by person or company name
String filterEndUserAdminAuthPersonName = "Admin McPortersen"; // String | Filter results by authorized person
Boolean filterActivationSettingsFastPortEligible = false; // Boolean | Filter results by fast port eligible
String filterActivationSettingsFocDatetimeRequestedGt = "2021-03-25T10:00:00.000Z"; // String | Filter results by foc date later than this value
String filterActivationSettingsFocDatetimeRequestedLt = "2021-03-25T10:00:00.000Z"; // String | Filter results by foc date earlier than this value
String filterPhoneNumbersPhoneNumberContains = "+13038675309"; // String | Filter results by full or partial phone_number
String sort = "created_at"; // String | Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
try {
ListPortingOrders200Response result = apiInstance.listPortingOrders(pageNumber, pageSize, includePhoneNumbers, filterStatus, filterStatusIn, filterCustomerReference, filterParentSupportKey, filterPhoneNumbersCountryCode, filterPhoneNumbersCarrierName, filterMiscType, filterEndUserAdminEntityName, filterEndUserAdminAuthPersonName, filterActivationSettingsFastPortEligible, filterActivationSettingsFocDatetimeRequestedGt, filterActivationSettingsFocDatetimeRequestedLt, filterPhoneNumbersPhoneNumberContains, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingOrders");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pageNumber | Integer | The page number to load | [optional] [default to 1] |
| pageSize | Integer | The size of the page | [optional] [default to 20] |
| includePhoneNumbers | Boolean | Include the first 50 phone number objects in the results | [optional] [default to true] |
| filterStatus | String | Filter results by status | [optional] [enum: draft, in-process, submitted, exception, foc-date-confirmed, cancel-pending, ported, cancelled] |
| filterStatusIn | String | Filter porting orders by multiple statuses | [optional] [enum: draft, in-process, submitted, exception, foc-date-confirmed, cancel-pending, ported, cancelled] |
| filterCustomerReference | String | Filter results by customer_reference | [optional] |
| filterParentSupportKey | String | Filter results by parent_support_key | [optional] |
| filterPhoneNumbersCountryCode | String | Filter results by country ISO 3166-1 alpha-2 code | [optional] |
| filterPhoneNumbersCarrierName | String | Filter results by old service provider | [optional] |
| filterMiscType | PortingOrderType | Filter results by porting order type | [optional] [enum: full, partial] |
| filterEndUserAdminEntityName | String | Filter results by person or company name | [optional] |
| filterEndUserAdminAuthPersonName | String | Filter results by authorized person | [optional] |
| filterActivationSettingsFastPortEligible | Boolean | Filter results by fast port eligible | [optional] |
| filterActivationSettingsFocDatetimeRequestedGt | String | Filter results by foc date later than this value | [optional] |
| filterActivationSettingsFocDatetimeRequestedLt | String | Filter results by foc date earlier than this value | [optional] |
| filterPhoneNumbersPhoneNumberContains | String | Filter results by full or partial phone_number | [optional] |
| sort | String | Specifies the sort order for results. If not given, results are sorted by created_at in descending order. | [optional] [enum: created_at, -created_at, activation_settings.foc_datetime_requested, -activation_settings.foc_datetime_requested] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
ListPortingPhoneNumbers200Response listPortingPhoneNumbers(pageNumber, pageSize, filterPortingOrderId, filterPortingOrderIdIn, filterSupportKeyEq, filterSupportKeyIn, filterPhoneNumber, filterPhoneNumberIn, filterPortingOrderStatus, filterActivationStatus, filterPortabilityStatus)
List all porting phone numbers
Returns a list of your porting phone numbers.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
UUID filterPortingOrderId = UUID.fromString("f3575e15-32ce-400e-a4c0-dd78800c20b0"); // UUID | Filter results by porting order id
List<UUID> filterPortingOrderIdIn = Arrays.asList(); // List<UUID> | Filter results by a list of porting order ids
String filterSupportKeyEq = "sr_a12345"; // String | Filter results by support key
List<String> filterSupportKeyIn = Arrays.asList(); // List<String> | Filter results by a list of support keys
String filterPhoneNumber = "+12003151212"; // String | Filter results by phone number
List<String> filterPhoneNumberIn = Arrays.asList(); // List<String> | Filter results by a list of phone numbers
String filterPortingOrderStatus = "draft"; // String | Filter results by porting order status
PortingOrderActivationStatus filterActivationStatus = PortingOrderActivationStatus.fromValue("New"); // PortingOrderActivationStatus | Filter results by activation status
PortabilityStatus filterPortabilityStatus = PortabilityStatus.fromValue("pending"); // PortabilityStatus | Filter results by portability status
try {
ListPortingPhoneNumbers200Response result = apiInstance.listPortingPhoneNumbers(pageNumber, pageSize, filterPortingOrderId, filterPortingOrderIdIn, filterSupportKeyEq, filterSupportKeyIn, filterPhoneNumber, filterPhoneNumberIn, filterPortingOrderStatus, filterActivationStatus, filterPortabilityStatus);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingPhoneNumbers");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pageNumber | Integer | The page number to load | [optional] [default to 1] |
| pageSize | Integer | The size of the page | [optional] [default to 20] |
| filterPortingOrderId | UUID | Filter results by porting order id | [optional] |
| filterPortingOrderIdIn | List<UUID> | Filter results by a list of porting order ids | [optional] |
| filterSupportKeyEq | String | Filter results by support key | [optional] |
| filterSupportKeyIn | List<String> | Filter results by a list of support keys | [optional] |
| filterPhoneNumber | String | Filter results by phone number | [optional] |
| filterPhoneNumberIn | List<String> | Filter results by a list of phone numbers | [optional] |
| filterPortingOrderStatus | String | Filter results by porting order status | [optional] [enum: draft, in-process, submitted, exception, foc-date-confirmed, cancel-pending, ported, cancelled] |
| filterActivationStatus | PortingOrderActivationStatus | Filter results by activation status | [optional] [enum: New, Pending, Conflict, Cancel Pending, Failed, Concurred, Activate RDY, Disconnect Pending, Concurrence Sent, Old, Sending, Active, Canceled] |
| filterPortabilityStatus | PortabilityStatus | Filter results by portability status | [optional] [enum: pending, confirmed, provisional] |
ListPortingPhoneNumbers200Response
- Content-Type: Not defined
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
ListPortingReports200Response listPortingReports(pageNumber, pageSize, filterReportType, filterStatus)
List porting related reports
List the reports generated about porting operations.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
String filterReportType = "export_porting_orders_csv"; // String | Filter reports of a specific type
String filterStatus = "pending"; // String | Filter reports of a specific status
try {
ListPortingReports200Response result = apiInstance.listPortingReports(pageNumber, pageSize, filterReportType, filterStatus);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listPortingReports");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pageNumber | Integer | The page number to load | [optional] [default to 1] |
| pageSize | Integer | The size of the page | [optional] [default to 20] |
| filterReportType | String | Filter reports of a specific type | [optional] [enum: export_porting_orders_csv] |
| filterStatus | String | Filter reports of a specific status | [optional] [enum: pending, completed] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
| 500 | Internal server error | - |
ListVerificationCodes200Response listVerificationCodes(id, pageNumber, pageSize, filterPhoneNumber, filterPhoneNumberIn, filterVerified, sort)
List verification codes
Returns a list of verification codes for a porting order.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
Integer pageNumber = 1; // Integer | The page number to load
Integer pageSize = 20; // Integer | The size of the page
String filterPhoneNumber = "+12003151212"; // String | Filter results by phone number
List<String> filterPhoneNumberIn = Arrays.asList(); // List<String> | Filter results by a list of phone numbers
Boolean filterVerified = true; // Boolean | Filter verification codes that have been verified or not
String sort = "created_at"; // String | Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
try {
ListVerificationCodes200Response result = apiInstance.listVerificationCodes(id, pageNumber, pageSize, filterPhoneNumber, filterPhoneNumberIn, filterVerified, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#listVerificationCodes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| pageNumber | Integer | The page number to load | [optional] [default to 1] |
| pageSize | Integer | The size of the page | [optional] [default to 20] |
| filterPhoneNumber | String | Filter results by phone number | [optional] |
| filterPhoneNumberIn | List<String> | Filter results by a list of phone numbers | [optional] |
| filterVerified | Boolean | Filter verification codes that have been verified or not | [optional] |
| sort | String | Specifies the sort order for results. If not given, results are sorted by created_at in descending order. | [optional] [enum: created_at, -created_at] |
ListVerificationCodes200Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | Resource not found | - |
| 401 | Unauthorized | - |
File previewLoaConfiguration(id)
Preview a LOA configuration
Preview a specific LOA configuration.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Identifies a LOA configuration.
try {
File result = apiInstance.previewLoaConfiguration(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#previewLoaConfiguration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Identifies a LOA configuration. |
- Content-Type: Not defined
- Accept: application/pdf
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | Resource not found | - |
| 500 | Internal server error | - |
File previewLoaConfigurationParams(previewLoaConfigurationParamsRequest)
Preview the LOA configuration parameters
Preview the LOA template that would be generated without need to create LOA configuration.
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
PreviewLoaConfigurationParamsRequest previewLoaConfigurationParamsRequest = new PreviewLoaConfigurationParamsRequest(); // PreviewLoaConfigurationParamsRequest |
try {
File result = apiInstance.previewLoaConfigurationParams(previewLoaConfigurationParamsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#previewLoaConfigurationParams");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| previewLoaConfigurationParamsRequest | PreviewLoaConfigurationParamsRequest |
- Content-Type: application/json
- Accept: application/pdf
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
| 500 | Internal server error | - |
sendPortingVerificationCodes(id, sendPortingVerificationCodesRequest)
Send the verification codes
Send the verification code for all porting phone numbers.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
SendPortingVerificationCodesRequest sendPortingVerificationCodesRequest = new SendPortingVerificationCodesRequest(); // SendPortingVerificationCodesRequest | A list of phone numbers to send the verification codes to and the method to send them by
try {
apiInstance.sendPortingVerificationCodes(id, sendPortingVerificationCodesRequest);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#sendPortingVerificationCodes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| sendPortingVerificationCodesRequest | SendPortingVerificationCodesRequest | A list of phone numbers to send the verification codes to and the method to send them by | [optional] |
null (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No content | - |
| 401 | Unauthorized | - |
| 404 | Resource not found | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
SharePortingOrder201Response sharePortingOrder(id, sharePortingOrderRequest)
Share a porting order
Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
SharePortingOrderRequest sharePortingOrderRequest = new SharePortingOrderRequest(); // SharePortingOrderRequest |
try {
SharePortingOrder201Response result = apiInstance.sharePortingOrder(id, sharePortingOrderRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#sharePortingOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| sharePortingOrderRequest | SharePortingOrderRequest |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
| 401 | Unauthorized | - |
| 404 | Porting Order not found | - |
CreateLoaConfiguration201Response updateLoaConfiguration(id, previewLoaConfigurationParamsRequest)
Update a LOA configuration
Update a specific LOA configuration.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Identifies a LOA configuration.
PreviewLoaConfigurationParamsRequest previewLoaConfigurationParamsRequest = new PreviewLoaConfigurationParamsRequest(); // PreviewLoaConfigurationParamsRequest |
try {
CreateLoaConfiguration201Response result = apiInstance.updateLoaConfiguration(id, previewLoaConfigurationParamsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#updateLoaConfiguration");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Identifies a LOA configuration. | |
| previewLoaConfigurationParamsRequest | PreviewLoaConfigurationParamsRequest |
CreateLoaConfiguration201Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | Resource not found | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
| 500 | Internal server error | - |
UpdatePortingOrder200Response updatePortingOrder(id, updatePortingOrder)
Edit a porting order
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.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
UpdatePortingOrder updatePortingOrder = new UpdatePortingOrder(); // UpdatePortingOrder |
try {
UpdatePortingOrder200Response result = apiInstance.updatePortingOrder(id, updatePortingOrder);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#updatePortingOrder");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| updatePortingOrder | UpdatePortingOrder |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
ActivatePortingOrder202Response updatePortingOrdersActivationJob(id, activationJobId, updatePortingOrdersActivationJobRequest)
Update a porting activation job
Updates the activation time of a porting activation job.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
UUID activationJobId = UUID.randomUUID(); // UUID | Activation Job Identifier
UpdatePortingOrdersActivationJobRequest updatePortingOrdersActivationJobRequest = new UpdatePortingOrdersActivationJobRequest(); // UpdatePortingOrdersActivationJobRequest |
try {
ActivatePortingOrder202Response result = apiInstance.updatePortingOrdersActivationJob(id, activationJobId, updatePortingOrdersActivationJobRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#updatePortingOrdersActivationJob");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| activationJobId | UUID | Activation Job Identifier | |
| updatePortingOrdersActivationJobRequest | UpdatePortingOrdersActivationJobRequest |
ActivatePortingOrder202Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |
| 404 | Not found | - |
VerifyPortingVerificationCodes200Response verifyPortingVerificationCodes(id, verifyPortingVerificationCodesRequest)
Verify the verification code for a list of phone numbers
Verifies the verification code for a list of phone numbers.
import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.PortingOrderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.telnyx.com/v2");
// Configure HTTP bearer authorization: bearerAuth
HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setBearerToken("BEARER TOKEN");
PortingOrderApi apiInstance = new PortingOrderApi(defaultClient);
UUID id = UUID.randomUUID(); // UUID | Porting Order id
VerifyPortingVerificationCodesRequest verifyPortingVerificationCodesRequest = new VerifyPortingVerificationCodesRequest(); // VerifyPortingVerificationCodesRequest | A list of phone numbers and their verification codes
try {
VerifyPortingVerificationCodes200Response result = apiInstance.verifyPortingVerificationCodes(id, verifyPortingVerificationCodesRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PortingOrderApi#verifyPortingVerificationCodes");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | Porting Order id | |
| verifyPortingVerificationCodesRequest | VerifyPortingVerificationCodesRequest | A list of phone numbers and their verification codes |
VerifyPortingVerificationCodes200Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 401 | Unauthorized | - |
| 404 | Resource not found | - |
| 422 | Unprocessable entity. Check message field in response for details. | - |