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/event.rb,
lib/twilio-ruby/rest/api/v2010/account/call/siprec.rb,
lib/twilio-ruby/rest/api/v2010/account/call/stream.rb,
lib/twilio-ruby/rest/api/v2010/account/call/payment.rb,
lib/twilio-ruby/rest/api/v2010/account/call/recording.rb,
lib/twilio-ruby/rest/api/v2010/account/call/notification.rb,
lib/twilio-ruby/rest/api/v2010/account/call/transcription.rb,
lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message.rb,
lib/twilio-ruby/rest/api/v2010/account/call/user_defined_message_subscription.rb

Defined Under Namespace

Classes: EventInstance, EventList, EventPage, NotificationContext, NotificationInstance, NotificationList, NotificationPage, PaymentContext, PaymentInstance, PaymentList, PaymentPage, RecordingContext, RecordingInstance, RecordingList, RecordingPage, SiprecContext, SiprecInstance, SiprecList, SiprecPage, StreamContext, StreamInstance, StreamList, StreamPage, TranscriptionContext, TranscriptionInstance, TranscriptionList, TranscriptionPage, UserDefinedMessageInstance, UserDefinedMessageList, UserDefinedMessagePage, UserDefinedMessageSubscriptionContext, UserDefinedMessageSubscriptionInstance, UserDefinedMessageSubscriptionList, UserDefinedMessageSubscriptionPage

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 SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Call resource(s) to update.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Call resource to update



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 327

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

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

    # Dependents
    @events = nil
    @user_defined_messages = nil
    @transcriptions = nil
    @siprec = nil
    @user_defined_message_subscriptions = nil
    @payments = nil
    @recordings = nil
    @notifications = nil
    @streams = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the CallInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



348
349
350
351
352
353
354
355
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 348

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    @version.delete('DELETE', @uri, headers: headers)
end

#events ⇒ EventList, EventContext

Access the events

Returns:



432
433
434
435
436
437
438
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 432

def events
  unless @events
    @events = EventList.new(
            @version, account_sid: @solution[:account_sid], call_sid: @solution[:sid], )
  end
  @events
end

#fetch ⇒ CallInstance

Fetch the CallInstance

Returns:



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 360

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    CallInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



593
594
595
596
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 593

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.CallContext #{context}>"
end

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

Access the notifications

Returns:

Raises:

  • (ArgumentError) 


549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 549

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

#payments(sid = :unset) ⇒ PaymentList, PaymentContext

Access the payments

Returns:

Raises:

  • (ArgumentError) 


511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 511

def payments(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

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

 @payments
end

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

Access the recordings

Returns:

Raises:

  • (ArgumentError) 


530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 530

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

#siprec(sid = :unset) ⇒ SiprecList, SiprecContext

Access the siprec

Returns:

Raises:

  • (ArgumentError) 


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

def siprec(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

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

 @siprec
end

#streams(sid = :unset) ⇒ StreamList, StreamContext

Access the streams

Returns:

Raises:

  • (ArgumentError) 


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 568

def streams(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

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

 @streams
end

#to_s ⇒ Object

Provide a user friendly representation



586
587
588
589
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 586

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.CallContext #{context}>"
end

#transcriptions(sid = :unset) ⇒ TranscriptionList, TranscriptionContext

Access the transcriptions

Returns:

Raises:

  • (ArgumentError) 


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

def transcriptions(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

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

 @transcriptions
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:



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 389

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
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    CallInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
end

#user_defined_message_subscriptions(sid = :unset) ⇒ UserDefinedMessageSubscriptionList, UserDefinedMessageSubscriptionContext

Access the user_defined_message_subscriptions

Returns:

Raises:

  • (ArgumentError) 


492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 492

def user_defined_message_subscriptions(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

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

 @user_defined_message_subscriptions
end

#user_defined_messages ⇒ UserDefinedMessageList, UserDefinedMessageContext

Access the user_defined_messages

Returns:



443
444
445
446
447
448
449
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call.rb', line 443

def user_defined_messages
  unless @user_defined_messages
    @user_defined_messages = UserDefinedMessageList.new(
            @version, account_sid: @solution[:account_sid], call_sid: @solution[:sid], )
  end
  @user_defined_messages
end