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.



645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 645

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



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

def 
  @properties['account_sid']
end

#annotation ⇒ String

Returns The annotation provided for the call.

Returns:

  • (String) —

    The annotation provided for the call



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

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.



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

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



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

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.



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

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:



688
689
690
691
692
693
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 688

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CallInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

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.



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

def direction
  @properties['direction']
end

#duration ⇒ String

Returns The length of the call in seconds.

Returns:

  • (String) —

    The length of the call in seconds.



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

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.



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

def end_time
  @properties['end_time']
end

#events ⇒ events

Access the events

Returns:



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

def events
  context.events
end

#feedback ⇒ feedback

Access the feedback

Returns:



936
937
938
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 936

def feedback
  context.feedback
end

#fetch ⇒ CallInstance

Fetch the CallInstance

Returns:



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

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.



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

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



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

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.



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

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.



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

def group_sid
  @properties['group_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#notifications ⇒ notifications

Access the notifications

Returns:



929
930
931
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 929

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.



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

def parent_call_sid
  @properties['parent_call_sid']
end

#payments ⇒ payments

Access the payments

Returns:



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

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.



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

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.



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

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.



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

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.



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

def queue_time
  @properties['queue_time']
end

#recordings ⇒ recordings

Access the recordings

Returns:



922
923
924
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 922

def recordings
  context.recordings
end

#sid ⇒ String

Returns The unique string that identifies this resource.

Returns:

  • (String) —

    The unique string that identifies this resource



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

def sid
  @properties['sid']
end

#siprec ⇒ siprec

Access the siprec

Returns:



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

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.



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

def start_time
  @properties['start_time']
end

#status ⇒ call.Status

Returns The status of this call.

Returns:

  • (call.Status) —

    The status of this call.



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

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



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

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



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

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.



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

def to_formatted
  @properties['to_formatted']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

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:



905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 905

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`



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

def uri
  @properties['uri']
end