Class: Twilio::REST::Api::V2010::AccountContext::RecordingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/recording.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ RecordingInstance

Initialize the RecordingInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil)

    The SID of the Account that created this Recording resource.

  • sid (String) (defaults to: nil)

    The SID of the Call resource to fetch.



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 302

def initialize(version, payload , account_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'api_version' => payload['api_version'],
        'call_sid' => payload['call_sid'],
        'conference_sid' => payload['conference_sid'],
        'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
        'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
        'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
        'duration' => payload['duration'],
        'sid' => payload['sid'],
        'price' => payload['price'],
        'price_unit' => payload['price_unit'],
        'status' => payload['status'],
        'channels' => payload['channels'] == nil ? payload['channels'] : payload['channels'].to_i,
        'source' => payload['source'],
        'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
        'uri' => payload['uri'],
        'encryption_details' => payload['encryption_details'],
        'subresource_uris' => payload['subresource_uris'],
        'media_url' => payload['media_url'],
    }

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

Instance Method Details

#account_sidString

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Recording resource.

Returns:



346
347
348
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 346

def 
    @properties['account_sid']
end

#add_on_resultsadd_on_results

Access the add_on_results

Returns:



482
483
484
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 482

def add_on_results
    context.add_on_results
end

#api_versionString

Returns The API version used during the recording.

Returns:

  • (String)

    The API version used during the recording.



352
353
354
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 352

def api_version
    @properties['api_version']
end

#call_sidString

Returns The SID of the [Call](www.twilio.com/docs/voice/api/call-resource) the Recording resource is associated with. This will always refer to the parent leg of a two-leg call.

Returns:



358
359
360
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 358

def call_sid
    @properties['call_sid']
end

#channelsString

Returns The number of channels in the final recording file. Can be: ‘1` or `2`. You can split a call with two legs into two separate recording channels if you record using [TwiML Dial](www.twilio.com/docs/voice/twiml/dial#record) or the [Outbound Rest API](www.twilio.com/docs/voice/make-calls#manage-your-outbound-call).

Returns:



418
419
420
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 418

def channels
    @properties['channels']
end

#conference_sidString

Returns The Conference SID that identifies the conference associated with the recording, if a conference recording.

Returns:

  • (String)

    The Conference SID that identifies the conference associated with the recording, if a conference recording.



364
365
366
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 364

def conference_sid
    @properties['conference_sid']
end

#contextRecordingContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



337
338
339
340
341
342
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 337

def context
    unless @instance_context
        @instance_context = RecordingContext.new(@version , @params['account_sid'], @params['sid'])
    end
    @instance_context
end

#date_createdTime

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



370
371
372
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 370

def date_created
    @properties['date_created']
end

#date_updatedTime

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



376
377
378
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 376

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the RecordingInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



461
462
463
464
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 461

def delete

    context.delete
end

#durationString

Returns The length of the recording in seconds.

Returns:

  • (String)

    The length of the recording in seconds.



388
389
390
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 388

def duration
    @properties['duration']
end

#encryption_detailsHash

Returns How to decrypt the recording if it was encrypted using [Call Recording Encryption](www.twilio.com/docs/voice/tutorials/voice-recording-encryption) feature.

Returns:



442
443
444
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 442

def encryption_details
    @properties['encryption_details']
end

#error_codeString

Returns The error code that describes why the recording is ‘absent`. The error code is described in our [Error Dictionary](www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`.

Returns:

  • (String)

    The error code that describes why the recording is ‘absent`. The error code is described in our [Error Dictionary](www.twilio.com/docs/api/errors). This value is null if the recording `status` is not `absent`.



430
431
432
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 430

def error_code
    @properties['error_code']
end

#fetch(include_soft_deleted: :unset) ⇒ RecordingInstance

Fetch the RecordingInstance

Parameters:

  • include_soft_deleted (Boolean) (defaults to: :unset)

    A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.

Returns:



470
471
472
473
474
475
476
477
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 470

def fetch(
    include_soft_deleted: :unset
)

    context.fetch(
        include_soft_deleted: include_soft_deleted, 
    )
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#media_urlString

Returns The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file.

Returns:

  • (String)

    The URL of the media file associated with this recording resource. When stored externally, this is the full URL location of the media file.



454
455
456
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 454

def media_url
    @properties['media_url']
end

#priceString

Returns The one-time cost of creating the recording in the ‘price_unit` currency.

Returns:

  • (String)

    The one-time cost of creating the recording in the ‘price_unit` currency.



400
401
402
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 400

def price
    @properties['price']
end

#price_unitString

Returns The currency used in the ‘price` property. Example: `USD`.

Returns:

  • (String)

    The currency used in the ‘price` property. Example: `USD`.



406
407
408
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 406

def price_unit
    @properties['price_unit']
end

#sidString

Returns The unique string that that we created to identify the Recording resource.

Returns:

  • (String)

    The unique string that that we created to identify the Recording resource.



394
395
396
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 394

def sid
    @properties['sid']
end

#sourceSource

Returns:

  • (Source)


424
425
426
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 424

def source
    @properties['source']
end

#start_timeTime

Returns The start time of the recording in GMT and in [RFC 2822](www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format.

Returns:



382
383
384
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 382

def start_time
    @properties['start_time']
end

#statusStatus

Returns:

  • (Status)


412
413
414
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 412

def status
    @properties['status']
end

#subresource_urisHash

Returns A list of related resources identified by their relative URIs.

Returns:

  • (Hash)

    A list of related resources identified by their relative URIs.



448
449
450
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 448

def subresource_uris
    @properties['subresource_uris']
end

#to_sObject

Provide a user friendly representation



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

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

#transcriptionstranscriptions

Access the transcriptions

Returns:



489
490
491
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 489

def transcriptions
    context.transcriptions
end

#uriString

Returns The URI of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String)

    The URI of the resource, relative to ‘api.twilio.com`.



436
437
438
# File 'lib/twilio-ruby/rest/api/v2010/account/recording.rb', line 436

def uri
    @properties['uri']
end