Class: Telnyx::Resources::CallEvents

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/call_events.rb

Overview

Call Control debugging

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CallEvents

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CallEvents.

Parameters:



45
46
47
 
# File 'lib/telnyx/resources/call_events.rb', line 45

def initialize(client:)
  @client = client
end

Instance Method Details

#list(filter: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::CallEventListResponse>

Some parameter documentations has been truncated, see Models::CallEventListParams for more details.

Filters call events by given filter parameters. Events are ordered by ‘occurred_at`. If filter for `leg_id` or `application_session_id` is not present, it only filters events from the last 24 hours.

Note: Only one ‘filter` can be passed.

Parameters:

Returns:

See Also:



29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/telnyx/resources/call_events.rb', line 29

def list(params = {})
  parsed, options = Telnyx::CallEventListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "call_events",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::CallEventListResponse,
    options: options
  )
end