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 unique id of the Account responsible for creating this Call

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

    The Call Sid that uniquely identifies the Call to fetch



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 474

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

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

  # Context
  @instance_context = nil
  @params = {'account_sid' => , 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account responsible for creating this Call.

Returns:

  • (String) —

    The unique id of the Account responsible for creating this Call



524
525
526
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 524

def 
  @properties['account_sid']
end

#annotation ⇒ String

Returns The annotation provided for the Call.

Returns:

  • (String) —

    The annotation provided for the Call



530
531
532
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 530

def annotation
  @properties['annotation']
end

#answered_by ⇒ String

Returns If this call was initiated with answering machine detection, either ‘human` or `machine`. Empty otherwise.

Returns:

  • (String) —

    If this call was initiated with answering machine detection, either ‘human` or `machine`. Empty otherwise.



536
537
538
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 536

def answered_by
  @properties['answered_by']
end

#api_version ⇒ String

Returns The API Version the Call was created through.

Returns:

  • (String) —

    The API Version the Call was created through



542
543
544
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 542

def api_version
  @properties['api_version']
end

#caller_name ⇒ String

Returns If this call was an incoming call to a phone number with Caller ID Lookup enabled, the caller’s name. Empty otherwise.

Returns:

  • (String) —

    If this call was an incoming call to a phone number with Caller ID Lookup enabled, the caller’s name. Empty otherwise.



548
549
550
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 548

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:



515
516
517
518
519
520
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 515

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

Returns:

  • (Time) —

    The date that this resource was created



554
555
556
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 554

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated



560
561
562
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 560

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the CallInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



675
676
677
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 675

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.



566
567
568
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 566

def direction
  @properties['direction']
end

#duration ⇒ String

Returns The duration.

Returns:

  • (String) —

    The duration



572
573
574
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 572

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.



578
579
580
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 578

def end_time
  @properties['end_time']
end

#feedback ⇒ feedback

Access the feedback

Returns:



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

def feedback
  context.feedback
end

#fetch ⇒ CallInstance

Fetch a CallInstance

Returns:



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

def fetch
  context.fetch
end

#forwarded_from ⇒ String

Returns If this Call was an incoming call forwarded from another number, the forwarding phone number (depends on carrier supporting forwarding). Empty otherwise.

Returns:

  • (String) —

    If this Call was an incoming call forwarded from another number, the forwarding phone number (depends on carrier supporting forwarding). Empty otherwise.



584
585
586
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 584

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



590
591
592
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 590

def from
  @properties['from']
end

#from_formatted ⇒ String

Returns The phone number, SIP address or Client identifier that made this Call. Formatted for display.

Returns:

  • (String) —

    The phone number, SIP address or Client identifier that made this Call. Formatted for display.



596
597
598
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 596

def from_formatted
  @properties['from_formatted']
end

#group_sid ⇒ String

Returns A 34 character Group Sid associated with this Call. Empty if no Group is associated with the Call.

Returns:

  • (String) —

    A 34 character Group Sid associated with this Call. Empty if no Group is associated with the Call.



602
603
604
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 602

def group_sid
  @properties['group_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#notifications ⇒ notifications

Access the notifications

Returns:



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

def notifications
  context.notifications
end

#parent_call_sid ⇒ String

Returns A 34 character string that uniquely identifies the Call that created this leg.

Returns:

  • (String) —

    A 34 character string that uniquely identifies the Call that created this leg.



608
609
610
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 608

def parent_call_sid
  @properties['parent_call_sid']
end

#phone_number_sid ⇒ String

Returns If the call was inbound, this is the Sid of the IncomingPhoneNumber that received the call. If the call was outbound, it is the Sid of the OutgoingCallerId from which the call was placed.

Returns:

  • (String) —

    If the call was inbound, this is the Sid of the IncomingPhoneNumber that received the call. If the call was outbound, it is the Sid of the OutgoingCallerId from which the call was placed.



614
615
616
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 614

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.



620
621
622
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 620

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.



626
627
628
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 626

def price_unit
  @properties['price_unit']
end

#recordings ⇒ recordings

Access the recordings

Returns:



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

def recordings
  context.recordings
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



632
633
634
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 632

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



638
639
640
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 638

def start_time
  @properties['start_time']
end

#status ⇒ call.Status

Returns The status.

Returns:

  • (call.Status) —

    The status



644
645
646
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 644

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns Call Instance Subresources.

Returns:

  • (String) —

    Call Instance Subresources



650
651
652
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 650

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



656
657
658
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 656

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.



662
663
664
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 662

def to_formatted
  @properties['to_formatted']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset) ⇒ CallInstance

Update the CallInstance

Parameters:

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

    A valid URL that returns TwiML. Twilio will immediately redirect the call to the new TwiML upon execution.

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

    The HTTP method Twilio should use when requesting the URL. Defaults to ‘POST`.

  • status (call.UpdateStatus) (defaults to: :unset) —

    Either ‘canceled` or `completed`. Specifying `canceled` will attempt to hangup calls that are queued or ringing but 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) —

    A URL that Twilio will request if an error occurs requesting or executing the TwiML at ‘Url`.

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

    The HTTP method that Twilio should use to request the ‘FallbackUrl`. Must be either `GET` or `POST`. Defaults to `POST`.

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

    A URL that Twilio will request when the call ends to notify your app.

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

    The HTTP method that Twilio should use to request the ‘StatusCallback`. Defaults to `POST`.

Returns:



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

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

#uri ⇒ String

Returns The URI for this resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI for this resource, relative to ‘api.twilio.com`



668
669
670
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 668

def uri
  @properties['uri']
end