Class: Twilio::REST::Insights::V1::CallContext::AnnotationContext

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, call_sid) ⇒ AnnotationContext

Initialize the AnnotationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • call_sid (String) —

    The unique string that Twilio created to identify this Call resource. It always starts with a CA.



53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 53

def initialize(version, call_sid)
    super(version)

    # Path Solution
    @solution = { call_sid: call_sid,  }
    @uri = "/Voice/#{@solution[:call_sid]}/Annotation"

    
end

Instance Method Details

#fetch ⇒ AnnotationInstance

Fetch the AnnotationInstance

Returns:



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 65

def fetch

    
    payload = @version.fetch('GET', @uri)
    AnnotationInstance.new(
        @version,
        payload,
        call_sid: @solution[:call_sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



125
126
127
128
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 125

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Insights.V1.AnnotationContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



118
119
120
121
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 118

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Insights.V1.AnnotationContext #{context}>"
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:

  • answered_by (AnsweredBy) (defaults to: :unset)
  • connectivity_issue (ConnectivityIssue) (defaults to: :unset)
  • quality_issues (String) (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.

  • spam (Boolean) (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.

  • call_score (String) (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].

  • comment (String) (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`.

  • incident (String) (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:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 86

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

    data = Twilio::Values.of({
        'AnsweredBy' => answered_by,
        'ConnectivityIssue' => connectivity_issue,
        'QualityIssues' => quality_issues,
        'Spam' => spam,
        'CallScore' => call_score,
        'Comment' => comment,
        'Incident' => incident,
    })

    
    payload = @version.update('POST', @uri, data: data)
    AnnotationInstance.new(
        @version,
        payload,
        call_sid: @solution[:call_sid],
    )
end