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 that created this Call resource.

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

    The SID of the Call resource to fetch.



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 664

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

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

  # 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



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

def 
  @properties['account_sid']
end

#annotation ⇒ String

Returns The annotation provided for the call.

Returns:

  • (String) —

    The annotation provided for the call



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

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.



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

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



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

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.



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

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:



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CallInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



879
880
881
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 879

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.



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

def direction
  @properties['direction']
end

#duration ⇒ String

Returns The length of the call in seconds.

Returns:

  • (String) —

    The length of the call in seconds.



794
795
796
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 794

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.



788
789
790
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 788

def end_time
  @properties['end_time']
end

#events ⇒ events

Access the events

Returns:



962
963
964
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 962

def events
  context.events
end

#feedback ⇒ feedback

Access the feedback

Returns:



955
956
957
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 955

def feedback
  context.feedback
end

#fetch ⇒ CallInstance

Fetch the CallInstance

Returns:



886
887
888
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 886

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.



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

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



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

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.



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

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.



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

def group_sid
  @properties['group_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



996
997
998
999
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 996

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

#notifications ⇒ notifications

Access the notifications

Returns:



948
949
950
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 948

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.



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

def parent_call_sid
  @properties['parent_call_sid']
end

#payments ⇒ payments

Access the payments

Returns:



969
970
971
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 969

def payments
  context.payments
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.



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

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.



800
801
802
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 800

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.



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

def price_unit
  @properties['price_unit']
end

#queue_time ⇒ String

Returns The wait time in milliseconds before the call is placed.

Returns:

  • (String) —

    The wait time in milliseconds before the call is placed.



854
855
856
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 854

def queue_time
  @properties['queue_time']
end

#recordings ⇒ recordings

Access the recordings

Returns:



941
942
943
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 941

def recordings
  context.recordings
end

#sid ⇒ String

Returns The unique string that identifies this resource.

Returns:

  • (String) —

    The unique string that identifies this resource



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

def sid
  @properties['sid']
end

#siprec ⇒ siprec

Access the siprec

Returns:



976
977
978
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 976

def siprec
  context.siprec
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.



782
783
784
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 782

def start_time
  @properties['start_time']
end

#status ⇒ call.Status

Returns The status of this call.

Returns:

  • (call.Status) —

    The status of this call.



776
777
778
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 776

def status
  @properties['status']
end

#streams ⇒ streams

Access the streams

Returns:



983
984
985
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 983

def streams
  context.streams
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



872
873
874
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 872

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



989
990
991
992
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 989

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

#trunk_sid ⇒ String

Returns The (optional) unique identifier of the trunk resource that was used for this call.

Returns:

  • (String) —

    The (optional) unique identifier of the trunk resource that was used for this call.



860
861
862
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 860

def trunk_sid
  @properties['trunk_sid']
end

#update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset, time_limit: :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 section in Making 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.

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

    TwiML instructions for the call Twilio will use without fetching Twiml from url. Twiml and url parameters are mutually exclusive

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

    The maximum duration of the call in seconds. Constraints depend on account and configuration.

Returns:



924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 924

def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset, twiml: :unset, time_limit: :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,
      twiml: twiml,
      time_limit: time_limit,
  )
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`



866
867
868
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 866

def uri
  @properties['uri']
end