Class: Plivo::Resources::MultiPartyCallInterface

Inherits:
Base::ResourceInterface show all
Defined in:
lib/plivo/resources/multipartycalls.rb

Constant Summary

Constants included from Utils

Utils::TYPE_WHITELIST

Instance Method Summary collapse

Methods included from Utils

GetSortedQueryParamString?, compute_signatureV3?, expected_type?, expected_value?, generate_url?, getMapFromQueryString?, is_one_among_string_url?, multi_valid_param?, raise_invalid_request, valid_account?, valid_date_format?, valid_mainaccount?, valid_multiple_destination_integers?, valid_multiple_destination_nos?, valid_param?, valid_range?, valid_signature?, valid_signatureV3?, valid_subaccount?, valid_url?

Constructor Details

#initialize(client, resource_list_json = nil) ⇒ MultiPartyCallInterface

Returns a new instance of MultiPartyCallInterface.



315
316
317
318
319
320
321
 
# File 'lib/plivo/resources/multipartycalls.rb', line 315

def initialize(client, resource_list_json = nil)
  @_name = 'MultiPartyCall'
  @_resource_type = MultiPartyCall
  @_identifier_string = 'mpc_uuid'
  super
  @_is_voice_request = true
end

Instance Method Details

#add_participant(options = {}) ⇒ Object 



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/plivo/resources/multipartycalls.rb', line 365

def add_participant(options = {})
  valid_param?(:options, options, Hash, false)
  if not options[:role ]
    raise_invalid_request("Role is mandatory")
  end
  options[:call_status_callback_method] = 'POST' unless options.key?(:call_status_callback_method)
  options[:confirm_key_sound_method] = 'GET' unless options.key?(:confirm_key_sound_method)
  options[:dial_music] = 'Real' unless options.key?(:dial_music)
  options[:ring_timeout] = 45 unless options.key?(:ring_timeout) 
  options[:delay_dial] = 0 unless options.key?(:delay_dial)
  options[:max_duration] = 14400 unless options.key?(:max_duration)
  options[:max_participants] = 10 unless options.key?(:max_participants)
  options[:wait_music_method] = 'GET' unless options.key?(:wait_music_method)
  options[:agent_hold_music_method] = 'GET' unless options.key?(:agent_hold_music_method)
  options[:customer_hold_music_method] = 'GET' unless options.key?(:customer_hold_music_method)
  options[:recording_callback_method] ='GET' unless options.key?(:recording_callback_method)
  options[:status_callback_method] = 'GET' unless options.key?(:status_callback_method)
  options[:on_exit_action_method] = 'POST' unless options.key?(:on_exit_action_method)
  options[:record] = false  unless options.key?(:record)
  options[:record_file_format] = 'mp3' unless options.key?(:record_file_format)
  options[:status_callback_events] = 'mpc-state-changes,participant-state-changes' unless options.key?(:status_callback_events)
  options[:stay_alone] = false unless options.key?(:stay_alone)
  options[:coach_mode] = true unless options.key?(:coach_mode)
  options[:mute] = false unless options.key?(:mute)
  options[:hold] = false unless options.key?(:hold)
  options[:start_mpc_on_enter] = true unless options.key?(:start_mpc_on_enter)
  options[:end_mpc_on_exit] = false unless options.key?(:end_mpc_on_exit)
  options[:relay_dtmf_inputs] = false unless options.key?(:relay_dtmf_inputs)
  options[:enter_sound] = 'beep:1' unless options.key?(:enter_sound)
  options[:enter_sound_method] = 'GET' unless options.key?(:enter_sound_method)
  options[:exit_sound] = 'beep:2' unless options.key?(:exit_sound)
  options[:exit_sound_method] = 'GET' unless options.key?(:exit_sound_method)
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])

  MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).add_participant(options[:role],options[:from],options[:to],options[:call_uuid],options[:caller_name],options[:call_status_callback_url],options[:call_status_callback_method],options[:sip_headers],options[:confirm_key],
                                                                    options[:confirm_key_sound_url],options[:confirm_key_sound_method],options[:dial_music],options[:ring_timeout],options[:delay_dial],options[:max_duration], options[:max_participants],options[:wait_music_url],
                                                                    options[:wait_music_method],options[:agent_hold_music_url],options[:agent_hold_music_method],options[:customer_hold_music_url],options[:customer_hold_music_method],
                                                                    options[:recording_callback_url],options[:recording_callback_method],options[:status_callback_url],options[:status_callback_method],options[:on_exit_action_url], options[:on_exit_action_method],
                                                                    options[:record],options[:record_file_format],options[:status_callback_events],options[:stay_alone], options[:coach_mode],options[:mute],options[:hold],options[:start_mpc_on_enter],options[:end_mpc_on_exit],
                                                                    options[:relay_dtmf_inputs],options[:enter_sound],options[:enter_sound_method],options[:exit_sound],options[:exit_sound_method])
