Class: Plivo::Resources::Conference

Inherits:
Base::Resource show all
Defined in:
lib/plivo/resources/conferences.rb

Constant Summary

Constants included from Utils

Utils::TYPE_WHITELIST

Instance Attribute Summary

Attributes inherited from Base::Resource

#id

Instance Method Summary collapse

Methods included from Utils

expected_type?, expected_value?, raise_invalid_request, valid_account?, valid_mainaccount?, valid_param?, valid_signature?, valid_subaccount?

Constructor Details

#initialize(client, options = nil) ⇒ Conference

Returns a new instance of Conference.



5
6
7
8
9
 
# File 'lib/plivo/resources/conferences.rb', line 5

def initialize(client, options = nil)
  @_name = 'Conference'
  @_identifier_string = 'conference_name'
  super
end

Instance Method Details

#deaf_member(member_id) ⇒ Object

Parameters:

  • member_id (Array) 


114
115
116
117
118
119
120
121
 
# File 'lib/plivo/resources/conferences.rb', line 114

def deaf_member(member_id)
  valid_param?(:member_id, member_id, Array, true)
  member_id.each do |member|
    valid_param?(:member, member, [String, Symbol, Integer, Integer], true)
  end
  perform_action('Member/' + member_id.join(',') + '/Deaf',
                 'POST', nil, true)
end

#delete ⇒ Object 



11
12
13
 
# File 'lib/plivo/resources/conferences.rb', line 11

def delete
  perform_delete
end

#delete_member(member_id) ⇒ Object

Parameters:

  • member_id (String) 


16
17
18
19
 
# File 'lib/plivo/resources/conferences.rb', line 16

def delete_member(member_id)
  valid_param?(:member_id, member_id, [String, Symbol, Integer, Integer], true)
  perform_action('Member/' + member_id.to_s, 'DELETE', nil, true)
end

#kick_member(member_id) ⇒ Object

Parameters:

  • member_id (String) 


22
23
24
25
 
# File 'lib/plivo/resources/conferences.rb', line 22

def kick_member(member_id)
  valid_param?(:member_id, member_id, [String, Symbol, Integer, Integer], true)
  perform_action('Member/' + member_id.to_s + '/Kick', 'POST', nil, true)
end

#mute_member(member_id) ⇒ Object

Parameters:

  • member_id (Array) 


28
29
30
31
32
33
34
35
 
# File 'lib/plivo/resources/conferences.rb', line 28

def mute_member(member_id)
  valid_param?(:member_id, member_id, Array, true)
  member_id.each do |member|
    valid_param?(:member, member, [String, Symbol, Integer, Integer], true)
  end
  perform_action('Member/' + member_id.join(',') + '/Mute',
                 'POST', nil, true)
end

#play_member(member_id, url) ⇒ Object

Parameters:

  • member_id (Array)
  • url (String) 


48
49
50
51
52
53
54
55
56
 
# File 'lib/plivo/resources/conferences.rb', line 48

def play_member(member_id, url)
  valid_param?(:member_id, member_id, Array, true)
  valid_param?(:url, url, String, true)
  member_id.each do |member|
    valid_param?(:member, member, [String, Symbol, Integer, Integer], true)
  end
  perform_action('Member/' + member_id.join(',') + '/Play',
                 'POST', { url: url }, true)
end

#record(options = nil) ⇒ Object

Parameters:

  • options (Hash) (defaults to: nil)

Options Hash (options):

  • :file_format (String) —

    The file format of the record can be of mp3 or wav format. Defaults to mp3 format.

  • :transcription_type (String) —

    The type of transcription required. The following values are allowed:

    • auto - This is the default value. Transcription is completely automated; turnaround time is about 5 minutes.

    • hybrid - Transcription is a combination of automated and human verification processes; turnaround time is about 10-15 minutes.

  • :transcription_url (String) —

    The URL where the transcription is available.

  • :transcription_method (String) —

    The method used to invoke the transcription_url. Defaults to POST.

  • :callback_url (String) —

    The URL invoked by the API when the recording ends. The following parameters are sent to the callback_url:

    • api_id - the same API ID returned by the conference record API.

    • record_url - the URL to access the recorded file.

    • recording_id - recording ID of the recorded file.

    • conference_name - the conference name recorded.

    • recording_duration - duration in seconds of the recording.

    • recording_duration_ms - duration in milliseconds of the recording.

    • recording_start_ms - when the recording started (epoch time UTC) in milliseconds.

    • recording_end_ms - when the recording ended (epoch time UTC) in milliseconds.

  • :callback_method (String) —

    The method which is used to invoke the callback_url URL. Defaults to POST.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/plivo/resources/conferences.rb', line 150

