Class: Twilio::REST::Insights::V1::CallSummariesInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/insights/v1/call_summaries.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ CallSummariesInstance

Initialize the CallSummariesInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • account_sid (String)

    The SID of the Account that created this CallSummaries resource.

  • sid (String)

    The SID of the Call resource to fetch.



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 356

def initialize(version, payload )
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'call_sid' => payload['call_sid'],
        'answered_by' => payload['answered_by'],
        'call_type' => payload['call_type'],
        'call_state' => payload['call_state'],
        'processing_state' => payload['processing_state'],
        'created_time' => Twilio.deserialize_iso8601_datetime(payload['created_time']),
        'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
        'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
        'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
        'connect_duration' => payload['connect_duration'] == nil ? payload['connect_duration'] : payload['connect_duration'].to_i,
        'from' => payload['from'],
        'to' => payload['to'],
        'carrier_edge' => payload['carrier_edge'],
        'client_edge' => payload['client_edge'],
        'sdk_edge' => payload['sdk_edge'],
        'sip_edge' => payload['sip_edge'],
        'tags' => payload['tags'],
        'url' => payload['url'],
        'attributes' => payload['attributes'],
        'properties' => payload['properties'],
        'trust' => payload['trust'],
        'annotation' => payload['annotation'],
    }
end

Instance Method Details

#account_sidString

Returns The unique SID identifier of the Account.

Returns:

  • (String)

    The unique SID identifier of the Account.



390
391
392
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 390

def 
    @properties['account_sid']
end

#annotationHash

Returns:

  • (Hash)


522
523
524
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 522

def annotation
    @properties['annotation']
end

#answered_byAnsweredBy

Returns:

  • (AnsweredBy)


402
403
404
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 402

def answered_by
    @properties['answered_by']
end

#attributesHash

Returns Attributes capturing call-flow-specific details.

Returns:

  • (Hash)

    Attributes capturing call-flow-specific details.



504
505
506
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 504

def attributes
    @properties['attributes']
end

#call_sidString

Returns The unique SID identifier of the Call.

Returns:

  • (String)

    The unique SID identifier of the Call.



396
397
398
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 396

def call_sid
    @properties['call_sid']
end

#call_stateCallState

Returns:

  • (CallState)


414
415
416
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 414

def call_state
    @properties['call_state']
end

#call_typeCallType

Returns:

  • (CallType)


408
409
410
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 408

def call_type
    @properties['call_type']
end

#carrier_edgeHash

Returns Contains metrics and properties for the Twilio media gateway of a PSTN call.

Returns:

  • (Hash)

    Contains metrics and properties for the Twilio media gateway of a PSTN call.



468
469
470
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 468

def carrier_edge
    @properties['carrier_edge']
end

#client_edgeHash

Returns Contains metrics and properties for the Twilio media gateway of a Client call.

Returns:

  • (Hash)

    Contains metrics and properties for the Twilio media gateway of a Client call.



474
475
476
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 474

def client_edge
    @properties['client_edge']
end

#connect_durationString

Returns Duration between when the call was answered and when it ended.

Returns:

  • (String)

    Duration between when the call was answered and when it ended



450
451
452
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 450

def connect_duration
    @properties['connect_duration']
end

#created_timeTime

Returns The time at which the Call was created, given in ISO 8601 format. Can be different from ‘start_time` in the event of queueing due to CPS.

Returns:

  • (Time)

    The time at which the Call was created, given in ISO 8601 format. Can be different from ‘start_time` in the event of queueing due to CPS



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

def created_time
    @properties['created_time']
end

#durationString

Returns Duration between when the call was initiated and the call was ended.

Returns:

  • (String)

    Duration between when the call was initiated and the call was ended



444
445
446
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 444

def duration
    @properties['duration']
end

#end_timeTime

Returns The time at which the Call was ended, given in ISO 8601 format.

Returns:

  • (Time)

    The time at which the Call was ended, given in ISO 8601 format.



438
439
440
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 438

def end_time
    @properties['end_time']
end

#fromHash

Returns The calling party.

Returns:

  • (Hash)

    The calling party.



456
457
458
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 456

def from
    @properties['from']
end

#inspectObject

Provide a detailed, user friendly representation



534
535
536
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 534

def inspect
    "<Twilio.Insights.V1.CallSummariesInstance>"
end

#processing_stateProcessingState

Returns:

  • (ProcessingState)


420
421
422
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 420

def processing_state
    @properties['processing_state']
end

#propertiesHash

Returns Contains edge-agnostic call-level details.

Returns:

  • (Hash)

    Contains edge-agnostic call-level details.



510
511
512
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 510

def properties
    @properties['properties']
end

#sdk_edgeHash

Returns Contains metrics and properties for the SDK sensor library for Client calls.

Returns:

  • (Hash)

    Contains metrics and properties for the SDK sensor library for Client calls.



480
481
482
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 480

def sdk_edge
    @properties['sdk_edge']
end

#sip_edgeHash

Returns Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.

Returns:

  • (Hash)

    Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.



486
487
488
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 486

def sip_edge
    @properties['sip_edge']
end

#start_timeTime

Returns The time at which the Call was started, given in ISO 8601 format.

Returns:

  • (Time)

    The time at which the Call was started, given in ISO 8601 format.



432
433
434
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 432

def start_time
    @properties['start_time']
end

#tagsArray<String>

Returns Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.

Returns:

  • (Array<String>)

    Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.



492
493
494
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 492

def tags
    @properties['tags']
end

#toHash

Returns The called party.

Returns:

  • (Hash)

    The called party.



462
463
464
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 462

def to
    @properties['to']
end

#to_sObject

Provide a user friendly representation



528
529
530
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 528

def to_s
    "<Twilio.Insights.V1.CallSummariesInstance>"
end

#trustHash

Returns Contains trusted communications details including Branded Call and verified caller ID.

Returns:

  • (Hash)

    Contains trusted communications details including Branded Call and verified caller ID.



516
517
518
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 516

def trust
    @properties['trust']
end

#urlString

Returns The URL of this resource.

Returns:

  • (String)

    The URL of this resource.



498
499
500
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 498

def url
    @properties['url']
end