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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 347

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



366
367
368
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 366

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

#feedback ⇒ FeedbackList, FeedbackContext

Access the feedback

Returns:



492
493
494
495
496
497
498
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 492

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

#fetch ⇒ CallInstance

Fetch a CallInstance

Returns:



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 373

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) 


465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 465

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) 


438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 438

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



502
503
504
505
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 502

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

    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:



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 409

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