Class: Twilio::REST::Api::V2010::AccountContext::CallInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::CallInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/call.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created this Call resource.
-
#answered_by ⇒ String
Either ‘human` or `machine` if this call was initiated with answering machine detection.
-
#api_version ⇒ String
The API version used to create the call.
-
#caller_name ⇒ String
The caller’s name if this call was an incoming call to a phone number with caller ID Lookup enabled.
-
#context ⇒ CallContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT that this resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT that this resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#delete ⇒ Boolean
Delete the CallInstance.
-
#direction ⇒ String
A string describing the direction of the call.
-
#duration ⇒ String
The length of the call in seconds.
-
#end_time ⇒ Time
The time the call ended, given as GMT in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.
-
#events ⇒ events
Access the events.
-
#feedback ⇒ feedback
Access the feedback.
-
#fetch ⇒ CallInstance
Fetch the CallInstance.
-
#forwarded_from ⇒ String
The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding).
-
#from ⇒ String
The phone number, SIP address, Client identifier or SIM SID that made this call.
-
#from_formatted ⇒ String
The calling phone number, SIP address, or Client identifier formatted for display.
-
#group_sid ⇒ String
The Group SID associated with this call.
-
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ CallInstance
constructor
Initialize the CallInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#notifications ⇒ notifications
Access the notifications.
-
#parent_call_sid ⇒ String
The SID that identifies the call that created this leg.
-
#payments ⇒ payments
Access the payments.
-
#phone_number_sid ⇒ String
If the call was inbound, this is the SID of the IncomingPhoneNumber resource that received the call.
-
#price ⇒ String
The charge for this call, in the currency associated with the account.
-
#price_unit ⇒ String
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`).
-
#queue_time ⇒ String
The wait time in milliseconds before the call is placed.
-
#recordings ⇒ recordings
Access the recordings.
-
#sid ⇒ String
The unique string that we created to identify this Call resource.
-
#siprec ⇒ siprec
Access the siprec.
-
#start_time ⇒ Time
The start time of the call, given as GMT in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.
- #status ⇒ Status
-
#streams ⇒ streams
Access the streams.
-
#subresource_uris ⇒ Hash
A list of subresources available to this call, identified by their URIs relative to ‘api.twilio.com`.
-
#to ⇒ String
The phone number, SIP address, Client identifier or SIM SID that received this call.
-
#to_formatted ⇒ String
The phone number, SIP address or Client identifier that received this call.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#trunk_sid ⇒ String
The unique identifier of the trunk resource that was used for this call.
-
#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.
-
#uri ⇒ String
The URI of this resource, relative to ‘api.twilio.com`.
-
#user_defined_message_subscriptions ⇒ user_defined_message_subscriptions
Access the user_defined_message_subscriptions.
-
#user_defined_messages ⇒ user_defined_messages
Access the user_defined_messages.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ CallInstance
Initialize the CallInstance
617 618 619 620 621 622 623 624 625 626 627 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 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 617 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' => 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.
692 693 694 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 692 def account_sid @properties['account_sid'] end |
#answered_by ⇒ String
Returns Either ‘human` or `machine` if this call was initiated with answering machine detection. Empty otherwise.
770 771 772 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 770 def answered_by @properties['answered_by'] end |
#api_version ⇒ String
Returns The API version used to create the call.
776 777 778 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 776 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.
794 795 796 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 794 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
659 660 661 662 663 664 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 659 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.
674 675 676 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 674 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.
680 681 682 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 680 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the CallInstance
825 826 827 828 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 825 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.
764 765 766 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 764 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.
746 747 748 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 746 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.
740 741 742 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 740 def end_time @properties['end_time'] end |
#events ⇒ events
Access the events
878 879 880 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 878 def events context.events end |
#feedback ⇒ feedback
Access the feedback
927 928 929 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 927 def feedback context.feedback end |
#fetch ⇒ CallInstance
Fetch the CallInstance
833 834 835 836 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 833 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.
782 783 784 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 782 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`.
710 711 712 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 710 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).
716 717 718 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 716 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.
788 789 790 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 788 def group_sid @properties['group_sid'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
947 948 949 950 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 947 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.CallInstance #{values}>" end |
#notifications ⇒ notifications
Access the notifications
920 921 922 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 920 def notifications context.notifications end |
#parent_call_sid ⇒ String
Returns The SID that identifies the call that created this leg.
686 687 688 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 686 def parent_call_sid @properties['parent_call_sid'] end |
#payments ⇒ payments
Access the payments
906 907 908 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 906 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.
722 723 724 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 722 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.
752 753 754 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 752 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.
758 759 760 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 758 def price_unit @properties['price_unit'] end |
#queue_time ⇒ String
Returns The wait time in milliseconds before the call is placed.
800 801 802 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 800 def queue_time @properties['queue_time'] end |
#recordings ⇒ recordings
Access the recordings
913 914 915 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 913 def recordings context.recordings end |
#sid ⇒ String
Returns The unique string that we created to identify this Call resource.
668 669 670 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 668 def sid @properties['sid'] end |
#siprec ⇒ siprec
Access the siprec
892 893 894 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 892 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.
734 735 736 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 734 def start_time @properties['start_time'] end |
#status ⇒ Status
728 729 730 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 728 def status @properties['status'] end |
#streams ⇒ streams
Access the streams
934 935 936 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 934 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`.
818 819 820 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 818 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`.
698 699 700 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 698 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).
704 705 706 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 704 def to_formatted @properties['to_formatted'] end |
#to_s ⇒ Object
Provide a user friendly representation
940 941 942 943 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 940 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.
806 807 808 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 806 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
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 850 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`.
812 813 814 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 812 def uri @properties['uri'] end |
#user_defined_message_subscriptions ⇒ user_defined_message_subscriptions
Access the user_defined_message_subscriptions
899 900 901 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 899 def context. end |
#user_defined_messages ⇒ user_defined_messages
Access the user_defined_messages
885 886 887 |
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 885 def context. end |