Skip to content

Latest commit

 

History

History
365 lines (266 loc) · 13.7 KB

NumberConfigurationsApi.md

File metadata and controls

365 lines (266 loc) · 13.7 KB

NumberConfigurationsApi

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

Method HTTP request Description
bulkUpdateMessagingSettingsOnPhoneNumbers POST /messaging_numbers_bulk_updates Update the messaging profile of multiple phone numbers
getBulkUpdateMessagingSettingsOnPhoneNumbersStatus GET /messaging_numbers_bulk_updates/{order_id} Retrieve bulk update status
getPhoneNumberMessagingSettings GET /phone_numbers/{id}/messaging Retrieve a phone number with messaging settings
listPhoneNumbersWithMessagingSettings GET /phone_numbers/messaging List phone numbers with messaging settings
updatePhoneNumberMessagingSettings PATCH /phone_numbers/{id}/messaging Update the messaging profile and/or messaging product of a phone number

bulkUpdateMessagingSettingsOnPhoneNumbers

RetrieveBulkUpdateMessagingSettingsResponse bulkUpdateMessagingSettingsOnPhoneNumbers(bulkMessagingSettingsUpdatePhoneNumbersRequest)

Update the messaging profile of multiple phone numbers

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.NumberConfigurationsApi;

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

        NumberConfigurationsApi apiInstance = new NumberConfigurationsApi(defaultClient);
        BulkMessagingSettingsUpdatePhoneNumbersRequest bulkMessagingSettingsUpdatePhoneNumbersRequest = new BulkMessagingSettingsUpdatePhoneNumbersRequest(); // BulkMessagingSettingsUpdatePhoneNumbersRequest | 
        try {
            RetrieveBulkUpdateMessagingSettingsResponse result = apiInstance.bulkUpdateMessagingSettingsOnPhoneNumbers(bulkMessagingSettingsUpdatePhoneNumbersRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberConfigurationsApi#bulkUpdateMessagingSettingsOnPhoneNumbers");
            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
bulkMessagingSettingsUpdatePhoneNumbersRequest BulkMessagingSettingsUpdatePhoneNumbersRequest

Return type

RetrieveBulkUpdateMessagingSettingsResponse

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response with details about messaging bulk update phone numbers. -
0 Unexpected error -

getBulkUpdateMessagingSettingsOnPhoneNumbersStatus

RetrieveBulkUpdateMessagingSettingsResponse getBulkUpdateMessagingSettingsOnPhoneNumbersStatus(orderId)

Retrieve bulk update status

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.NumberConfigurationsApi;

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

        NumberConfigurationsApi apiInstance = new NumberConfigurationsApi(defaultClient);
        String orderId = "orderId_example"; // String | Order ID to verify bulk update status.
        try {
            RetrieveBulkUpdateMessagingSettingsResponse result = apiInstance.getBulkUpdateMessagingSettingsOnPhoneNumbersStatus(orderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberConfigurationsApi#getBulkUpdateMessagingSettingsOnPhoneNumbersStatus");
            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
orderId String Order ID to verify bulk update status.

Return type

RetrieveBulkUpdateMessagingSettingsResponse

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response with details about messaging bulk update phone numbers. -
0 Unexpected error -

getPhoneNumberMessagingSettings

RetrieveMessagingSettingsResponse getPhoneNumberMessagingSettings(id)

Retrieve a phone number with messaging settings

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.NumberConfigurationsApi;

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

        NumberConfigurationsApi apiInstance = new NumberConfigurationsApi(defaultClient);
        String id = "id_example"; // String | Identifies the type of resource.
        try {
            RetrieveMessagingSettingsResponse result = apiInstance.getPhoneNumberMessagingSettings(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberConfigurationsApi#getPhoneNumberMessagingSettings");
            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
id String Identifies the type of resource.

Return type

RetrieveMessagingSettingsResponse

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response with details about a phone number including messaging settings. -
0 Unexpected error -

listPhoneNumbersWithMessagingSettings

ListMessagingSettingsResponse listPhoneNumbersWithMessagingSettings().pageNumber(pageNumber).pageSize(pageSize).execute();

List phone numbers with messaging settings

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.NumberConfigurationsApi;

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

        NumberConfigurationsApi apiInstance = new NumberConfigurationsApi(defaultClient);
        Integer pageNumber = 1; // Integer | The page number to load
        Integer pageSize = 20; // Integer | The size of the page
        try {
            ListMessagingSettingsResponse result = api.listPhoneNumbersWithMessagingSettings()
                .pageNumber(pageNumber)
                .pageSize(pageSize)
                .execute();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberConfigurationsApi#listPhoneNumbersWithMessagingSettings");
            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
pageNumber Integer The page number to load [optional] [default to 1]
pageSize Integer The size of the page [optional] [default to 20]

Return type

ListMessagingSettingsResponse

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response with a list of phone numbers with messaging settings. -
0 Unexpected error -

updatePhoneNumberMessagingSettings

RetrieveMessagingSettingsResponse updatePhoneNumberMessagingSettings(id, updatePhoneNumberMessagingSettingsRequest)

Update the messaging profile and/or messaging product of a phone number

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.NumberConfigurationsApi;

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

        NumberConfigurationsApi apiInstance = new NumberConfigurationsApi(defaultClient);
        String id = "id_example"; // String | The phone number to update.
        UpdatePhoneNumberMessagingSettingsRequest updatePhoneNumberMessagingSettingsRequest = new UpdatePhoneNumberMessagingSettingsRequest(); // UpdatePhoneNumberMessagingSettingsRequest | The new configuration to set for this phone number.  To avoid modifying a value, either omit the field or set its value to `null`.
        try {
            RetrieveMessagingSettingsResponse result = apiInstance.updatePhoneNumberMessagingSettings(id, updatePhoneNumberMessagingSettingsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NumberConfigurationsApi#updatePhoneNumberMessagingSettings");
            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
id String The phone number to update.
updatePhoneNumberMessagingSettingsRequest UpdatePhoneNumberMessagingSettingsRequest The new configuration to set for this phone number. To avoid modifying a value, either omit the field or set its value to `null`.

Return type

RetrieveMessagingSettingsResponse

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response with details about a phone number including messaging settings. -
0 Unexpected error -