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.



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
386
387
388
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 359

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.



393
394
395
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 393

def 
    @properties['account_sid']
end

#annotationHash

Returns:

  • (Hash)


525
526
527
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 525

def annotation
    @properties['annotation']
end

#answered_byAnsweredBy

Returns:

  • (AnsweredBy)


405
406
407
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 405

def answered_by
    @properties['answered_by']
end

#attributesHash

Returns Attributes capturing call-flow-specific details.

Returns:

  • (Hash)

    Attributes capturing call-flow-specific details.



507
508
509
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 507

def attributes
    @properties['attributes']
end

#call_sidString

Returns The unique SID identifier of the Call.

Returns:

  • (String)

    The unique SID identifier of the Call.



399
400
401
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 399

def call_sid
    @properties['call_sid']
end

#call_stateCallState

Returns:

  • (CallState)


417
418
419
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 417

def call_state
    @properties['call_state']
end

#call_typeCallType

Returns:

  • (CallType)


411
412
413
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 411

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.



471
472
473
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 471

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.



477
478
479
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 477

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



453
454
455
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 453

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



429
430
431
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 429

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



447
448
449
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 447

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.



441
442
443
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 441

def end_time
    @properties['end_time']
end

#fromHash

Returns The calling party.

Returns:

  • (Hash)

    The calling party.



459
460
461
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 459

def from
    @properties['from']
end

#inspectObject

Provide a detailed, user friendly representation



537
538
539
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 537

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

#processing_stateProcessingState

Returns:

  • (ProcessingState)


423
424
425
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 423

def processing_state
    @properties['processing_state']
end

#propertiesHash

Returns Contains edge-agnostic call-level details.

Returns:

  • (Hash)

    Contains edge-agnostic call-level details.



513
514
515
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 513

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.



483
484
485
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 483

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.



489
490
491
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 489

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.



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

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.



495
496
497
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 495

def tags
    @properties['tags']
end

#toHash

Returns The called party.

Returns:

  • (Hash)

    The called party.



465
466
467
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 465

def to
    @properties['to']
end

#to_sObject

Provide a user friendly representation



531
532
533
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 531

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.



519
520
521
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 519

def trust
    @properties['trust']
end

#urlString

Returns The URL of this resource.

Returns:

  • (String)

    The URL of this resource.



501
502
503
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 501

def url
    @properties['url']
end