Skip to content

Latest commit

 

History

History
162 lines (118 loc) · 5.96 KB

SimCardGroupActionsApi.md

File metadata and controls

162 lines (118 loc) · 5.96 KB

SimCardGroupActionsApi

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

Method HTTP request Description
getSimCardGroupAction GET /sim_card_group_actions/{id} Get SIM card group action details
getSimCardGroupActions GET /sim_card_group_actions List SIM card group actions

getSimCardGroupAction

GetSimCardGroupAction200Response getSimCardGroupAction(id)

Get SIM card group action details

This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.

Example

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

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

        SimCardGroupActionsApi apiInstance = new SimCardGroupActionsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            GetSimCardGroupAction200Response result = apiInstance.getSimCardGroupAction(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimCardGroupActionsApi#getSimCardGroupAction");
            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 UUID Identifies the resource.

Return type

GetSimCardGroupAction200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
0 Unexpected error -

getSimCardGroupActions

GetSimCardGroupActions200Response getSimCardGroupActions(pageNumber, pageSize, filterSimCardGroupId, filterStatus, filterType)

List SIM card group actions

This API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific filters.

Example

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

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

        SimCardGroupActionsApi apiInstance = new SimCardGroupActionsApi(defaultClient);
        Integer pageNumber = 1; // Integer | The page number to load
        Integer pageSize = 20; // Integer | The size of the page
        UUID filterSimCardGroupId = UUID.fromString("47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9"); // UUID | A valid SIM card group ID.
        String filterStatus = "in-progress"; // String | Filter by a specific status of the resource's lifecycle.
        String filterType = "set_private_wireless_gateway"; // String | Filter by action type.
        try {
            GetSimCardGroupActions200Response result = apiInstance.getSimCardGroupActions(pageNumber, pageSize, filterSimCardGroupId, filterStatus, filterType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SimCardGroupActionsApi#getSimCardGroupActions");
            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]
filterSimCardGroupId UUID A valid SIM card group ID. [optional]
filterStatus String Filter by a specific status of the resource's lifecycle. [optional] [enum: in-progress, completed, failed]
filterType String Filter by action type. [optional] [enum: set_private_wireless_gateway, remove_private_wireless_gateway]

Return type

GetSimCardGroupActions200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
0 Unexpected error -