Class: Bandwidth::Recording

Inherits:
Object
  • Object
show all
Extended by:
ClientWrapper
Includes:
ApiItem
Defined in:
lib/bandwidth/recording.rb

Overview

Retrieve call recordings,

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ClientWrapper

wrap_client_arg

Methods included from ApiItem

#[], #[]=, #initialize, #to_data

Class Method Details

.get(client, id) ⇒ Hash

Retrieve a specific call recording information, identified by recordingId

Examples:

recording = Recording.get(client, "id")

Parameters:

  • client (Client)

    optional client instance to make requests

  • id (String)

    id of recording

Returns:

  • (Hash)

    recording information



15
16
17
18
# File 'lib/bandwidth/recording.rb', line 15

def self.get(client, id)
  item = client.make_request(:get, client.concat_user_path("#{RECORDING_PATH}/#{id}"))[0]
  Recording.new(item, client)
end

.list(client, query = nil) ⇒ Array

List a user's call recordings

Examples:

recordings = Recording.list(client)

Parameters:

  • client (Client)

    optional client instance to make requests

  • query (Hash) (defaults to: nil)

    query options

Returns:

  • (Array)

    list of recordings



27
28
29
30
31
# File 'lib/bandwidth/recording.rb', line 27

def self.list(client, query = nil)
  client.make_request(:get, client.concat_user_path(RECORDING_PATH), query)[0].map do |item|
    Recording.new(item, client)
  end
end

Instance Method Details

#create_transcriptionHash

Request the transcription process to be started for the given recording id.

Examples:

transcription = recording.create_transcription()

Returns:

  • (Hash)

    created transcription



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

def create_transcription()
  headers = @client.make_request(:post, @client.concat_user_path("#{RECORDING_PATH}/#{id}/transcriptions"), {})[1]
  id = Client.get_id_from_location_header(headers[:location])
  get_transcription(id)
end

#get_transcription(transcription_id) ⇒ Hash

Gets information about a transcription

Examples:

transcription  = recording.get_transcription("id")

Parameters:

  • transcription_id (String)

    id of transcription

Returns:

  • (Hash)

    event data



49
50
51
# File 'lib/bandwidth/recording.rb', line 49

def get_transcription(transcription_id)
  @client.make_request(:get, @client.concat_user_path("#{RECORDING_PATH}/#{id}/transcriptions/#{transcription_id}"))[0]
end

#get_transcriptionsArray

Gets the list of transcriptions for a recording

Examples:

transcriptions = recording.get_transcriptions()

Returns:

  • (Array)

    list of events



57
58
59
# File 'lib/bandwidth/recording.rb', line 57

def get_transcriptions()
  @client.make_request(:get, @client.concat_user_path("#{RECORDING_PATH}/#{id}/transcriptions"))[0]
end