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.



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
665
666
667
668
669
670
671
672
673
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 637

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:



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

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.



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

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.



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

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.



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

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:



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

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

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CallInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

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:



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

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.



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

def duration
    @properties['duration']
end

#end_time ⇒ Time

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

Returns:



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

def end_time
    @properties['end_time']
end

#events ⇒ events

Access the events

Returns:



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

def events
    context.events
end

#fetch ⇒ CallInstance

Fetch the CallInstance

Returns:



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

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.



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

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



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

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



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

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.



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

def group_sid
    @properties['group_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#notifications ⇒ notifications

Access the notifications

Returns:



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

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.



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

def parent_call_sid
    @properties['parent_call_sid']
end

#payments ⇒ payments

Access the payments

Returns:



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

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.



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

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. The price associated with a call only reflects the charge for connectivity. Charges for other call-related features such as Answering Machine Detection, Text-To-Speech, and SIP REFER are not included in this value.

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. The price associated with a call only reflects the charge for connectivity. Charges for other call-related features such as Answering Machine Detection, Text-To-Speech, and SIP REFER are not included in this value.



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

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:



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

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.



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

def queue_time
    @properties['queue_time']
end

#recordings ⇒ recordings

Access the recordings

Returns:



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

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.



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

def sid
    @properties['sid']
end

#siprec ⇒ siprec

Access the siprec

Returns:



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

def siprec
    context.siprec
end

#start_time ⇒ Time

Returns The start time of the call, given as UTC 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:



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

def start_time
    @properties['start_time']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#streams ⇒ streams

Access the streams

Returns:



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

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



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

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



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

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



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

def to_formatted
    @properties['to_formatted']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#transcriptions ⇒ transcriptions

Access the transcriptions

Returns:



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

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



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

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:



870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 870

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



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

def uri
    @properties['uri']
end

#user_defined_message_subscriptions ⇒ user_defined_message_subscriptions

Access the user_defined_message_subscriptions

Returns:



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

def user_defined_message_subscriptions
    context.user_defined_message_subscriptions
end

#user_defined_messages ⇒ user_defined_messages

Access the user_defined_messages

Returns:



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

def user_defined_messages
    context.user_defined_messages
end