Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated using 4PSA automated script
Excerpt

This page contains code snippets that demonstrate various Unified API requests that can be implemented in your App when using the Ruby language.

Table of Contents
maxLevel2

Requirements

Ruby 1.9.3 or higher with SSL support is required.

Note
titleThe code is on GitHub

Download here. Do not hesitate to contribute in order to make this example better - we welcome Pull Requests!

Make a call between two public numbers

Code Block
curl "https://raw.githubusercontent.com/4psa/uapi-example-ruby/master/01_public_call.rb" -o 01_public_call.rb -L

Make a Sandbox call

Code Block
curl "https://raw.githubusercontent.com/4psa/uapi-example-ruby/master/02_sandbox_call.rb" -o 02_sandbox_call.rb -L

Park a phone call

Anchor
demo-ph-park
demo-ph-park

The example below demonstrates how you can use Unified API to park a party of an ongoing phone call. It uses the Park PhoneCalls request.

Code Block
curl "https://raw.githubusercontent.com/4psa/uapi-example-ruby/master/03_park_call.rb" -o 03_park_call.rb -L

Transfer a call to a public number

Anchor
demo-ph-xfer
demo-ph-xfer

The example below demonstrates how you can use Unified API to transfer a call to a public number, not registered with VoipNow. It uses the Transfer PhoneCalls request.

Code Block
curl "https://raw.githubusercontent.com/4psa/uapi-example-ruby/master/04_transfer_call.rb" -o 04_transfer_call.rb -L

Record an ongoing conversation

Anchor
demo-ph-rec
demo-ph-rec

The example below demonstrates how you can use Unified API to record an ongoing conversation. This action is possible for phone numbers that are registered with VoipNow. The recording is saved in the wav format and uses the StartRecording PhoneCalls request.

Code Block
curl "https://raw.githubusercontent.com/4psa/uapi-example-ruby/master/05_record_call.rb" -o 05_record_call.rb -L

Log in an agent to a queue

Anchor
demo-queue-ag
demo-queue-ag

The example below demonstrates how you can use Unified API to log in an agent to a queue. It uses the Update QueueAgents request.

Code Block
curl "https://raw.githubusercontent.com/4psa/uapi-example-ruby/master/06_agent_login.rb" -o 06_agent_login.rb -L

List the registration status of an extension

Anchor
demo-ext-pres
demo-ext-pres

The example below demonstrates how you can use Unified API to list the status of an extension. It uses the List Presence request.

Code Block
curl "https://raw.githubusercontent.com/4psa/uapi-example-ruby/master/07_list_registration.rb" -o 07_list_registration.rb -L

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.