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, answer_method = 'POST', 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
expected_type?, expected_value?, raise_invalid_request, valid_account?, valid_mainaccount?, valid_param?, valid_signature?, valid_subaccount?
Constructor Details
#initialize(client, resource_list_json = nil) ⇒ CallInterface
Returns a new instance of CallInterface.
238 239 240 241 242 243 |
# File 'lib/plivo/resources/calls.rb', line 238 def initialize(client, resource_list_json = nil) @_name = 'Call' @_resource_type = Call @_identifier_string = 'call_uuid' super end |
Instance Method Details
#cancel_request(call_uuid) ⇒ Object
551 552 553 554 |
# File 'lib/plivo/resources/calls.rb', line 551 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, answer_method = 'POST', options = nil) ⇒ Call
Makes an outbound call
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/plivo/resources/calls.rb', line 274 def create(from, to, answer_url, answer_method = 'POST', = 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) valid_param?(:answer_method, answer_method, [String, Symbol], true, %w[GET POST]) params = { from: from, to: to.join('<'), answer_url: answer_url, answer_method: answer_method } return perform_create(params) if .nil? perform_create(params.merge()) end |
#delete(call_uuid) ⇒ Object
466 467 468 469 |
# File 'lib/plivo/resources/calls.rb', line 466 def delete(call_uuid) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) Call.new(@_client, resource_id: call_uuid).delete end |
#each ⇒ Object
381 382 383 384 385 386 387 388 389 |
# File 'lib/plivo/resources/calls.rb', line 381 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
440 441 442 443 |
# File 'lib/plivo/resources/calls.rb', line 440 def each_live call_list = list_live call_list[:calls].each { |call| yield call } end |
#each_queued ⇒ Object
445 446 447 448 |
# File 'lib/plivo/resources/calls.rb', line 445 def each_queued call_queued = list_queued call_queued[:calls].each { |call| yield call} end |
#get(call_uuid) ⇒ Object
Get details of a call
299 300 301 302 |
# File 'lib/plivo/resources/calls.rb', line 299 def get(call_uuid) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) perform_get(call_uuid) end |
#get_live(call_uuid) ⇒ Object
305 306 307 |
# File 'lib/plivo/resources/calls.rb', line 305 def get_live(call_uuid) perform_get(call_uuid, status: 'live') end |
#get_queued(call_uuid) ⇒ Object
310 311 312 |
# File 'lib/plivo/resources/calls.rb', line 310 def get_queued(call_uuid) perform_get(call_uuid, status: 'queued') end |
#list(options = nil) ⇒ Object
342 343 344 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 |
# File 'lib/plivo/resources/calls.rb', line 342 def list( = nil) return perform_list if .nil? valid_param?(:options, , Hash, true) params = {} params_expected = %i[ subaccount bill_duration bill_duration__gt bill_duration__gte bill_duration__lt bill_duration__lte end_time end_time__gt end_time__gte end_time__lt end_time__lte parent_call_uuid hangup_source ] 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 %i[offset limit hangup_cause_code].each do |param| if .key?(param) && valid_param?(param, [param], [Integer, Integer], true) params[param] = [param] end end 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 perform_list(params) end |
#list_live(options = nil) ⇒ Object
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
# File 'lib/plivo/resources/calls.rb', line 399 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
432 433 434 435 436 437 438 |
# File 'lib/plivo/resources/calls.rb', line 432 def list_queued perform_list_without_object(status: 'queued') { api_id: @api_id, calls: @calls } end |
#play(call_uuid, urls, options = nil) ⇒ Object
511 512 513 514 515 |
# File 'lib/plivo/resources/calls.rb', line 511 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
491 492 493 494 |
# File 'lib/plivo/resources/calls.rb', line 491 def record(call_uuid, = nil) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) Call.new(@_client, resource_id: call_uuid).record() end |
#send_digits(call_uuid, digits, leg = nil) ⇒ Object
545 546 547 548 |
# File 'lib/plivo/resources/calls.rb', line 545 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
531 532 533 534 |
# File 'lib/plivo/resources/calls.rb', line 531 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
518 519 520 521 |
# File 'lib/plivo/resources/calls.rb', line 518 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
498 499 500 501 |
# File 'lib/plivo/resources/calls.rb', line 498 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
537 538 539 540 |
# File 'lib/plivo/resources/calls.rb', line 537 def stop_speak(call_uuid) valid_param?(:call_uuid, call_uuid, [String, Symbol], true) Call.new(@_client, resource_id: call_uuid).stop_speak end |