Class: Twilio::REST::Insights::V1::CallContext::AnnotationInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, call_sid: nil) ⇒ AnnotationInstance

Initialize the AnnotationInstance

Parameters:

  • Version that contains the resource

  • payload that contains response from Twilio

  • The SID of the Account that created this Annotation resource.

  • The SID of the Call resource to fetch.



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 362

def initialize(version, payload , call_sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'call_sid' => payload['call_sid'],
        'account_sid' => payload['account_sid'],
        'answered_by' => payload['answered_by'],
        'connectivity_issue' => payload['connectivity_issue'],
        'quality_issues' => payload['quality_issues'],
        'spam' => payload['spam'],
        'call_score' => payload['call_score'] == nil ? payload['call_score'] : payload['call_score'].to_i,
        'comment' => payload['comment'],
        'incident' => payload['incident'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'call_sid' => call_sid  || @properties['call_sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • The unique SID identifier of the Account.



404
405
406
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 404

def 
    @properties['account_sid']
end

#answered_by ⇒ AnsweredBy

Returns:



410
411
412
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 410

def answered_by
    @properties['answered_by']
end

#call_score ⇒ String

Returns Specifies the Call Score, if available. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].

Returns:

  • Specifies the Call Score, if available. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].



434
435
436
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 434

def call_score
    @properties['call_score']
end

#call_sid ⇒ String

Returns The unique SID identifier of the Call.

Returns:

  • The unique SID identifier of the Call.



398
399
400
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 398

def call_sid
    @properties['call_sid']
end

#comment ⇒ String

Returns Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments.

Returns:

  • Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments.



440
441
442
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 440

def comment
    @properties['comment']
end

#connectivity_issue ⇒ ConnectivityIssue

Returns:



416
417
418
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 416

def connectivity_issue
    @properties['connectivity_issue']
end

#context ⇒ AnnotationContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:

  • CallContext for this CallInstance



389
390
391
392
393
394
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 389

def context
    unless @instance_context
        @instance_context = AnnotationContext.new(@version , @params['call_sid'])
    end
    @instance_context
end

#fetch ⇒ AnnotationInstance

Fetch the AnnotationInstance

Returns:

  • Fetched AnnotationInstance



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

def fetch

    context.fetch
end

#incident ⇒ String

Returns Incident or support ticket associated with this call. The incident property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in incident.

Returns:

  • Incident or support ticket associated with this call. The incident property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in incident.



446
447
448
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 446

def incident
    @properties['incident']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Insights.V1.AnnotationInstance #{values}>"
end

#quality_issues ⇒ Array<String>

Returns Specifies if the call had any subjective quality issues. Possible values are one or more of no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, or static_noise.

Returns:

  • Specifies if the call had any subjective quality issues. Possible values are one or more of no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, or static_noise.



422
423
424
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 422

def quality_issues
    @properties['quality_issues']
end

#spam ⇒ Boolean

Returns Specifies if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.

Returns:

  • Specifies if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.



428
429
430
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 428

def spam
    @properties['spam']
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Insights.V1.AnnotationInstance #{values}>"
end

#update(answered_by: :unset, connectivity_issue: :unset, quality_issues: :unset, spam: :unset, call_score: :unset, comment: :unset, incident: :unset) ⇒ AnnotationInstance

Update the AnnotationInstance

Parameters:

  • (defaults to: :unset)
  • (defaults to: :unset)
  • (defaults to: :unset)

    Specify if the call had any subjective quality issues. Possible values, one or more of no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call.

  • (defaults to: :unset)

    A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use true if the call was a spam call.

  • (defaults to: :unset)

    Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].

  • (defaults to: :unset)

    Specify any comments pertaining to the call. comment has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the comment.

  • (defaults to: :unset)

    Associate this call with an incident or support ticket. The incident parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in incident.

Returns:

  • Updated AnnotationInstance



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 474

def update(
    answered_by: :unset, 
    connectivity_issue: :unset, 
    quality_issues: :unset, 
    spam: :unset, 
    call_score: :unset, 
    comment: :unset, 
    incident: :unset
)

    context.update(
        answered_by: answered_by, 
        connectivity_issue: connectivity_issue, 
        quality_issues: quality_issues, 
        spam: spam, 
        call_score: call_score, 
        comment: comment, 
        incident: incident, 
    )
end

#url ⇒ String

Returns:



452
453
454
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 452

def url
    @properties['url']
end