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.



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 628

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'],
        '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](www.twilio.com/docs/iam/api/account) that created this Call resource.

Returns:



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

def 
    @properties['account_sid']
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.



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

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.



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

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.



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

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:



670
671
672
673
674
675
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 670

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 and time in GMT that this resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that this resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CallInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#direction ⇒ String

Returns A string describing the direction of the call. Can be: ‘inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `<Dial>` verb. Using [Elastic SIP Trunking](www.twilio.com/docs/sip-trunking), the values can be [`trunking-terminating`](www.twilio.com/docs/sip-trunking#termination) for outgoing calls from your communications infrastructure to the PSTN or [`trunking-originating`](www.twilio.com/docs/sip-trunking#origination) for incoming calls to your communications infrastructure from the PSTN.

Returns:



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

def direction
    @properties['direction']
end

#duration ⇒ String

Returns The length of the call in seconds. This value is empty for busy, failed, unanswered, or ongoing calls.

Returns:

  • (String) —

    The length of the call in seconds. This value is empty for busy, failed, unanswered, or ongoing calls.



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

def duration
    @properties['duration']
end

#end_time ⇒ Time

Returns The time the call ended, given as GMT in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format. Empty if the call did not complete successfully.

Returns:



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

def end_time
    @properties['end_time']
end

#events ⇒ events

Access the events

Returns:



889
890
891
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 889

def events
    context.events
end

#feedback ⇒ feedback

Access the feedback

Returns:



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

def feedback
    context.feedback
end

#fetch ⇒ CallInstance

Fetch the CallInstance

Returns:



844
845
846
847
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 844

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.



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

def forwarded_from
    @properties['forwarded_from']
end

#from ⇒ String

Returns The phone number, SIP address, Client identifier or SIM SID that made this call. Phone numbers are in [E.164](www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.

Returns:

  • (String) —

    The phone number, SIP address, Client identifier or SIM SID that made this call. Phone numbers are in [E.164](www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.



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

def from
    @properties['from']
end

#from_formatted ⇒ String

Returns The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in [E.164](www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).

Returns:

  • (String) —

    The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in [E.164](www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).



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

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.



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

def group_sid
    @properties['group_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#notifications ⇒ notifications

Access the notifications

Returns:



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

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.



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

def parent_call_sid
    @properties['parent_call_sid']
end

#payments ⇒ payments

Access the payments

Returns:



917
918
919
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 917

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.



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

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.



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

def price
    @properties['price']
end

#price_unit ⇒ String

Returns The currency in which ‘Price` is measured, in [ISO 4127](www.iso.org/iso/home/standards/currency_codes.htm) format (e.g., `USD`, `EUR`, `JPY`). Always capitalized for calls.

Returns:



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

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.



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

def queue_time
    @properties['queue_time']
end

#recordings ⇒ recordings

Access the recordings

Returns:



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

def recordings
    context.recordings
end

#sid ⇒ String

Returns The unique string that we created to identify this Call resource.

Returns:

  • (String) —

    The unique string that we created to identify this Call resource.



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

def sid
    @properties['sid']
end

#siprec ⇒ siprec

Access the siprec

Returns:



903
904
905
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 903

def siprec
    context.siprec
end

#start_time ⇒ Time

Returns The start time of the call, given as GMT in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format. Empty if the call has not yet been dialed.

Returns:



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

def start_time
    @properties['start_time']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#streams ⇒ streams

Access the streams

Returns:



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

def streams
    context.streams
end

#subresource_uris ⇒ Hash

Returns A list of subresources available to this call, identified by their URIs relative to ‘api.twilio.com`.

Returns:

  • (Hash) —

    A list of subresources available to this call, identified by their URIs relative to ‘api.twilio.com`.



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

def subresource_uris
    @properties['subresource_uris']
end

#to ⇒ String

Returns The phone number, SIP address, Client identifier or SIM SID that received this call. Phone numbers are in [E.164](www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.

Returns:

  • (String) —

    The phone number, SIP address, Client identifier or SIM SID that received this call. Phone numbers are in [E.164](www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.



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

def to
    @properties['to']
end

#to_formatted ⇒ String

Returns The phone number, SIP address or Client identifier that received this call. Formatted for display. Non-North American phone numbers are in [E.164](www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).

Returns:

  • (String) —

    The phone number, SIP address or Client identifier that received this call. Formatted for display. Non-North American phone numbers are in [E.164](www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).



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

def to_formatted
    @properties['to_formatted']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#trunk_sid ⇒ String

Returns The unique identifier of the trunk resource that was used for this call. The field is empty if the call was not made using a SIP trunk or if the call is not terminated.

Returns:

  • (String) —

    The unique identifier of the trunk resource that was used for this call. The field is empty if the call was not made using a SIP trunk or if the call is not terminated.



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

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](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 (UpdateStatus) (defaults to: :unset)
  • 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:



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 861

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



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

def uri
    @properties['uri']
end

#user_defined_message_subscriptions ⇒ user_defined_message_subscriptions

Access the user_defined_message_subscriptions

Returns:



910
911
912
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 910

def user_defined_message_subscriptions
    context.user_defined_message_subscriptions
end

#user_defined_messages ⇒ user_defined_messages

Access the user_defined_messages

Returns:



896
897
898
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 896

def user_defined_messages
    context.user_defined_messages
end