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 SID of the [Account](www.twilio.com/docs/api/rest/account) that created this Call resource.

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

    The Twilio-provided string that uniquely identifies the Call resource to fetch



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 564

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 SID of the Account that created this resource.

Returns:

  • (String) —

    The SID of the Account that created this resource



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

def 
  @properties['account_sid']
end

#annotation ⇒ String

Returns The annotation provided for the call.

Returns:

  • (String) —

    The annotation provided for the call



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

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.



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

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



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

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. Otherwise, empty.

Returns:

  • (String) —

    The caller’s name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty.



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

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:



605
606
607
608
609
610
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 605

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

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that this resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that this resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that this resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that this resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the CallInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



765
766
767
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 765

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.



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

def direction
  @properties['direction']
end

#duration ⇒ String

Returns The length of the call in seconds.

Returns:

  • (String) —

    The length of the call in seconds.



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

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.



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

def end_time
  @properties['end_time']
end

#feedback ⇒ feedback

Access the feedback

Returns:



835
836
837
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 835

def feedback
  context.feedback
end

#fetch ⇒ CallInstance

Fetch a CallInstance

Returns:



772
773
774
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 772

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). Otherwise, empty.

Returns:

  • (String) —

    The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty.



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

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`.



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

def from
  @properties['from']
end

#from_formatted ⇒ String

Returns The calling phone number, SIP address, or Client identifier formatted for display.

Returns:

  • (String) —

    The calling phone number, SIP address, or Client identifier formatted for display.



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

def from_formatted
  @properties['from_formatted']
end

#group_sid ⇒ String

Returns The Group SID associated with this call. If no Group is associated with the call, the field is empty.

Returns:

  • (String) —

    The Group SID associated with this call. If no Group is associated with the call, the field is empty.



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

def group_sid
  @properties['group_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



848
849
850
851
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 848

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

#notifications ⇒ notifications

Access the notifications

Returns:



828
829
830
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 828

def notifications
  context.notifications
end

#parent_call_sid ⇒ String

Returns The SID that identifies the call that created this leg.

Returns:

  • (String) —

    The SID that identifies the call that created this leg.



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

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 resource that received the call. If the call was outbound, it is the SID of the OutgoingCallerId resource from which the call was placed.

Returns:

  • (String) —

    If the call was inbound, this is the SID of the IncomingPhoneNumber resource that received the call. If the call was outbound, it is the SID of the OutgoingCallerId resource from which the call was placed.



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

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.



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

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.



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

def price_unit
  @properties['price_unit']
end

#recordings ⇒ recordings

Access the recordings

Returns:



821
822
823
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 821

def recordings
  context.recordings
end

#sid ⇒ String

Returns The unique string that identifies this resource.

Returns:

  • (String) —

    The unique string that identifies this resource



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

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.



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

def start_time
  @properties['start_time']
end

#status ⇒ call.Status

Returns The status of this call.

Returns:

  • (call.Status) —

    The status of this call.



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

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns A list of related subresources identified by their relative URIs.

Returns:

  • (String) —

    A list of related subresources identified by their relative URIs



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

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`.



746
747
748
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 746

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.



752
753
754
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 752

def to_formatted
  @properties['to_formatted']
end

#to_s ⇒ Object

Provide a user friendly representation



841
842
843
844
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 841

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) —

    The absolute URL that returns the TwiML instructions for the call. We will call this URL using the ‘method` when the call connects. For more information, 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).

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

    The HTTP method we should use when calling the ‘url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.

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

    The new status of the resource. Can be: ‘canceled` or `completed`. Specifying `canceled` will attempt to hang up calls that are queued or ringing; however, it 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) —

    The URL that we call using the ‘fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored.

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

    The HTTP method that we should use to request the ‘fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.

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

    The URL we should call using the ‘status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` 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 we should use when requesting the ‘status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.

Returns:



806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 806

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 of this resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

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



758
759
760
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 758

def uri
  @properties['uri']
end