end

#get(options = {}) ⇒ Object 



357
358
359
360
361
362
363
 
# File 'lib/plivo/resources/multipartycalls.rb', line 357

def get(options = {})
  valid_param?(:options, options, Hash, false)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).get
end

#get_participant(options = {}) ⇒ Object 



541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/plivo/resources/multipartycalls.rb', line 541

def get_participant(options = {})
  valid_param?(:options, options, Hash, false)
  if not options[:member_id]
    raise_invalid_request("Member Id is mandatory")
  end
  valid_param?(:member_id, options[:member_id], [String, Integer], true)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).get_participant
end

#kick_participant(options = {}) ⇒ Object 



529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/plivo/resources/multipartycalls.rb', line 529

def kick_participant(options = {})
  valid_param?(:options, options, Hash, false)
  if not options[:member_id]
    raise_invalid_request("Member Id is mandatory")
  end
  valid_param?(:member_id, options[:member_id], [String, Integer], true)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).kick_participant
end

#list(options = {}) ⇒ Object 



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/plivo/resources/multipartycalls.rb', line 338

def list(options={})
  valid_param?(:options, options, Hash, false)
  valid_subaccount?(options[:sub_account], true) unless options[:sub_account].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  valid_param?(:status, options[:status].downcase, String, false, %w[initialized active ended]) unless options[:status].nil?
  valid_param?(:termination_cause_code, options[:termination_cause_code], Integer, false) unless options[:termination_cause_code].nil?
  valid_date_format?(:end_time__gt, options[:end_time__gt], false ) unless options[:end_time__gt].nil?
  valid_date_format?(:end_time__gte, options[:end_time__gte], false ) unless options[:end_time__gte].nil?
  valid_date_format?(:end_time__lt, options[:end_time__lt], String) unless options[:end_time__lt].nil?
  valid_date_format?(:end_time__lte, options[:end_time__lte], false) unless options[:end_time__lte].nil?
  valid_date_format?(:creation_time__gt, options[:creation_time__gt], false) unless options[:creation_time__gt].nil?
  valid_date_format?(:creation_time__gte, options[:creation_time__gte], false) unless options[:creation_time__gte].nil?
  valid_date_format?(:creation_time__lt, options[:creation_time__lt], false) unless options[:creation_time__lt].nil?
  valid_date_format?(:creation_time__lte, options[:creation_time__lte], false) unless options[:creation_time__lte].nil?
  valid_range?(:limit, options[:limit], false, 1, 20)
  valid_range?(:offset, options[:offset], false, 0)
  perform_action(nil ,'GET', options ,true )
end

#list_participants(options = {}) ⇒ Object 



509
510
511
512
513
514
515
 
# File 'lib/plivo/resources/multipartycalls.rb', line 509

def list_participants(options = {})
  valid_param?(:options, options, Hash, false)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).list_participants(options[:call_uuid])
end

#make_mpc_id(uuid = nil, friendly_name = nil) ⇒ Object 



323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/plivo/resources/multipartycalls.rb', line 323

def make_mpc_id(uuid=nil, friendly_name=nil)
  if not uuid and not friendly_name
    raise_invalid_request('specify either multi party call friendly name or uuid')
  end
  if uuid and friendly_name
    raise_invalid_request('cannot specify both multi party call friendly name or uuid')
  end
  if uuid
    identifier =  ['uuid', uuid]
  else
    identifier = ['name', friendly_name]
  end
  return identifier
end

#pause_participant_recording(options = {}) ⇒ Object 



