Class: Twilio::REST::Api::V2010::AccountContext::CallInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/call.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ CallInstance

Initialize the CallInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil) —

    The unique id of the [Account](www.twilio.com/docs/api/rest/account) responsible for creating this Call.

  • sid (String) (defaults to: nil) —

    The Call Sid that uniquely identifies the Call to fetch



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 541

def initialize(version, payload, account_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'annotation' => payload['annotation'],
      'answered_by' => payload['answered_by'],
      'api_version' => payload['api_version'],
      'caller_name' => payload['caller_name'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'direction' => payload['direction'],
      'duration' => payload['duration'],
      'end_time' => Twilio.deserialize_rfc2822(payload['end_time']),
      'forwarded_from' => payload['forwarded_from'],
      'from' => payload['from'],
      'from_formatted' => payload['from_formatted'],
      'group_sid' => payload['group_sid'],
      'parent_call_sid' => payload['parent_call_sid'],
      'phone_number_sid' => payload['phone_number_sid'],
      'price' => payload['price'].to_f,
      'price_unit' => payload['price_unit'],
      'sid' => payload['sid'],
      'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
      'status' => payload['status'],
      'subresource_uris' => payload['subresource_uris'],
      'to' => payload['to'],
      'to_formatted' => payload['to_formatted'],
      'uri' => payload['uri'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account responsible for creating this Call.

Returns:

  • (String) —

    The unique id of the Account responsible for creating this Call



591
592
593
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 591

def 
  @properties['account_sid']
end

#annotation ⇒ String

Returns The annotation provided for the Call.

Returns:

  • (String) —

    The annotation provided for the Call



597
598
599
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 597

def annotation
  @properties['annotation']
end

#answered_by ⇒ String

Returns Either ‘human` or `machine` if this Call was initiated with answering machine detection. Empty otherwise.

Returns:

  • (String) —

    Either ‘human` or `machine` if this Call was initiated with answering machine detection. Empty otherwise.



603
604
605
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 603

def answered_by
  @properties['answered_by']
end

#api_version ⇒ String

Returns The API Version used to create the Call.

Returns:

  • (String) —

    The API Version used to create the Call



609
610
611
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 609

def api_version
  @properties['api_version']
end

#caller_name ⇒ String

Returns The caller’s name if this Call was an incoming call to a phone number with Caller ID Lookup enabled. Empty otherwise.

Returns:

  • (String) —

    The caller’s name if this Call was an incoming call to a phone number with Caller ID Lookup enabled. Empty otherwise.



615
616
617
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 615

def caller_name
  @properties['caller_name']
end

#context ⇒ CallContext

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

Returns:



582
583
584
585
586
587
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 582

def context
  unless @instance_context
    @instance_context = CallContext.new(@version, @params['account_sid'], @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created



621
622
623
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 621

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated



627
628
629
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 627

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the CallInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



742
743
744
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 742

def delete
  context.delete
end

#direction ⇒ String

Returns A string describing the direction of the Call. ‘inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `Dial` verb.

Returns:

  • (String) —

    A string describing the direction of the Call. ‘inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `Dial` verb.



633
634
635
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 633

def direction
  @properties['direction']
end

#duration ⇒ String

Returns The length of the Call in seconds.

Returns:

  • (String) —

    The length of the Call in seconds.



639
640
641
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 639

def duration
  @properties['duration']
end

#end_time ⇒ Time

Returns The end time of the Call. Null if the call did not complete successfully.

Returns:

  • (Time) —

    The end time of the Call. Null if the call did not complete successfully.



645
646
647
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 645

def end_time
  @properties['end_time']
end

#feedback ⇒ feedback

Access the feedback

Returns:



811
812
813
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 811

def feedback
  context.feedback
end

#fetch ⇒ CallInstance

Fetch a CallInstance

Returns:



749
750
751
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 749

def fetch
  context.fetch
end

#forwarded_from ⇒ String

Returns The forwarding phone number if this Call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Empty otherwise.

Returns:

  • (String) —

    The forwarding phone number if this Call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Empty otherwise.



651
652
653
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 651

def forwarded_from
  @properties['forwarded_from']
end

#from ⇒ String

Returns The phone number, SIP address or Client identifier that made this Call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`.

Returns:

  • (String) —

    The phone number, SIP address or Client identifier that made this Call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`.



657
658
659
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 657

def from
  @properties['from']
end

#from_formatted ⇒ String

Returns The phone number, SIP address or Client identifier that made this Call. Formatted for display.

Returns:

  • (String) —

    The phone number, SIP address or Client identifier that made this Call. Formatted for display.



663
664
665
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 663

def from_formatted
  @properties['from_formatted']
end

#group_sid ⇒ String

Returns A 34-character Group Sid associated with this Call. Empty if no Group is associated with the Call.

Returns:

  • (String) —

    A 34-character Group Sid associated with this Call. Empty if no Group is associated with the Call.



669
670
671
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 669

def group_sid
  @properties['group_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



824
825
826
827
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 824

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

#notifications ⇒ notifications

Access the notifications

Returns:



804
805
806
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 804

def notifications
  context.notifications
end

#parent_call_sid ⇒ String

Returns A 34-character string that uniquely identifies the Call that created this leg.

Returns:

  • (String) —

    A 34-character string that uniquely identifies the Call that created this leg.



675
676
677
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 675

def parent_call_sid
  @properties['parent_call_sid']
end

#phone_number_sid ⇒ String

Returns If the call was inbound, this is the Sid of the ‘IncomingPhoneNumber` that received the call. If the call was outbound, it is the Sid of the `OutgoingCallerId` from which the call was placed.

Returns:

  • (String) —

    If the call was inbound, this is the Sid of the ‘IncomingPhoneNumber` that received the call. If the call was outbound, it is the Sid of the `OutgoingCallerId` from which the call was placed.



681
682
683
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 681

def phone_number_sid
  @properties['phone_number_sid']
end

#price ⇒ String

Returns The charge for this Call, in the currency associated with the account. Populated after the call is completed. May not be immediately available.

Returns:

  • (String) —

    The charge for this Call, in the currency associated with the account. Populated after the call is completed. May not be immediately available.



687
688
689
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 687

def price
  @properties['price']
end

#price_unit ⇒ String

Returns The currency in which ‘Price` is measured.

Returns:

  • (String) —

    The currency in which ‘Price` is measured.



693
694
695
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 693

def price_unit
  @properties['price_unit']
end

#recordings ⇒ recordings

Access the recordings

Returns:



797
798
799
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 797

def recordings
  context.recordings
end

#sid ⇒ String

Returns A 34-character string that uniquely identifies the Call resource.

Returns:

  • (String) —

    A 34-character string that uniquely identifies the Call resource.



699
700
701
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 699

def sid
  @properties['sid']
end

#start_time ⇒ Time

Returns The start time of the Call. Null if the call has not yet been dialed.

Returns:

  • (Time) —

    The start time of the Call. Null if the call has not yet been dialed.



705
706
707
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 705

def start_time
  @properties['start_time']
end

#status ⇒ call.Status

Returns A string representing the status of the Call.

Returns:

  • (call.Status) —

    A string representing the status of the Call.



711
712
713
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 711

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns Call Instance Subresources.

Returns:

  • (String) —

    Call Instance Subresources



717
718
719
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 717

def subresource_uris
  @properties['subresource_uris']
end

#to ⇒ String

Returns The phone number, SIP address or Client identifier that received this Call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`.

Returns:

  • (String) —

    The phone number, SIP address or Client identifier that received this Call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`.



723
724
725
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 723

def to
  @properties['to']
end

#to_formatted ⇒ String

Returns The phone number, SIP address or Client identifier that received this Call. Formatted for display.

Returns:

  • (String) —

    The phone number, SIP address or Client identifier that received this Call. Formatted for display.



729
730
731
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 729

def to_formatted
  @properties['to_formatted']
end

#to_s ⇒ Object

Provide a user friendly representation



817
818
819
820
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 817

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

#update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset) ⇒ CallInstance

Update the CallInstance

Parameters:

  • url (String) (defaults to: :unset) —

    that hosts instructions for the call. Twilio will consult this URL when the call connects. See the [Url Parameter](www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](www.twilio.com/docs/voice/make-calls) for more details.

  • method (String) (defaults to: :unset) —

    The HTTP method Twilio should use when making its request to the ‘Url` parameter’s value. Defaults to ‘POST`. If an `ApplicationSid` parameter is present, this parameter is ignored.

  • status (call.UpdateStatus) (defaults to: :unset) —

    Either ‘canceled` or `completed`. Specifying `canceled` will attempt to hang up calls that are queued or ringing, but will not affect calls already in progress. Specifying `completed` will attempt to hang up a call even if it’s already in progress.

  • fallback_url (String) (defaults to: :unset) —

    A URL that Twilio will request if an error occurs when requesting or executing the TwiML at ‘Url`. If an `ApplicationSid` parameter is present, this parameter is ignored.

  • fallback_method (String) (defaults to: :unset) —

    The HTTP method that Twilio should use to request the ‘FallbackUrl`. Must be either `GET` or `POST`. Defaults to `POST`. If an `ApplicationSid` parameter is present, this parameter is ignored.

  • status_callback (String) (defaults to: :unset) —

    A URL that Twilio will send asynchronous webhook requests to on every call event specified in the ‘StatusCallbackEvent` parameter. If no event is specified, Twilio will send `completed` by default. If an `ApplicationSid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).

  • status_callback_method (String) (defaults to: :unset) —

    The HTTP method Twilio should use when requesting the ‘StatusCallback` URL. Defaults to `POST`. If an `ApplicationSid` parameter is present, this parameter is ignored.

Returns:



782
783
784
785
786
787
788
789
790
791
792
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 782

def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset)
  context.update(
      url: url,
      method: method,
      status: status,
      fallback_url: fallback_url,
      fallback_method: fallback_method,
      status_callback: status_callback,
      status_callback_method: status_callback_method,
  )
end

#uri ⇒ String

Returns The URI for this resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI for this resource, relative to ‘api.twilio.com`



735
736
737
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 735

def uri
  @properties['uri']
end