Class: Twilio::REST::Insights::V1::CallSummariesList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/insights/v1/call_summaries.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CallSummariesList

Initialize the CallSummariesList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 26

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/Voice/Summaries"
    
end

Instance Method Details

#each ⇒ Object

When passed a block, yields CallSummariesInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



172
173
174
175
176
177
178
179
180
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 172

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of CallSummariesInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CallSummariesInstance



254
255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 254

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
CallSummariesPage.new(@version, response, @solution)
end

#list(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, limit: nil, page_size: nil) ⇒ Array

Lists CallSummariesInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • from (String) (defaults to: :unset) —

    A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.

  • to (String) (defaults to: :unset) —

    A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.

  • from_carrier (String) (defaults to: :unset) —

    An origination carrier.

  • to_carrier (String) (defaults to: :unset) —

    A destination carrier.

  • from_country_code (String) (defaults to: :unset) —

    A source country code based on phone number in From.

  • to_country_code (String) (defaults to: :unset) —

    A destination country code. Based on phone number in To.

  • branded (Boolean) (defaults to: :unset) —

    A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.

  • verified_caller (Boolean) (defaults to: :unset) —

    A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.

  • has_tag (Boolean) (defaults to: :unset) —

    A boolean flag indicating the presence of one or more [Voice Insights Call Tags](www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).

  • start_time (String) (defaults to: :unset) —

    A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.

  • end_time (String) (defaults to: :unset) —

    An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.

  • call_type (String) (defaults to: :unset) —

    A Call Type of the calls. One of ‘carrier`, `sip`, `trunking` or `client`.

  • call_state (String) (defaults to: :unset) —

    A Call State of the calls. One of ‘ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.

  • direction (String) (defaults to: :unset) —

    A Direction of the calls. One of ‘outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.

  • processing_state (ProcessingStateRequest) (defaults to: :unset) —

    A Processing State of the Call Summaries. One of ‘completed`, `partial` or `all`.

  • sort_by (SortBy) (defaults to: :unset) —

    A Sort By criterion for the returned list of Call Summaries. One of ‘start_time` or `end_time`.

  • subaccount (String) (defaults to: :unset) —

    A unique SID identifier of a Subaccount.

  • abnormal_session (Boolean) (defaults to: :unset) —

    A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.

  • answered_by (AnsweredBy) (defaults to: :unset) —

    An Answered By value for the calls based on ‘Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.

  • answered_by_annotation (String) (defaults to: :unset) —

    Either machine or human.

  • connectivity_issue_annotation (String) (defaults to: :unset) —

    A Connectivity Issue with the calls. One of ‘no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.

  • quality_issue_annotation (String) (defaults to: :unset) —

    A subjective Quality Issue with the calls. One of ‘no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.

  • spam_annotation (Boolean) (defaults to: :unset) —

    A boolean flag indicating spam calls.

  • call_score_annotation (String) (defaults to: :unset) —

    A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 69

def list(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, limit: nil, page_size: nil)
    self.stream(
        from: from,
        to: to,
        from_carrier: from_carrier,
        to_carrier: to_carrier,
        from_country_code: from_country_code,
        to_country_code: to_country_code,
        branded: branded,
        verified_caller: verified_caller,
        has_tag: has_tag,
        start_time: start_time,
        end_time: end_time,
        call_type: call_type,
        call_state: call_state,
        direction: direction,
        processing_state: processing_state,
        sort_by: sort_by,
        subaccount: subaccount,
        abnormal_session: abnormal_session,
        answered_by: answered_by,
        answered_by_annotation: answered_by_annotation,
        connectivity_issue_annotation: connectivity_issue_annotation,
        quality_issue_annotation: quality_issue_annotation,
        spam_annotation: spam_annotation,
        call_score_annotation: call_score_annotation,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of CallSummariesInstance records from the API. Request is executed immediately.

Parameters:

  • from (String) (defaults to: :unset) —

    A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.

  • to (String) (defaults to: :unset) —

    A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.

  • from_carrier (String) (defaults to: :unset) —

    An origination carrier.

  • to_carrier (String) (defaults to: :unset) —

    A destination carrier.

  • from_country_code (String) (defaults to: :unset) —

    A source country code based on phone number in From.

  • to_country_code (String) (defaults to: :unset) —

    A destination country code. Based on phone number in To.

  • branded (Boolean) (defaults to: :unset) —

    A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.

  • verified_caller (Boolean) (defaults to: :unset) —

    A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.

  • has_tag (Boolean) (defaults to: :unset) —

    A boolean flag indicating the presence of one or more [Voice Insights Call Tags](www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).

  • start_time (String) (defaults to: :unset) —

    A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.

  • end_time (String) (defaults to: :unset) —

    An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.

  • call_type (String) (defaults to: :unset) —

    A Call Type of the calls. One of ‘carrier`, `sip`, `trunking` or `client`.

  • call_state (String) (defaults to: :unset) —

    A Call State of the calls. One of ‘ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.

  • direction (String) (defaults to: :unset) —

    A Direction of the calls. One of ‘outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.

  • processing_state (ProcessingStateRequest) (defaults to: :unset) —

    A Processing State of the Call Summaries. One of ‘completed`, `partial` or `all`.

  • sort_by (SortBy) (defaults to: :unset) —

    A Sort By criterion for the returned list of Call Summaries. One of ‘start_time` or `end_time`.

  • subaccount (String) (defaults to: :unset) —

    A unique SID identifier of a Subaccount.

  • abnormal_session (Boolean) (defaults to: :unset) —

    A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.

  • answered_by (AnsweredBy) (defaults to: :unset) —

    An Answered By value for the calls based on ‘Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.

  • answered_by_annotation (String) (defaults to: :unset) —

    Either machine or human.

  • connectivity_issue_annotation (String) (defaults to: :unset) —

    A Connectivity Issue with the calls. One of ‘no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.

  • quality_issue_annotation (String) (defaults to: :unset) —

    A subjective Quality Issue with the calls. One of ‘no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.

  • spam_annotation (Boolean) (defaults to: :unset) —

    A boolean flag indicating spam calls.

  • call_score_annotation (String) (defaults to: :unset) —

    A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of CallSummariesInstance



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 213