485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/plivo/resources/multipartycalls.rb', line 485

def pause_participant_recording(options = {})
  valid_param?(:options, options, Hash, false)
  if not options[:member_id]
    raise_invalid_request("Member Id is mandatory")
  end
  valid_param?(:member_id, options[:member_id], [String, Integer], true)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).pause_participant_recording
end

#pause_recording(options = {}) ⇒ Object 



443
444
445
446
447
448
449
 
# File 'lib/plivo/resources/multipartycalls.rb', line 443

def pause_recording(options = {})
  valid_param?(:options, options, Hash, false)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).pause_recording
end

#resume_participant_recording(options = {}) ⇒ Object 



497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/plivo/resources/multipartycalls.rb', line 497

def resume_participant_recording(options = {})
  valid_param?(:options, options, Hash, false)
  if not options[:member_id]
    raise_invalid_request("Member Id is mandatory")
  end
  valid_param?(:member_id, options[:member_id], [String, Integer], true)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).resume_participant_recording
end

#resume_recording(options = {}) ⇒ Object 



451
452
453
454
455
456
457
 
# File 'lib/plivo/resources/multipartycalls.rb', line 451

def resume_recording(options = {})
  valid_param?(:options, options, Hash, false)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).resume_recording
end

#start(options = {}) ⇒ Object 



409
410
411
412
413
414
415
 
# File 'lib/plivo/resources/multipartycalls.rb', line 409

def start(options = {})
  valid_param?(:options, options, Hash, false)
  valid_param?(:uuid, options[:uuid], String, false)
  valid_param?(:friendly_name, options[:friendly_name], String, false)
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCall.new(@_client,resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).start
end

#start_participant_recording(options = {}) ⇒ Object 



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/plivo/resources/multipartycalls.rb', line 459

def start_participant_recording(options = {})
  valid_param?(:options, options, Hash, false)
  if not options[:member_id]
    raise_invalid_request("Member Id is mandatory")
  end
  options[:file_format] = 'mp3' unless options.key?(:file_format)
  options[:status_callback_method] = 'POST' unless options.key?(:status_callback_method)
  valid_param?(:member_id, options[:member_id], [String, Integer], true)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).start_participant_recording(options[:file_format], options[:status_callback_url], options[:status_callback_method])
end

#start_recording(options = {}) ⇒ Object 



425
426
427
428
429
430
431
432
433
 
# File 'lib/plivo/resources/multipartycalls.rb', line 425

def start_recording(options = {})
  valid_param?(:options, options, Hash, false)
  options[:file_format] = 'mp3' unless options.key?(:file_format)
  options[:status_callback_method] = 'POST' unless options.key?(:status_callback_method)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).start_recording(options[:file_format], options[:status_callback_url], options[:status_callback_method])
end

#stop(options = {}) ⇒ Object 



417
418
419
420
421
422
423
 
# File 'lib/plivo/resources/multipartycalls.rb', line 417

def stop(options = {})
  valid_param?(:options, options, Hash, false)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).stop
end

#stop_participant_recording(options = {}) ⇒ Object 



473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/plivo/resources/multipartycalls.rb', line 473

def stop_participant_recording(options = {})
  valid_param?(:options, options, Hash, false)
  if not options[:member_id]
    raise_invalid_request("Member Id is mandatory")
  end
  valid_param?(:member_id, options[:member_id], [String, Integer], true)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).stop_participant_recording
end

#stop_recording(options = {}) ⇒ Object 



435
436
437
438
439
440
441
 
# File 'lib/plivo/resources/multipartycalls.rb', line 435

def stop_recording(options = {})
  valid_param?(:options, options, Hash, false)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).stop_recording
end

#update_participant(options = {}) ⇒ Object 



517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/plivo/resources/multipartycalls.rb', line 517

def update_participant(options =  {})
  valid_param?(:options, options, Hash, false)
  if not options[:member_id]
    raise_invalid_request("Member Id is mandatory")
  end
  valid_param?(:member_id, options[:member_id], [String, Integer], true)
  valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
  valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
  mpc_id = self.make_mpc_id(options[:uuid], options[:friendly_name])
  MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).update_participant(options[:coach_mode], options[:mute], options[:hold])
end