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.



204
205
206
207
208
209
210
211
212
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 204

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



305
306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 305

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, 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:

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

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

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

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

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

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

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

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

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

    A unique SID identifier of the Branded Call.

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

    A unique SID identifier of the Voice Integrity Profile.

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

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

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

  • business_profile_industry (String) (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’

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

    A unique SID identifier of the Business Profile.

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

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

  • 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



77
78
79
80
81
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
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 77

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, 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,
        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

#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, 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:

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

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

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

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

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

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

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

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

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

    A unique SID identifier of the Branded Call.

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

    A unique SID identifier of the Voice Integrity Profile.

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

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

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

  • business_profile_industry (String) (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’

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

    A unique SID identifier of the Business Profile.

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

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

  • 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



253
254
255
256
257
258
259
260
261
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
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 253

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, 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,
        '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, 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:

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

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

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

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

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

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

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

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

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

    A unique SID identifier of the Branded Call.

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

    A unique SID identifier of the Voice Integrity Profile.

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

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

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

  • business_profile_industry (String) (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’

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

    A unique SID identifier of the Business Profile.

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

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

  • 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



159
160
161
162
163
164
165
166
167
168
169
170
171
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
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 159

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, 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,
        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



316
317
318
 
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 316

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