def record(options = nil)
  return perform_action('Record', 'POST', nil, true) if options.nil?
  valid_param?(:options, options, Hash, true)

  params = {}
  %i[transcription_url callback_url].each do |param|
    if options.key?(param) &&
       valid_param?(param, options[param], [String, Symbol], true)
      params[param] = options[param]
    end
  end

  %i[transcription_method callback_method].each do |param|
    if options.key?(param) &&
       valid_param?(param, options[param], [String, Symbol], true, %w[GET POST])
      params[param] = options[param]
    end
  end

  if options.key?(:file_format) &&
     valid_param?(:file_format, options[:file_format],
                  [String, Symbol], true, %w[wav mp3])
    params[:file_format] = options[:file_format]
  end

  if options.key?(:transcription_type) &&
     valid_param?(:transcription_type, options[:transcription_type],
                  [String, Symbol], true, %w[auto hybrid])
    params[:transcription_type] = options[:transcription_type]
  end

  perform_action('Record', 'POST', params, true)
end

#speak_member(member_id, text, options = nil) ⇒ Object

Parameters:

  • member_id (Array)
  • text (String) —

    • The text that the member must hear.

  • options (Hash) (defaults to: nil)

Options Hash (options):



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/plivo/resources/conferences.rb', line 73

def speak_member(member_id, text, options = nil)
  valid_param?(:member_id, member_id, Array, true)
  valid_param?(:text, text, String, true)
  member_id.each do |member|
    valid_param?(:member, member, [String, Symbol, Integer, Integer], true)
  end

  params = { text: text }

  if options.nil?
    return perform_action('Member/' + member_id.join(',') + '/Speak',
                          'POST', params, true)
  end

  if options.key?(:voice) &&
     valid_param?(:voice, options[:voice],
                  [String, Symbol], true, %w[MAN WOMAN])
    params[:voice] = options[:voice]
  end

  if options.key?(:language) &&
     valid_param?(:language, options[:language],
                  String, true)
    params[:language] = options[:language]
  end

  perform_action('Member/' + member_id.join(',') + '/Speak',
                 'POST', params, true)
end

#stop_play_member(member_id) ⇒ Object

Parameters:

  • member_id (Array) 


59
60
61
62
63
64
65
66
 
# File 'lib/plivo/resources/conferences.rb', line 59

def stop_play_member(member_id)
  valid_param?(:member_id, member_id, Array, true)
  member_id.each do |member|
    valid_param?(:member, member, [String, Symbol, Integer, Integer], true)
  end
  perform_action('Member/' + member_id.join(',') + '/Play',
                 'DELETE', nil, true)
end

#stop_record ⇒ Object 



184
185
186
 
# File 'lib/plivo/resources/conferences.rb', line 184

def stop_record
  perform_action('Record', 'DELETE')
end

#stop_speak_member(member_id) ⇒ Object

Parameters:

  • member_id (Array) 


104
105
106
107
108
109
110
111
 
# File 'lib/plivo/resources/conferences.rb', line 104

def stop_speak_member(member_id)
  valid_param?(:member_id, member_id, Array, true)
  member_id.each do |member|
    valid_param?(:member, member, [String, Symbol, Integer, Integer], true)
  end
  perform_action('Member/' + member_id.join(',') + '/Speak',
                 'DELETE', nil, true)
end

#to_json_member(member) ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/plivo/resources/conferences.rb', line 203

def to_json_member(member)
  {
    muted: member['muted'],
    member_id: member['member_id'],
    deaf: member['deaf'],
    from: member['from'],
    to: member['to'],
    caller_name: member['caller_name'],
    direction: member['direction'],
    call_uuid: member['call_uuid'],
    join_time: member['join_time']
  }.to_json
end

#to_s ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/plivo/resources/conferences.rb', line 188

def to_s
  unless @members.nil?
    members_json = @members.map do |member|
      JSON.parse(to_json_member(member))
    end
  end
  {
    conference_name: @conference_name,
    conference_run_time: @conference_run_time,
    conference_member_count: @conference_member_count,
    members: members_json,
    api_id: @api_id
  }.to_s
end

#undeaf_member(member_id) ⇒ Object

Parameters:

  • member_id (Array) 


124
125
126
127
128
129
130
131
 
# File 'lib/plivo/resources/conferences.rb', line 124

def undeaf_member(member_id)
  valid_param?(:member_id, member_id, Array, true)
  member_id.each do |member|
    valid_param?(:member, member, [String, Symbol, Integer, Integer], true)
  end
  perform_action('Member/' + member_id.join(',') + '/Deaf',
                 'DELETE', nil, true)
end

#unmute_member(member_id) ⇒ Object

Parameters:

  • member_id (Array) 


38
39
40
41
42
43
44
 
# File 'lib/plivo/resources/conferences.rb', line 38

def unmute_member(member_id)
  valid_param?(:member_id, member_id, Array, true)
  member_id.each do |member|
    valid_param?(:member, member, [String, Symbol, Integer, Integer], true)
  end
  perform_action('Member/' + member_id.join(',') + '/Mute', 'DELETE')
end