Class: Plivo::Resources::CallInterface
- Inherits:
-
Base::ResourceInterface
- Object
- Base::ResourceInterface
- Plivo::Resources::CallInterface
- Defined in:
- lib/plivo/resources/calls.rb
Constant Summary
Constants included from Utils
Instance Method Summary collapse
- #cancel_request(call_uuid) ⇒ Object
-
#create(from, to, answer_url, options = nil) ⇒ Call
Makes an outbound call.
- #delete(call_uuid) ⇒ Object
- #each ⇒ Object
- #each_live ⇒ Object
- #each_queued ⇒ Object
-
#get(call_uuid) ⇒ Object
Get details of a call.
- #get_live(call_uuid) ⇒ Object
- #get_queued(call_uuid) ⇒ Object
-
#initialize(client, resource_list_json = nil) ⇒ CallInterface
constructor
A new instance of CallInterface.
- #list(options = nil) ⇒ Object
- #list_live(options = nil) ⇒ Object
- #list_queued ⇒ Object
- #play(call_uuid, urls, options = nil) ⇒ Object
- #record(call_uuid, options = nil) ⇒ Object
- #send_digits(call_uuid, digits, leg = nil) ⇒ Object
- #speak(call_uuid, text, options = nil) ⇒ Object
- #stop_play(call_uuid) ⇒ Object
- #stop_record(call_uuid, url = nil) ⇒ Object
- #stop_speak(call_uuid) ⇒ Object
-
#update(call_uuid, details) ⇒ Call
Transfer a call.
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) ⇒ CallInterface
Returns a new instance of CallInterface.
243 244 245 246 247 248 249 |
# File 'lib/plivo/resources/calls.rb', line 243 def initialize(client, resource_list_json = nil) @_name = 'Call' @_resource_type = Call @_identifier_string = 'call_uuid' super @_is_voice_request = true end |
Instance Method Details
#cancel_request(call_uuid) ⇒ Object
574 575 576 577 |
# File 'lib/plivo/resources/calls.rb', line 574 def cancel_request(call_uuid) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) Call.new(@_client, resource_id: call_uuid).cancel_request end |
#create(from, to, answer_url, options = nil) ⇒ Call
Makes an outbound call
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 |
# File 'lib/plivo/resources/calls.rb', line 279 def create(from, to, answer_url, = nil) valid_param?(:from, from, [String, Symbol, Integer], true) valid_param?(:to, to, Array, true) to.each do |to_num| valid_param?(:to_num, to_num, [Integer, String, Symbol], true) end valid_param?(:answer_url, answer_url, [String, Symbol], true) params = { from: from, to: to.join('<'), answer_url: answer_url, } return perform_create(params, false) if .nil? perform_create(params.merge(), false) end |
#delete(call_uuid) ⇒ Object
485 486 487 488 |
# File 'lib/plivo/resources/calls.rb', line 485 def delete(call_uuid) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) Call.new(@_client, resource_id: call_uuid).delete end |
#each ⇒ Object
400 401 402 403 404 405 406 407 408 |
# File 'lib/plivo/resources/calls.rb', line 400 def each offset = 0 loop do call_list = list(offset: offset) call_list[:objects].each { |call| yield call } offset += 20 return unless call_list.length == 20 end end |
#each_live ⇒ Object
459 460 461 462 |
# File 'lib/plivo/resources/calls.rb', line 459 def each_live call_list = list_live call_list[:calls].each { |call| yield call } end |
#each_queued ⇒ Object
464 465 466 467 |
# File 'lib/plivo/resources/calls.rb', line 464 def each_queued call_queued = list_queued call_queued[:calls].each { |call| yield call} end |
#get(call_uuid) ⇒ Object
Get details of a call
302 303 304 305 |
# File 'lib/plivo/resources/calls.rb', line 302 def get(call_uuid) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) perform_get(call_uuid) end |
#get_live(call_uuid) ⇒ Object
308 309 310 |
# File 'lib/plivo/resources/calls.rb', line 308 def get_live(call_uuid) perform_get(call_uuid, status: 'live') end |
#get_queued(call_uuid) ⇒ Object
313 314 315 |
# File 'lib/plivo/resources/calls.rb', line 313 def get_queued(call_uuid) perform_get(call_uuid, status: 'queued') end |
#list(options = nil) ⇒ Object
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 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 |
# File 'lib/plivo/resources/calls.rb', line 345 def list( = nil) return perform_list if .nil? valid_param?(:options, , Hash, true) raise_invalid_request("Offset can't be negative") if .key?(:offset) && [:offset] < 0 if .key?(:limit) && ([:limit] > 20 || [:limit] <= 0) raise_invalid_request('The maximum number of results that can be '\ "fetched is 20. limit can't be more than 20 or less than 1") end # initial list of possible params params = %i[ bill_duration bill_duration__gt bill_duration__gte bill_duration__lt bill_duration__lte call_direction end_time end_time__gt end_time__gte end_time__lt end_time__lte from_number hangup_cause_code hangup_source limit offset parent_call_uuid subaccount to_number stir_verification ].reduce({}) do |result_hash, param| if .key?(param) if param == :call_direction if valid_param?(:call_direction, [:call_direction], [String, Symbol], true, %w[inbound outbound]) result_hash[:call_direction] = [:call_direction] end elsif %i[offset limit hangup_cause_code].include?(param) if valid_param?(param, [param], [Integer, Integer], true) result_hash[param] = [param] end elsif valid_param?(param, [param], [String, Symbol], true) result_hash[param] = [param] end end result_hash end perform_list(params) end |
#list_live(options = nil) ⇒ Object
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 |
# File 'lib/plivo/resources/calls.rb', line 418 def list_live( = nil) if .nil? = {} else valid_param?(:options, , Hash, true) end params = {} params[:status] = 'live' params_expected = %i[ from_number to_number ] params_expected.each do |param| if .key?(param) && valid_param?(param, [param], [String, Symbol], true) params[param] = [param] end end if .key?(:call_direction) && valid_param?(:call_direction, [:call_direction], [String, Symbol], true, %w[inbound outbound]) params[:call_direction] = [:call_direction] end perform_list_without_object(params) { api_id: @api_id, calls: @calls } end |
#list_queued ⇒ Object
451 452 453 454 455 456 457 |
# File 'lib/plivo/resources/calls.rb', line 451 def list_queued perform_list_without_object(status: 'queued') { api_id: @api_id, calls: @calls } end |
#play(call_uuid, urls, options = nil) ⇒ Object
534 535 536 537 538 |
# File 'lib/plivo/resources/calls.rb', line 534 def play(call_uuid, urls, = nil) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) valid_param?(:urls, urls, Array, true) Call.new(@_client, resource_id: call_uuid).play(urls, ) end |
#record(call_uuid, options = nil) ⇒ Object
510 511 512 513 514 515 516 517 |
# File 'lib/plivo/resources/calls.rb', line 510 def record(call_uuid, = nil) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) response = Call.new(@_client, resource_id: call_uuid).record() return Base::Response.new(Hash["api_id" => response.api_id, "recording_id" => response.recording_id, "message" => response., "url" => response.url]) end |
#send_digits(call_uuid, digits, leg = nil) ⇒ Object
568 569 570 571 |
# File 'lib/plivo/resources/calls.rb', line 568 def send_digits(call_uuid, digits, leg = nil) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) Call.new(@_client, resource_id: call_uuid).send_digits(digits, leg) end |
#speak(call_uuid, text, options = nil) ⇒ Object
554 555 556 557 |
# File 'lib/plivo/resources/calls.rb', line 554 def speak(call_uuid, text, = nil) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) Call.new(@_client, resource_id: call_uuid).speak(text, ) end |
#stop_play(call_uuid) ⇒ Object
541 542 543 544 |
# File 'lib/plivo/resources/calls.rb', line 541 def stop_play(call_uuid) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) Call.new(@_client, resource_id: call_uuid).stop_play end |
#stop_record(call_uuid, url = nil) ⇒ Object
521 522 523 524 |
# File 'lib/plivo/resources/calls.rb', line 521 def stop_record(call_uuid, url = nil) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) Call.new(@_client, resource_id: call_uuid).stop_record(url) end |
#stop_speak(call_uuid) ⇒ Object
560 561 562 563 |
# File 'lib/plivo/resources/calls.rb', line 560 def stop_speak(call_uuid) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) Call.new(@_client, resource_id: call_uuid).stop_speak end |