Class: Twilio::REST::Api::V2010::AccountContext::CallContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/call.rb,
lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb,
lib/twilio-ruby/rest/api/v2010/account/call/recording.rb,
lib/twilio-ruby/rest/api/v2010/account/call/notification.rb

Defined Under Namespace

Classes: FeedbackContext, FeedbackInstance, FeedbackList, FeedbackPage, NotificationContext, NotificationInstance, NotificationList, NotificationPage, RecordingContext, RecordingInstance, RecordingList, RecordingPage

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ CallContext

Initialize the CallContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The account_sid

  • sid (String) —

    The Call Sid that uniquely identifies the Call to fetch



387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 387

def initialize(version, , sid)
  super(version)

  # Path Solution
  @solution = {account_sid: , sid: sid, }
  @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:sid]}.json"

  # Dependents
  @recordings = nil
  @notifications = nil
  @feedback = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the CallInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



403
404
405
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 403

def delete
  @version.delete('delete', @uri)
end

#feedback ⇒ FeedbackList, FeedbackContext

Access the feedback

Returns:



519
520
521
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 519

def feedback
  FeedbackContext.new(@version, @solution[:account_sid], @solution[:sid], )
end

#fetch ⇒ CallInstance

Fetch a CallInstance

Returns:



410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 410

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  CallInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
end

#notifications(sid = :unset) ⇒ NotificationList, NotificationContext

Access the notifications

Returns:

Raises:

  • (ArgumentError) 


497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 497

def notifications(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return NotificationContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
  end

  unless @notifications
    @notifications = NotificationList.new(
        @version,
        account_sid: @solution[:account_sid],
        call_sid: @solution[:sid],
    )
  end

  @notifications
end

#recordings(sid = :unset) ⇒ RecordingList, RecordingContext

Access the recordings

Returns:

Raises:

  • (ArgumentError) 


475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 475

def recordings(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return RecordingContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
  end

  unless @recordings
    @recordings = RecordingList.new(
        @version,
        account_sid: @solution[:account_sid],
        call_sid: @solution[:sid],
    )
  end

  @recordings
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.CallContext #{context}>"
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) —

    that hosts instructions for the call. Twilio will consult this URL when the call connects. 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) for more details.

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

    The HTTP method Twilio should use when making its request to the ‘Url` parameter’s value. Defaults to ‘POST`. If an `ApplicationSid` parameter is present, this parameter is ignored.

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

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

    A URL that Twilio will request if an error occurs when requesting or executing the TwiML at ‘Url`. If an `ApplicationSid` parameter is present, this parameter is ignored.

  • 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`. If an `ApplicationSid` parameter is present, this parameter is ignored.

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

    A URL that Twilio will send asynchronous webhook requests to on every call event specified in the ‘StatusCallbackEvent` parameter. If no event is specified, Twilio will send `completed` by default. If an `ApplicationSid` 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 Twilio should use when requesting the ‘StatusCallback` URL. Defaults to `POST`. If an `ApplicationSid` parameter is present, this parameter is ignored.

Returns:



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 451

def update(url: :unset, method: :unset, status: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, status_callback_method: :unset)
  data = Twilio::Values.of({
      'Url' => url,
      'Method' => method,
      'Status' => status,
      'FallbackUrl' => fallback_url,
      'FallbackMethod' => fallback_method,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  CallInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
end