Skip to content

PhoneNumberPortingApi.md

Latest commit

 

History

History
81 lines (57 loc) · 2.66 KB

PhoneNumberPortingApi.md

File metadata and controls

81 lines (57 loc) · 2.66 KB

PhoneNumberPortingApi

All URIs are relative to https://api.telnyx.com/v2

Method HTTP request Description
postPortabilityCheck POST /portability_checks Run a portability check

postPortabilityCheck

PostPortabilityCheck201Response postPortabilityCheck(postPortabilityCheckRequest)

Run a portability check

Runs a portability check, returning the results immediately.

Example

// 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.PhoneNumberPortingApi;

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");

        PhoneNumberPortingApi apiInstance = new PhoneNumberPortingApi(defaultClient);
        PostPortabilityCheckRequest postPortabilityCheckRequest = new PostPortabilityCheckRequest(); // PostPortabilityCheckRequest | 
        try {
            PostPortabilityCheck201Response result = apiInstance.postPortabilityCheck(postPortabilityCheckRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PhoneNumberPortingApi#postPortabilityCheck");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
postPortabilityCheckRequest PostPortabilityCheckRequest

Return type

PostPortabilityCheck201Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 PortabilityCheck Response -
401 Unauthorized -
422 Unprocessable entity. Check message field in response for details. -