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.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 308

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.



342
343
344
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 342

def 
    @properties['account_sid']
end

#annotationHash

Returns:

  • (Hash)


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

def annotation
    @properties['annotation']
end

#answered_byAnsweredBy

Returns:

  • (AnsweredBy)


354
355
356
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 354

def answered_by
    @properties['answered_by']
end

#attributesHash

Returns Attributes capturing call-flow-specific details.

Returns:

  • (Hash)

    Attributes capturing call-flow-specific details.



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

def attributes
    @properties['attributes']
end

#call_sidString

Returns The unique SID identifier of the Call.

Returns:

  • (String)

    The unique SID identifier of the Call.



348
349
350
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 348

def call_sid
    @properties['call_sid']
end

#call_stateCallState

Returns:

  • (CallState)


366
367
368
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 366

def call_state
    @properties['call_state']
end

#call_typeCallType

Returns:

  • (CallType)


360
361
362
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 360

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.



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

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.



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

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



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

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



378
379
380
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 378

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



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

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.



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

def end_time
    @properties['end_time']
end

#fromHash

Returns The calling party.

Returns:

  • (Hash)

    The calling party.



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

def from
    @properties['from']
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#processing_stateProcessingState

Returns:

  • (ProcessingState)


372
373
374
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 372

def processing_state
    @properties['processing_state']
end

#propertiesHash

Returns Contains edge-agnostic call-level details.

Returns:

  • (Hash)

    Contains edge-agnostic call-level details.



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

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.



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

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.



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

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.



384
385
386
# File 'lib/twilio-ruby/rest/insights/v1/call_summaries.rb', line 384

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.



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

def tags
    @properties['tags']
end

#toHash

Returns The called party.

Returns:

  • (Hash)

    The called party.



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

def to
    @properties['to']
end

#to_sObject

Provide a user friendly representation



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

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.



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

def trust
    @properties['trust']
end

#urlString

Returns The URL of this resource.

Returns:

  • (String)

    The URL of this resource.



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

def url
    @properties['url']
end