def page(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'From' => from,
        'To' => to,
        'FromCarrier' => from_carrier,
        'ToCarrier' => to_carrier,
        'FromCountryCode' => from_country_code,
        'ToCountryCode' => to_country_code,
        'Branded' => branded,
        'VerifiedCaller' => verified_caller,
        'HasTag' => has_tag,
        'StartTime' => start_time,
        'EndTime' => end_time,
        'CallType' => call_type,
        'CallState' => call_state,
        'Direction' => direction,
        'ProcessingState' => processing_state,
        'SortBy' => sort_by,
        'Subaccount' => subaccount,
        'AbnormalSession' => abnormal_session,
        'AnsweredBy' => answered_by,
        'AnsweredByAnnotation' => answered_by_annotation,
        'ConnectivityIssueAnnotation' => connectivity_issue_annotation,
        'QualityIssueAnnotation' => quality_issue_annotation,
        'SpamAnnotation' => spam_annotation,
        'CallScoreAnnotation' => call_score_annotation,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

    response = @version.page('GET', @uri, params: params)

    CallSummariesPage.new(@version, response, @solution)
end

#stream(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • from (String) (defaults to: :unset) —

    A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.

  • to (String) (defaults to: :unset) —

    A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.

  • from_carrier (String) (defaults to: :unset) —

    An origination carrier.

  • to_carrier (String) (defaults to: :unset) —

    A destination carrier.

  • from_country_code (String) (defaults to: :unset) —

    A source country code based on phone number in From.

  • to_country_code (String) (defaults to: :unset) —

    A destination country code. Based on phone number in To.

  • branded (Boolean) (defaults to: :unset) —

    A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls.

  • verified_caller (Boolean) (defaults to: :unset) —

    A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.

  • has_tag (Boolean) (defaults to: :unset) —

    A boolean flag indicating the presence of one or more [Voice Insights Call Tags](www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).

  • start_time (String) (defaults to: :unset) —

    A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.

  • end_time (String) (defaults to: :unset) —

    An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.

  • call_type (String) (defaults to: :unset) —

    A Call Type of the calls. One of ‘carrier`, `sip`, `trunking` or `client`.

  • call_state (String) (defaults to: :unset) —

    A Call State of the calls. One of ‘ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.

  • direction (String) (defaults to: :unset) —

    A Direction of the calls. One of ‘outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.

  • processing_state (ProcessingStateRequest) (defaults to: :unset) —

    A Processing State of the Call Summaries. One of ‘completed`, `partial` or `all`.

  • sort_by (SortBy) (defaults to: :unset) —

    A Sort By criterion for the returned list of Call Summaries. One of ‘start_time` or `end_time`.

  • subaccount (String) (defaults to: :unset) —

    A unique SID identifier of a Subaccount.

  • abnormal_session (Boolean) (defaults to: :unset) —

    A boolean flag indicating an abnormal session where the last SIP response was not 200 OK.

  • answered_by (AnsweredBy) (defaults to: :unset) —

    An Answered By value for the calls based on ‘Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.

  • answered_by_annotation (String) (defaults to: :unset) —

    Either machine or human.

  • connectivity_issue_annotation (String) (defaults to: :unset) —

    A Connectivity Issue with the calls. One of ‘no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.

  • quality_issue_annotation (String) (defaults to: :unset) —

    A subjective Quality Issue with the calls. One of ‘no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.

  • spam_annotation (Boolean) (defaults to: :unset) —

    A boolean flag indicating spam calls.

  • call_score_annotation (String) (defaults to: :unset) —

    A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 135

def stream(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :unset, branded: :unset, verified_caller: :unset, has_tag: :unset, start_time: :unset, end_time: :unset, call_type: :unset, call_state: :unset, direction: :unset, processing_state: :unset, sort_by: :unset, subaccount: :unset, abnormal_session: :unset, answered_by: :unset, answered_by_annotation: :unset, connectivity_issue_annotation: :unset, quality_issue_annotation: :unset, spam_annotation: :unset, call_score_annotation: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        from: from,
        to: to,
        from_carrier: from_carrier,
        to_carrier: to_carrier,
        from_country_code: from_country_code,
        to_country_code: to_country_code,
        branded: branded,
        verified_caller: verified_caller,
        has_tag: has_tag,
        start_time: start_time,
        end_time: end_time,
        call_type: call_type,
        call_state: call_state,
        direction: direction,
        processing_state: processing_state,
        sort_by: sort_by,
        subaccount: subaccount,
        abnormal_session: abnormal_session,
        answered_by: answered_by,
        answered_by_annotation: answered_by_annotation,
        connectivity_issue_annotation: connectivity_issue_annotation,
        quality_issue_annotation: quality_issue_annotation,
        spam_annotation: spam_annotation,
        call_score_annotation: call_score_annotation,
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



265
266
267
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 265

def to_s
    '#<Twilio.Insights.V1.CallSummariesList>'
end