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.



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

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.



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

def 
    @properties['account_sid']
end

#annotationHash

Returns:

  • (Hash)


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

def annotation
    @properties['annotation']
end

#answered_byAnsweredBy

Returns:

  • (AnsweredBy)


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

def answered_by
    @properties['answered_by']
end

#attributesHash

Returns Attributes capturing call-flow-specific details.

Returns:

  • (Hash)

    Attributes capturing call-flow-specific details.



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

def attributes
    @properties['attributes']
end

#call_sidString

Returns The unique SID identifier of the Call.

Returns:

  • (String)

    The unique SID identifier of the Call.



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

def call_sid
    @properties['call_sid']
end

#call_stateCallState

Returns:

  • (CallState)


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

def call_state
    @properties['call_state']
end

#call_typeCallType

Returns:

  • (CallType)


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

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.



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

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.



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

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



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

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



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

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



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

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.



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

def end_time
    @properties['end_time']
end

#fromHash

Returns The calling party.

Returns:

  • (Hash)

    The calling party.



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

def from
    @properties['from']
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#processing_stateProcessingState

Returns:

  • (ProcessingState)


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

def processing_state
    @properties['processing_state']
end

#propertiesHash

Returns Contains edge-agnostic call-level details.

Returns:

  • (Hash)

    Contains edge-agnostic call-level details.



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

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.



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

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.



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

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.



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

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.



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

def tags
    @properties['tags']
end

#toHash

Returns The called party.

Returns:

  • (Hash)

    The called party.



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

def to
    @properties['to']
end

#to_sObject

Provide a user friendly representation



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

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.



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

def trust
    @properties['trust']
end

#urlString

Returns The URL of this resource.

Returns:

  • (String)

    The URL of this resource.



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

def url
    @properties['url']
end