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 that contains the resource



26
27
28
29
30
31
32
33
 
# 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.



315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 315

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:

  • API-generated URL for the requested results page

Returns:

  • Page of CallSummariesInstance



424
425
426
427
428
429
430
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 424

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, 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, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :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:

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    An origination carrier.

  • (defaults to: :unset)

    A destination carrier.

  • (defaults to: :unset)

    A source country code based on phone number in From.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.One of ‘true’ or ‘false’.

  • (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).

  • (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.

  • (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.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    A unique SID identifier of a Subaccount.

  • (defaults to: :unset)

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

  • (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.

  • (defaults to: :unset)

    Either machine or human.

  • (defaults to: :unset)

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

  • (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.

  • (defaults to: :unset)

    A boolean flag indicating spam calls.

  • (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].

  • (defaults to: :unset)

    A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls. One of ‘true’ or ‘false’

  • (defaults to: :unset)

    A boolean flag indicating whether or not the phone number had voice integrity enabled.One of ‘true’ or ‘false’

  • (defaults to: :unset)

    A unique SID identifier of the Branded Call.

  • (defaults to: :unset)

    Indicates whether the branded logo was displayed during the in_brand branded call. Possible values are true (logo was present) or false (logo was not present).

  • (defaults to: :unset)

    Indicates whether the Branded Call is in_band vs out_of_band.

  • (defaults to: :unset)

    Specifies the user-defined purpose for the call, as provided during the setup of in_band branded calling.

  • (defaults to: :unset)

    Specifies the user-defined reason for the call, which will be displayed to the end user on their mobile device during an in_band branded call.

  • (defaults to: :unset)

    A unique SID identifier of the Voice Integrity Profile.

  • (defaults to: :unset)

    A Voice Integrity Use Case . Is of type enum. One of ‘abandoned_cart’, ‘appointment_reminders’, ‘appointment_scheduling’, ‘asset_management’, ‘automated_support’, ‘call_tracking’, ‘click_to_call’, ‘contact_tracing’, ‘contactless_delivery’, ‘customer_support’, ‘dating/social’, ‘delivery_notifications’, ‘distance_learning’, ‘emergency_notifications’, ‘employee_notifications’, ‘exam_proctoring’, ‘field_notifications’, ‘first_responder’, ‘fraud_alerts’, ‘group_messaging’, ‘identify_&_verification’, ‘intelligent_routing’, ‘lead_alerts’, ‘lead_distribution’, ‘lead_generation’, ‘lead_management’, ‘lead_nurturing’, ‘marketing_events’, ‘mass_alerts’, ‘meetings/collaboration’, ‘order_notifications’, ‘outbound_dialer’, ‘pharmacy’, ‘phone_system’, ‘purchase_confirmation’, ‘remote_appointments’, ‘rewards_program’, ‘self-service’, ‘service_alerts’, ‘shift_management’, ‘survey/research’, ‘telehealth’, ‘telemarketing’, ‘therapy_(individual+group)’.

  • (defaults to: :unset)

    A Business Identity of the calls. Is of type enum. One of ‘direct_customer’, ‘isv_reseller_or_partner’.

  • (defaults to: :unset)

    A Business Industry of the calls. Is of type enum. One of ‘automotive’, ‘agriculture’, ‘banking’, ‘consumer’, ‘construction’, ‘education’, ‘engineering’, ‘energy’, ‘oil_and_gas’, ‘fast_moving_consumer_goods’, ‘financial’, ‘fintech’, ‘food_and_beverage’, ‘government’, ‘healthcare’, ‘hospitality’, ‘insurance’, ‘legal’, ‘manufacturing’, ‘media’, ‘online’, ‘professional_services’, ‘raw_materials’, ‘real_estate’, ‘religion’, ‘retail’, ‘jewelry’, ‘technology’, ‘telecommunications’, ‘transportation’, ‘travel’, ‘electronics’, ‘not_for_profit’

  • (defaults to: :unset)

    A unique SID identifier of the Business Profile.

  • (defaults to: :unset)

    A Business Profile Type of the calls. Is of type enum. One of ‘primary’, ‘secondary’.

  • (defaults to: nil)

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

  • (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 of up to limit results



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 82

def list(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :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, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :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,
        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,
        branded_enabled: branded_enabled,
        voice_integrity_enabled: voice_integrity_enabled,
        branded_bundle_sid: branded_bundle_sid,
        branded_logo: ,
        branded_type: branded_type,
        branded_use_case: branded_use_case,
        branded_call_reason: branded_call_reason,
        voice_integrity_bundle_sid: voice_integrity_bundle_sid,
        voice_integrity_use_case: voice_integrity_use_case,
        business_profile_identity: business_profile_identity,
        business_profile_industry: business_profile_industry,
        business_profile_bundle_sid: business_profile_bundle_sid,
        business_profile_type: business_profile_type,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :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, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • (defaults to: nil)

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

  • (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 of up to limit results



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 262

def list_with_metadata(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :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, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'From' => from,
        'To' => to,
        'FromCarrier' => from_carrier,
        'ToCarrier' => to_carrier,
        'FromCountryCode' => from_country_code,
        'ToCountryCode' => to_country_code,
        '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,
        'BrandedEnabled' => branded_enabled,
        'VoiceIntegrityEnabled' => voice_integrity_enabled,
        'BrandedBundleSid' => branded_bundle_sid,
        'BrandedLogo' => ,
        'BrandedType' => branded_type,
        'BrandedUseCase' => branded_use_case,
        'BrandedCallReason' => branded_call_reason,
        'VoiceIntegrityBundleSid' => voice_integrity_bundle_sid,
        'VoiceIntegrityUseCase' => voice_integrity_use_case,
        'BusinessProfileIdentity' => business_profile_identity,
        'BusinessProfileIndustry' => business_profile_industry,
        'BusinessProfileBundleSid' => business_profile_bundle_sid,
        'BusinessProfileType' => business_profile_type,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    CallSummariesPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :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, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :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:

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    An origination carrier.

  • (defaults to: :unset)

    A destination carrier.

  • (defaults to: :unset)

    A source country code based on phone number in From.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.One of ‘true’ or ‘false’.

  • (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).

  • (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.

  • (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.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    A unique SID identifier of a Subaccount.

  • (defaults to: :unset)

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

  • (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.

  • (defaults to: :unset)

    Either machine or human.

  • (defaults to: :unset)

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

  • (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.

  • (defaults to: :unset)

    A boolean flag indicating spam calls.

  • (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].

  • (defaults to: :unset)

    A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls. One of ‘true’ or ‘false’

  • (defaults to: :unset)

    A boolean flag indicating whether or not the phone number had voice integrity enabled.One of ‘true’ or ‘false’

  • (defaults to: :unset)

    A unique SID identifier of the Branded Call.

  • (defaults to: :unset)

    Indicates whether the branded logo was displayed during the in_brand branded call. Possible values are true (logo was present) or false (logo was not present).

  • (defaults to: :unset)

    Indicates whether the Branded Call is in_band vs out_of_band.

  • (defaults to: :unset)

    Specifies the user-defined purpose for the call, as provided during the setup of in_band branded calling.

  • (defaults to: :unset)

    Specifies the user-defined reason for the call, which will be displayed to the end user on their mobile device during an in_band branded call.

  • (defaults to: :unset)

    A unique SID identifier of the Voice Integrity Profile.

  • (defaults to: :unset)

    A Voice Integrity Use Case . Is of type enum. One of ‘abandoned_cart’, ‘appointment_reminders’, ‘appointment_scheduling’, ‘asset_management’, ‘automated_support’, ‘call_tracking’, ‘click_to_call’, ‘contact_tracing’, ‘contactless_delivery’, ‘customer_support’, ‘dating/social’, ‘delivery_notifications’, ‘distance_learning’, ‘emergency_notifications’, ‘employee_notifications’, ‘exam_proctoring’, ‘field_notifications’, ‘first_responder’, ‘fraud_alerts’, ‘group_messaging’, ‘identify_&_verification’, ‘intelligent_routing’, ‘lead_alerts’, ‘lead_distribution’, ‘lead_generation’, ‘lead_management’, ‘lead_nurturing’, ‘marketing_events’, ‘mass_alerts’, ‘meetings/collaboration’, ‘order_notifications’, ‘outbound_dialer’, ‘pharmacy’, ‘phone_system’, ‘purchase_confirmation’, ‘remote_appointments’, ‘rewards_program’, ‘self-service’, ‘service_alerts’, ‘shift_management’, ‘survey/research’, ‘telehealth’, ‘telemarketing’, ‘therapy_(individual+group)’.

  • (defaults to: :unset)

    A Business Identity of the calls. Is of type enum. One of ‘direct_customer’, ‘isv_reseller_or_partner’.

  • (defaults to: :unset)

    A Business Industry of the calls. Is of type enum. One of ‘automotive’, ‘agriculture’, ‘banking’, ‘consumer’, ‘construction’, ‘education’, ‘engineering’, ‘energy’, ‘oil_and_gas’, ‘fast_moving_consumer_goods’, ‘financial’, ‘fintech’, ‘food_and_beverage’, ‘government’, ‘healthcare’, ‘hospitality’, ‘insurance’, ‘legal’, ‘manufacturing’, ‘media’, ‘online’, ‘professional_services’, ‘raw_materials’, ‘real_estate’, ‘religion’, ‘retail’, ‘jewelry’, ‘technology’, ‘telecommunications’, ‘transportation’, ‘travel’, ‘electronics’, ‘not_for_profit’

  • (defaults to: :unset)

    A unique SID identifier of the Business Profile.

  • (defaults to: :unset)

    A Business Profile Type of the calls. Is of type enum. One of ‘primary’, ‘secondary’.

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of CallSummariesInstance



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 368

def page(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :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, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :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,
        '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,
        'BrandedEnabled' => branded_enabled,
        'VoiceIntegrityEnabled' => voice_integrity_enabled,
        'BrandedBundleSid' => branded_bundle_sid,
        'BrandedLogo' => ,
        'BrandedType' => branded_type,
        'BrandedUseCase' => branded_use_case,
        'BrandedCallReason' => branded_call_reason,
        'VoiceIntegrityBundleSid' => voice_integrity_bundle_sid,
        'VoiceIntegrityUseCase' => voice_integrity_use_case,
        'BusinessProfileIdentity' => business_profile_identity,
        'BusinessProfileIndustry' => business_profile_industry,
        'BusinessProfileBundleSid' => business_profile_bundle_sid,
        'BusinessProfileType' => business_profile_type,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

    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, 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, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :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:

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    An origination carrier.

  • (defaults to: :unset)

    A destination carrier.

  • (defaults to: :unset)

    A source country code based on phone number in From.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.One of ‘true’ or ‘false’.

  • (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).

  • (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.

  • (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.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    A unique SID identifier of a Subaccount.

  • (defaults to: :unset)

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

  • (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.

  • (defaults to: :unset)

    Either machine or human.

  • (defaults to: :unset)

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

  • (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.

  • (defaults to: :unset)

    A boolean flag indicating spam calls.

  • (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].

  • (defaults to: :unset)

    A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls. One of ‘true’ or ‘false’

  • (defaults to: :unset)

    A boolean flag indicating whether or not the phone number had voice integrity enabled.One of ‘true’ or ‘false’

  • (defaults to: :unset)

    A unique SID identifier of the Branded Call.

  • (defaults to: :unset)

    Indicates whether the branded logo was displayed during the in_brand branded call. Possible values are true (logo was present) or false (logo was not present).

  • (defaults to: :unset)

    Indicates whether the Branded Call is in_band vs out_of_band.

  • (defaults to: :unset)

    Specifies the user-defined purpose for the call, as provided during the setup of in_band branded calling.

  • (defaults to: :unset)

    Specifies the user-defined reason for the call, which will be displayed to the end user on their mobile device during an in_band branded call.

  • (defaults to: :unset)

    A unique SID identifier of the Voice Integrity Profile.

  • (defaults to: :unset)

    A Voice Integrity Use Case . Is of type enum. One of ‘abandoned_cart’, ‘appointment_reminders’, ‘appointment_scheduling’, ‘asset_management’, ‘automated_support’, ‘call_tracking’, ‘click_to_call’, ‘contact_tracing’, ‘contactless_delivery’, ‘customer_support’, ‘dating/social’, ‘delivery_notifications’, ‘distance_learning’, ‘emergency_notifications’, ‘employee_notifications’, ‘exam_proctoring’, ‘field_notifications’, ‘first_responder’, ‘fraud_alerts’, ‘group_messaging’, ‘identify_&_verification’, ‘intelligent_routing’, ‘lead_alerts’, ‘lead_distribution’, ‘lead_generation’, ‘lead_management’, ‘lead_nurturing’, ‘marketing_events’, ‘mass_alerts’, ‘meetings/collaboration’, ‘order_notifications’, ‘outbound_dialer’, ‘pharmacy’, ‘phone_system’, ‘purchase_confirmation’, ‘remote_appointments’, ‘rewards_program’, ‘self-service’, ‘service_alerts’, ‘shift_management’, ‘survey/research’, ‘telehealth’, ‘telemarketing’, ‘therapy_(individual+group)’.

  • (defaults to: :unset)

    A Business Identity of the calls. Is of type enum. One of ‘direct_customer’, ‘isv_reseller_or_partner’.

  • (defaults to: :unset)

    A Business Industry of the calls. Is of type enum. One of ‘automotive’, ‘agriculture’, ‘banking’, ‘consumer’, ‘construction’, ‘education’, ‘engineering’, ‘energy’, ‘oil_and_gas’, ‘fast_moving_consumer_goods’, ‘financial’, ‘fintech’, ‘food_and_beverage’, ‘government’, ‘healthcare’, ‘hospitality’, ‘insurance’, ‘legal’, ‘manufacturing’, ‘media’, ‘online’, ‘professional_services’, ‘raw_materials’, ‘real_estate’, ‘religion’, ‘retail’, ‘jewelry’, ‘technology’, ‘telecommunications’, ‘transportation’, ‘travel’, ‘electronics’, ‘not_for_profit’

  • (defaults to: :unset)

    A unique SID identifier of the Business Profile.

  • (defaults to: :unset)

    A Business Profile Type of the calls. Is of type enum. One of ‘primary’, ‘secondary’.

  • (defaults to: nil)

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

  • (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 that will yield up to limit results



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 172

def stream(from: :unset, to: :unset, from_carrier: :unset, to_carrier: :unset, from_country_code: :unset, to_country_code: :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, branded_enabled: :unset, voice_integrity_enabled: :unset, branded_bundle_sid: :unset, branded_logo: :unset, branded_type: :unset, branded_use_case: :unset, branded_call_reason: :unset, voice_integrity_bundle_sid: :unset, voice_integrity_use_case: :unset, business_profile_identity: :unset, business_profile_industry: :unset, business_profile_bundle_sid: :unset, business_profile_type: :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,
        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,
        branded_enabled: branded_enabled,
        voice_integrity_enabled: voice_integrity_enabled,
        branded_bundle_sid: branded_bundle_sid,
        branded_logo: ,
        branded_type: branded_type,
        branded_use_case: branded_use_case,
        branded_call_reason: branded_call_reason,
        voice_integrity_bundle_sid: voice_integrity_bundle_sid,
        voice_integrity_use_case: voice_integrity_use_case,
        business_profile_identity: business_profile_identity,
        business_profile_industry: business_profile_industry,
        business_profile_bundle_sid: business_profile_bundle_sid,
        business_profile_type: business_profile_type,
        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



435
436
437
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 435

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