Class: Telapi::Recording

Inherits:
Resource
  • Object
show all
Defined in:
lib/telapi/recording.rb

Overview

Wraps TelAPI Recording functionality

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

#attributes, #initialize

Methods included from Network

api_uri, default_options, delete, post, response_format

Constructor Details

This class inherits a constructor from Telapi::Resource

Class Method Details

.get(id) ⇒ Object

Returns a Telapi::Recording object given its id See www.telapi.com/docs/api/rest/recordings/view/



23
24
25
26
 
# File 'lib/telapi/recording.rb', line 23

def get(id)
  response = Network.get(['Recordings', id])
  Recording.new(response)
end

.list(optional_params = {}) ⇒ Object

Returns a resource collection containing Telapi::Recording objects See www.telapi.com/docs/api/rest/recordings/list/

Also, recordings can be scoped to a call, see Telapi::Call::recordings

Optional params is a hash containing:

CallSid

Show recordings made during a particular call

DateCreated

date in the following format: YYYY-MM-DD

Page

integer greater than 0

PageSize

integer greater than 0



16
17
18
19
 
# File 'lib/telapi/recording.rb', line 16

def list(optional_params = {})
  response = Network.get(['Recordings'], optional_params)
  ResourceCollection.new(response, 'recordings', self)
end

.transcribe(id, optional_params = {}) ⇒ Object

Transcribes a recording and returns a Telapi::Transcription object See www.telapi.com/docs/api/rest/transcriptions/transcribe-recording/

Required params:

id

recording id

Optional params is a hash containing:

TranscribeCallback

valid URL

CallbackMethod

(POST) or GET

Quality

(auto), silver, gold, or platinum



38
39
40
41
 
# File 'lib/telapi/recording.rb', line 38

def transcribe(id, optional_params = {})
  response = Network.post(['Recordings', id, 'Transcriptions'], optional_params)
  Transcription.new(response)
end

.transcriptions(id, optional_params = {}) ⇒ Object

Returns a resource collection containing Telapi::Transcription objects See www.telapi.com/docs/api/rest/transcriptions/list/

Required params:

id

recording id

Optional params is a hash containing:

Page

integer greater than 0

PageSize

integer greater than 0



52
53
54
55
 
# File 'lib/telapi/recording.rb', line 52

def transcriptions(id, optional_params = {})
  response = Network.get(['Recordings', id, 'Transcriptions'], optional_params)
  ResourceCollection.new(response, 'transcriptions', Transcription)
end

Instance Method Details

#transcribe(optional_params = {}) ⇒ Object

See ::transcribe



60
61
62
 
# File 'lib/telapi/recording.rb', line 60

def transcribe(optional_params = {})
  self.class.transcribe(self.sid, optional_params)
end

#transcriptions(optional_params = {}) ⇒ Object

See ::transcriptions



65
66
67
 
# File 'lib/telapi/recording.rb', line 65

def transcriptions(optional_params = {})
  self.class.transcriptions(self.sid, optional_params)
end