Skip to content

Latest commit

 

History

History
252 lines (180 loc) · 8.09 KB

MessagingHostedNumberApi.md

File metadata and controls

252 lines (180 loc) · 8.09 KB

MessagingHostedNumberApi

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

Method HTTP request Description
deleteMessagingHostedNumber DELETE /messaging_hosted_numbers/{id} Delete Messaging Hosted Number
getMessagingHostedNumberOrder GET /messaging_hosted_number_orders/{id} Get Messaging Hosted Numbers Order Information
listMessagingHostedNumberOrder GET /messaging_hosted_number_orders List All Messaging Hosted Number Orders
newMessagingHostedNumberOrder POST /messaging_hosted_number_orders New Messaging Hosted Numbers Order
uploadFilesMessagingHostedNumberOrder POST /messaging_hosted_number_orders/{id}/actions/file_upload Upload LOA and Bill required for a Messaging Hosted Number Order

deleteMessagingHostedNumber

RetrieveMessagingHostedNumberResponse deleteMessagingHostedNumber(id)

Delete Messaging Hosted Number

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.MessagingHostedNumberApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessagingHostedNumberApi apiInstance = new MessagingHostedNumberApi();
String id = "id_example"; // String | Identifies the type of resource.
try {
    RetrieveMessagingHostedNumberResponse result = apiInstance.deleteMessagingHostedNumber(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessagingHostedNumberApi#deleteMessagingHostedNumber");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String Identifies the type of resource.

Return type

RetrieveMessagingHostedNumberResponse

Authorization

bearerAuth

HTTP request headers

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

getMessagingHostedNumberOrder

RetrieveMessagingHostedNumberOrderResponse getMessagingHostedNumberOrder(id)

Get Messaging Hosted Numbers Order Information

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.MessagingHostedNumberApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessagingHostedNumberApi apiInstance = new MessagingHostedNumberApi();
String id = "id_example"; // String | Identifies the type of resource.
try {
    RetrieveMessagingHostedNumberOrderResponse result = apiInstance.getMessagingHostedNumberOrder(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessagingHostedNumberApi#getMessagingHostedNumberOrder");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String Identifies the type of resource.

Return type

RetrieveMessagingHostedNumberOrderResponse

Authorization

bearerAuth

HTTP request headers

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

listMessagingHostedNumberOrder

ListMessagingHostedNumberOrderResponse listMessagingHostedNumberOrder()

List All Messaging Hosted Number Orders

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.MessagingHostedNumberApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessagingHostedNumberApi apiInstance = new MessagingHostedNumberApi();
try {
    ListMessagingHostedNumberOrderResponse result = apiInstance.listMessagingHostedNumberOrder();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessagingHostedNumberApi#listMessagingHostedNumberOrder");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ListMessagingHostedNumberOrderResponse

Authorization

bearerAuth

HTTP request headers

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

newMessagingHostedNumberOrder

RetrieveMessagingHostedNumberOrderResponse newMessagingHostedNumberOrder(body)

New Messaging Hosted Numbers Order

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.MessagingHostedNumberApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessagingHostedNumberApi apiInstance = new MessagingHostedNumberApi();
NewMessagingHostedNumberOrder body = new NewMessagingHostedNumberOrder(); // NewMessagingHostedNumberOrder | Message payload
try {
    RetrieveMessagingHostedNumberOrderResponse result = apiInstance.newMessagingHostedNumberOrder(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessagingHostedNumberApi#newMessagingHostedNumberOrder");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body NewMessagingHostedNumberOrder Message payload [optional]

Return type

RetrieveMessagingHostedNumberOrderResponse

Authorization

bearerAuth

HTTP request headers

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

uploadFilesMessagingHostedNumberOrder

RetrieveMessagingHostedNumberOrderResponse uploadFilesMessagingHostedNumberOrder(id, loa, bill)

Upload LOA and Bill required for a Messaging Hosted Number Order

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.MessagingHostedNumberApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessagingHostedNumberApi apiInstance = new MessagingHostedNumberApi();
String id = "id_example"; // String | Identifies the type of resource.
File loa = new File("loa_example"); // File | 
File bill = new File("bill_example"); // File | 
try {
    RetrieveMessagingHostedNumberOrderResponse result = apiInstance.uploadFilesMessagingHostedNumberOrder(id, loa, bill);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessagingHostedNumberApi#uploadFilesMessagingHostedNumberOrder");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String Identifies the type of resource.
loa File [optional]
bill File [optional]

Return type

RetrieveMessagingHostedNumberOrderResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json