Skip to content

Latest commit

 

History

History
116 lines (90 loc) · 5.41 KB

DebuggingApi.md

File metadata and controls

116 lines (90 loc) · 5.41 KB
Raw

DebuggingApi

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

Method HTTP request Description
listCallEvents GET /call_events List call events

listCallEvents

ListCallEventsResponse listCallEvents().filterCallLegId(filterCallLegId).filterCallSessionId(filterCallSessionId).filterStatus(filterStatus).filterType(filterType).filterEventTimestampGt(filterEventTimestampGt).filterEventTimestampGte(filterEventTimestampGte).filterEventTimestampLt(filterEventTimestampLt).filterEventTimestampLte(filterEventTimestampLte).filterEventTimestampEq(filterEventTimestampEq).pageNumber(pageNumber).pageSize(pageSize).execute();

List call events

Filters call events by given filter parameters. Events are ordered by event_timestamp. If filter for call_leg_id or call_session_id is not present, it only filters events from the last 24 hours.

Note: Only one filter[event_timestamp] can be passed.

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

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

        DebuggingApi apiInstance = new DebuggingApi(defaultClient);
        UUID filterCallLegId = UUID.randomUUID(); // UUID | The unique identifier of an individual call leg.
        UUID filterCallSessionId = UUID.randomUUID(); // UUID | The unique identifier of the call control session. A session may include multiple call leg events.
        String filterStatus = "delivered"; // String | Event status
        String filterType = "command"; // String | Event type
        String filterEventTimestampGt = "2019-03-29T11:10:00Z"; // String | Event timestamp: greater than
        String filterEventTimestampGte = "2019-03-29T11:10:00Z"; // String | Event timestamp: greater than or equal
        String filterEventTimestampLt = "2019-03-29T11:10:00Z"; // String | Event timestamp: lower than
        String filterEventTimestampLte = "2019-03-29T11:10:00Z"; // String | Event timestamp: lower than or equal
        String filterEventTimestampEq = "2019-03-29T11:10:00Z"; // String | Event timestamp: equal
        Integer pageNumber = 1; // Integer | The page number to load
        Integer pageSize = 20; // Integer | The size of the page
        try {
            ListCallEventsResponse result = api.listCallEvents()
                .filterCallLegId(filterCallLegId)
                .filterCallSessionId(filterCallSessionId)
                .filterStatus(filterStatus)
                .filterType(filterType)
                .filterEventTimestampGt(filterEventTimestampGt)
                .filterEventTimestampGte(filterEventTimestampGte)
                .filterEventTimestampLt(filterEventTimestampLt)
                .filterEventTimestampLte(filterEventTimestampLte)
                .filterEventTimestampEq(filterEventTimestampEq)
                .pageNumber(pageNumber)
                .pageSize(pageSize)
                .execute();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DebuggingApi#listCallEvents");
            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
filterCallLegId UUID The unique identifier of an individual call leg. [optional]
filterCallSessionId UUID The unique identifier of the call control session. A session may include multiple call leg events. [optional]
filterStatus String Event status [optional] [enum: delivered, failed]
filterType String Event type [optional] [enum: command, webhook]
filterEventTimestampGt String Event timestamp: greater than [optional]
filterEventTimestampGte String Event timestamp: greater than or equal [optional]
filterEventTimestampLt String Event timestamp: lower than [optional]
filterEventTimestampLte String Event timestamp: lower than or equal [optional]
filterEventTimestampEq String Event timestamp: equal [optional]
pageNumber Integer The page number to load [optional] [default to 1]
pageSize Integer The size of the page [optional] [default to 20]

Return type

ListCallEventsResponse

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 call events. -
0 Unexpected error -