Call

All calls in SignalWire have a common generic interface, Call. A call is a connection between SignalWire and another device.

Properties

Methods

answer

Answer an inbound call.

Parameters

None

Returns

Relay::Calling::AnswerResult - The result object to interact with.

Examples

Answer an inbound call and check if it was successful.

1
result = call.answer
2
3
if result.successful
4
  #call was answered
5
end

connect

Attempts to connect an existing call to a new outbound call and waits until one of the remote party picks the call or the connect fails.

You can connect to multiple devices in series, parallel, or any combination of both. Series means one device is dialed at a time, while parallel implies multiple devices ring at the same time.

Parameters

To dial a phone number:

Returns

Relay::Calling::ConnectResult - The result object to interact with.

Examples

Trying to connect a call by calling +18991114444 and +18991115555 in series.

1
connected = call.connect [
2
  [{ type: 'phone', params: { to_number: '+18991114444', from_number: "+1YYYYYYYYYY", timeout: 30 } }],
3
  [{ type: 'phone', params: { to_number: '+18991115555', from_number: "+1YYYYYYYYYY", timeout: 30 } }]
4
]
5
6
if connected.successful
7
  # connected.call is the remote leg connected with yours.
8
  connected.call.wait_for_ended
9
end
10
11
call.hangup

Trying to connect a call by calling +18991114444 and +18991115555 in series, playing the US ringtone.

1
connected = call.connect(devices: [
2
    [{ type: 'phone', params: { to_number: '+18991114444', from_number: "+1YYYYYYYYYY", timeout: 30 } }],
3
    [{ type: 'phone', params: { to_number: '+18991115555', from_number: "+1YYYYYYYYYY", timeout: 30 } }]
4
  ],
5
  ringback: { type: 'ringtone', name: 'us' }
6
)
7
8
if connected.successful
9
  # connected.call is the remote leg connected with yours.
10
  connected.call.wait_for_ended
11
end
12
13
call.hangup

Combine serial and parallel calling. Call +18991114443 first and - if it doesn’t answer - try calling in parallel +18991114444 and +18991114445. If none of the devices answer, continue the same process with +18991114446 and +18991114447.

1
 connected = call.connect [
2
    [{ type: 'phone', params: { to_number: '+18991114443', from_number: "+1YYYYYYYYYY", timeout: 30 } }],
3
    [
4
      { type: 'phone', params: { to_number: '+18991114444', from_number: "+1YYYYYYYYYY", timeout: 30 } },
5
      { type: 'phone', params: { to_number: '+18991114445', from_number: "+1YYYYYYYYYY", timeout: 30 } },
6
    ],
7
    [
8
      { type: 'phone', params: { to_number: '+18991114446', from_number: "+1YYYYYYYYYY", timeout: 30 } },
9
      { type: 'phone', params: { to_number: '+18991114447', from_number: "+1YYYYYYYYYY", timeout: 30 } },
10
    ]
11
  ]
12
13
  if connected.successful
14
    # connected.call is the remote leg connected with yours.
15
    connected.call.wait_for_ended
16
  end
17
18
  call.hangup

connect!

Asynchronous version of connect. It does not wait for the connect to complete or fail, and it immediately returns a ConnectAction object you can interact with.

Parameters

See connect for the parameter list.

Returns

Relay::Calling::ConnectAction - The action object to interact with.

Examples

Trying to connect a call by calling in series +18991114444 and +18991114445.

1
connected = call.connect! [
2
  [{ type: 'phone', params: { to_number: '+18991114444', from_number: "+1YYYYYYYYYY", timeout: 30 } }],
3
  [{ type: 'phone', params: { to_number: '+18991114445', from_number: "+1YYYYYYYYYY", timeout: 30 } }]
4
]
5
6
# asynchronous code that executes in parallel with the dial
7
8
if connected.completed
9
  #the call is now connected
10
end

detect

Starts a detector on the call and waits until it has finished or failed.

The detect method is a generic method for all types of detecting, see detect_digit, detect_fax, detect_human or detect_machine for more specific usage.

Parameters

When type is machine:

When type is fax:

When type is digits:

Returns

Relay::Calling::DetectResult - The result object to interact with.

Examples

Detect with custom parameters and timeout.

1
result = call.detect(type: :digit, digits: "345" timeout: 10)
2
logger.debug "User pressed #{result.result}"

Detect a Fax setting timeout only.

1
result = call.detect(type: :fax, detect: detect)
2
puts "fax detected" if result.successful

detect!

Asynchronous version of detect. It does not wait for the detector to stop, and returns a DetectAction object you can interact with.

Parameters

See detect for the parameter list.

Returns

Relay::Calling::DetectAction - The action object to interact with.

Examples

Detect all the digits using default parameters. Stop the action after 5 seconds.

1
action = call.detect!(type: :digit, digits: "345" timeout: 10)
2
sleep 5
3
action.stop

detect_answering_machine

This is a helper function that refines the use of detect. It is used to detect a machine, and is intended to replace the deprecated methods.

Parameters

Returns

Relay::Calling::DetectResult - The result object to interact with.

Examples

Detect a machine and log the result.

1
result = call.detect_answering_machine(initial_timeout: 10, timeout: 10)
2
logger.debug "Detect result was #{result.result}"

detect_answering_machine!

Asynchronous version of detect_answering_machine. It does not wait the detector ends but returns a DetectAction object you can interact with.

Parameters

See detect_answering_machine for the parameter list.

Returns

Relay::Calling::DetectAction - The action object to interact with.

Examples

Detect a machine. Stop the action after 5 seconds.

1
action = call.detect_answering_machine!(initial_timeout: 10, timeout: 10)
2
sleep 5
3
action.stop

amd

Alias of detect_answering_machine.

Parameters

See detect_answering_machine for the parameter list.

Returns

Relay::Calling::DetectResult - The result object to interact with.

amd!

Alias of the asynchronous detect_answering_machine! method.

Parameters

See detect_answering_machine for the parameter list.

Returns

Relay::Calling::DetectAction - The action object to interact with.

detect_digit

This is a helper function that refines the use of detect. This simplifies detecting digits on a call.

Parameters

Returns

Relay::Calling::DetectResult - The result object to interact with.

Examples

Detect digits and then write a log with the result.

1
result = call.detect_digit(digits: "345", timeout: 10)
2
logger.debug "User pressed #{result.result}"

detect_digit!

Asynchronous version of detect_digit. It does not wait the detector ends but returns a DetectAction object you can interact with.

Parameters

See detect_digit for the parameter list.

Returns

Relay::Calling::DetectAction - The action object to interact with.

Examples

Detect 1-3 digits. Stop the action after 5 seconds.

1
action = call.detect_digit!(digits: "345", timeout: 10)
2
sleep 5
3
action.stop

detect_fax

This is a helper function that refines the use of detect. This simplifies detecting a fax.

Parameters

Returns

Relay::Calling::DetectResult - The result object to interact with.

Examples

Detect fax on the current call.

1
result = call.detect_fax
2
puts "fax detected" if result.successful

detect_fax!

Asynchronous version of detect_fax. It does not wait for the detector to end, and returns a DetectAction object you can interact with.

Parameters

See detect_fax for the parameter list.

Returns

Relay::Calling::DetectAction - The action object to interact with.

Examples

Detect fax on the current call. Stop the action after 5 seconds.

1
action = call.detect_fax!
2
sleep 5
3
action.stop

detect_human

This is a helper function that refines the use of detect. This simplifies detecting a human on the call and is the inverse of detect_machine.

This method is DEPRECATED and will be removed in version 3.0

Parameters

Returns

Relay::Calling::DetectResult - The result object to interact with.

Examples

Detect a human on the current call.

1
result = call.detect_human
2
puts "human detected" if result.successful

detect_human!

Asynchronous version of detect_human. It does not wait for the detector to end, and returns a DetectAction object you can interact with.

This method is DEPRECATED and will be removed in version 3.0

Parameters

See detect_human for the parameter list.

Returns

Relay::Calling::DetectAction - The action object to interact with.

Examples

Detect a human on the current call. Stop the action after 5 seconds.

1
action = call.detect_human!
2
sleep 5
3
action.stop

detect_machine

This is a helper function that refines the use of detect. This simplifies detecting a machine on the call and is the inverse of detect_human.

This method is DEPRECATED and will be removed in version 3.0

Parameters

Returns

Relay::Calling::DetectResult - The result object to interact with.

Examples

Detect a machine on the current call.

1
result = call.detect_machine
2
puts "machine detected" if result.successful

detect_machine!

Asynchronous version of detect_machine. It does not wait for the detector, and returns a DetectAction object you can interact with.

This method is DEPRECATED and will be removed in version 3.0

Parameters

See detect_machine for the parameter list.

Returns

Relay::Calling::DetectAction - The action object to interact with.

Examples

Detect a machine on the current call. Stop the action after 5 seconds.

1
action = call.detect_machine!
2
sleep 5
3
action.stop

dial

This will start a call that was created with new_call and wait until the call has been answered or hung up.

Parameters

None

Returns

Relay::Calling::DialResult - The result object to interact with.

Examples

1
call = client.calling.new_call(from: "+1XXXXXXXXXX", to: "+1YYYYYYYYYY")
2
call.dial

fax_receive

Prepare the call to receive an inbound Fax. It waits until the fax has been received or failed.

Parameters

None

Returns

Relay::Calling::FaxResult - The result object to interact with.

Examples

Receiving a fax on the call and print logs for URL and number of received pages.

1
fax_result = call.fax_receive
2
logger.debug "Received a fax: #{fax_result.document} that is #{fax_result.pages} pages long."

fax_receive!

Asynchronous version of fax_receive. It does not block until the fax is received, it immediately returns a FaxAction object you can interact with.

Parameters

None

Returns

Relay::Calling::FaxAction - The action object to interact with.

Examples

Trying to receive a fax. Stop the attempt after 5 seconds.

1
fax_action = call.fax_receive!
2
sleep 5
3
fax_action.stop

fax_send

Send a Fax through the call. It waits until the fax has been sent or failed.

Parameters

Returns

Relay::Calling::FaxResult - The result object to interact with.

Examples

Sending a fax on the call and print logs the number of sent pages.

1
fax_result = call.fax_send(document: "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf")
2
logger.debug "Sent a fax: #{fax_result.document} that is #{fax_result.pages} pages long."

fax_send!

Asynchronous version of fax_send. It does not block until the fax is finished sending, it immediately returns a FaxAction object you can interact with.

Parameters

See fax_send for the parameter list.

Returns

Relay.Calling.FaxAction - The action object to interact with.

Examples

Trying to send a fax. Stop sending it after 5 seconds.

1
fax_action = call.fax_send(document: "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf")
2
sleep 5
3
fax_action.stop

hangup

Hangup the call.

Parameters

None

Returns

Relay::Calling::HangupResult - The result object to interact with.

Examples

Hangup a call and check if it was successful.

1
hangup_result = call.hangup
2
if hangup_result.successful
3
  # call was hung up correctly
4
end

on

Attach an event handler for various events.

Parameters

Returns

Relay::Calling::Call - The call object itself.

Examples

Subscribe to the answered and ended events for a given call.

1
call.on :answered do |event|
2
   # call was answered by event
3
end
4
5
call.on :ended do |event|
6
   # call ended on event
7
end

play

Play one or multiple media in a call and waits until the playing has ended.

The play method is a generic method for all types of playing, see play_audio, play_silence, play_tts or play_ringtone for more specific usage.

Parameters

To play an audio file:

To play a text to speech string:

To play silence:

To play a ringtone:

Returns

Relay::Calling::PlayResult - The result object to interact with.

Examples

Play multiple media elements in the call.

1
media = [
2
  { type: 'tts', params: { text: 'Listen this awesome file!' } },
3
  { type: 'audio', params: { url: 'https://cdn.signalwire.com/default-music/welcome.mp3' } },
4
  { type: 'silence', params: { duration: 5 } },
5
  { type: 'tts', params: { text: 'Did you like it?' } }
6
]
7
8
play_result = call.play media

play!

Asynchronous version of play. It does not wait for the playing event to complete, it immediately returns a PlayAction object you can interact with.

Parameters

See play for the parameter list.

Returns

Relay::Calling::PlayAction - The action object to interact with.

Examples

Play multiple media elements in the call and stop them after 2 seconds.

1
media = [
2
  { type: 'tts', params: { text: 'Listen this awesome file!' } },
3
  { type: 'audio', params: { url: 'https://cdn.signalwire.com/default-music/welcome.mp3' } },
4
  { type: 'silence', params: { duration: 5 } },
5
  { type: 'tts', params: { text: 'Did you like it?' } }
6
]
7
8
play_action = call.play media
9
10
sleep 2
11
play_action.stop # audio will stop after 2 seconds

play_audio

This is a helper function that refines the use of play. This simplifies playing an audio file.

Parameters

Returns

Relay::Calling::PlayResult - The result object to interact with.

Examples

Play an MP3 file.

1
call.play_audio('https://cdn.signalwire.com/default-music/welcome.mp3')

play_audio!

Asynchronous version of play_audio. It does not wait for the playing event to complete, and immediately returns a PlayAction object you can interact with.

Parameters

See play_audio for the parameter list.

Returns

Relay::Calling::PlayAction - The action object to interact with.

Examples

Play an MP3 file and stop it after 2 seconds.

1
play_action = call.play_audio!('https://cdn.signalwire.com/default-music/welcome.mp3')
2
sleep 2
3
play_action.stop # audio will stop after 2 seconds

play_ringtone

This is a helper function that refines the use of play. This simplifies playing a ringtone.

Parameters

Returns

Relay::Calling::PlayResult - The result object to interact with.

Examples

Play a single US ringtone.

1
result = call.play_ringtone(name: 'US')

play_ringtone!

Asynchronous version of play_ringtone. It does not wait the playing to completes but returns a Relay::Calling::PlayAction you can interact with.

Parameters

See play_ringtone for the parameter list.

Returns

Relay::Calling::PlayAction - The action object to interact with.

Examples

Play US ringtone for 30 seconds and stop it after 5 seconds.

1
result = call.play_ringtone!(name: 'US', duration: 30)
2
sleep(5)
3
result.stop

play_silence

This is a helper function that refines the use of play. This simplifies playing silence.

Parameters

Returns

Relay::Calling::PlayResult - The result object to interact with.

Examples

Play silence for 10 seconds.

1
result = call.play_silence(10)

play_silence!

Asynchronous version of play_silence. It does not wait for the playing event to complete, it immediately returns a PlayAction object you can interact with.

Parameters

See play_silence for the parameter list.

Returns

Relay::Calling::PlayAction - The action object to interact with.

Examples

Play silence for 60 seconds, if Agent becomes available, stop the play.

1
action = call.play_silence(60)
2
action.stop if Agent.available

play_tts

This is a helper function that refines the use of play. This simplifies playing text to speech strings.

Parameters

Returns

Relay::Calling::PlayResult - The result object to interact with.

Examples

Play text to string.

1
result = call.play_tts text: "the quick brown fox jumps over the lazy dog", language: "en-US", gender: "male"

play_tts!

Asynchronous version of play_tts. It does not wait for the playing event to complete, it immediately returns a PlayAction object you can interact with.

Parameters

See play_tts for the parameter list.

Returns

Relay::Calling::PlayAction - The action object to interact with.

Examples

Play TTS and stop it after 2 seconds.

1
action = call.play_tts! text: "the quick brown fox jumps over the lazy dog", language: "en-US", gender: "male"
2
sleep 2
3
action.stop

prompt

Play one or multiple media while collecting user’s input from the call at the same time, such as digits and speech.

It waits until the collection succeeds or a timeout is reached.

The prompt method is a generic method, see prompt_audio or prompt_tts for more specific usage.

Passing any of the digits_ or speech_ arguments will activate the respective detector.

Parameters

Returns

Relay::Calling::PromptResult - The result object to interact with.

Examples

Ask user to enter their PIN and collect the digits.

1
tts = [{ type: 'tts', params: { text: 'Please, enter your 3 digit PIN.' } }]
2
result = call.prompt(initial_timeout: 10, digits_max: 3, digits_timeout: 5, play: tts)
3
4
if result.successful)
5
  type = result.type # digit
6
  pin = result.result # pin entered by the user
7
end

prompt!

Asynchronous version of prompt. It does not wait for the collect action to complete, it immediately returns a PromptAction object you can interact with.

Parameters

See prompt for the parameter list.

Returns

Relay::Calling::PromptAction - The action object to interact with.

Examples

Ask user to enter their PIN and collect the digits.

1
tts = [{ type: 'tts', params: { text: 'Please, enter your 3 digit PIN.' } }]
2
action = call.prompt!(initial_timeout: 10, digits_max: 3, digits_timeout: 5, play: tts)
3
4
# .. do other important things while collecting user digits..
5
6
if action.completed)
7
  result = action.result # => PromptResult object
8
end

prompt_audio

This is a helper function that refines the use of prompt. This function simplifies playing an audio file while collecting user’s input from the call, such as digits and speech.

Parameters

See prompt for the parameter list, plus:

Returns

Relay::Calling::PromptResult - The result object to interact with.

Examples

Collect user’s digits while playing an MP3 file, setting its volume to 20.

1
result = call.prompt_audio(initial_timeout: 10, digits_max: 3, digits_timeout: 5, url: 'https://cdn.signalwire.com/default-music/welcome.mp3', volume: 20)
2
3
if result.successful
4
  type = promptResult.type # digit
5
  digits = promptResult.result # digits entered by the user
6
end

prompt_audio!

Asynchronous version of prompt_audio. It does not wait for the collect action to complete, it immediately returns a PromptAction object you can interact with.

Parameters

See prompt_audio for the parameter list.

Returns

Relay::Calling::PromptAction - The action object to interact with.

Examples

Ask user to enter their PIN and collect the digits.

1
action = call.prompt_audio!(initial_timeout: 10, digits_max: 3, digits_timeout: 5, url: 'https://cdn.signalwire.com/default-music/welcome.mp3')
2
3
# .. do other important things while collecting user digits..
4
5
if action.completed
6
    result = action.result # => PromptResult object
7
end

prompt_silence

This is a helper function that refines the use of prompt. This function simplifies collecting user’s input from the call, such as digits and speech, while not playing any audio.

Parameters

See prompt for the parameter list, plus:

Returns

Relay::Calling::PromptResult - The result object to interact with.

Examples

Collect user’s digits while playing 5 seconds of silence.

1
result = call.prompt_silence(initial_timeout: 10, digits_max: 3, digits_timeout: 5, duration: 5)
2
3
if result.successful
4
  type = promptResult.type # digit
5
  digits = promptResult.result # digits entered by the user
6
end

prompt_silence!

Asynchronous version of prompt_silence. It does not wait for the collect action to complete, it immediately returns a PromptAction object you can interact with.

Parameters

See prompt_silence for the parameter list.

Returns

Relay::Calling::PromptAction - The action object to interact with.

Examples

Collect user’s digits while playing 5 seconds of silence.

1
action = call.prompt_silence!(initial_timeout: 10, digits_max: 3, digits_timeout: 5, duration: 5)
2
3
# .. do other important things while collecting user digits..
4
5
if action.completed
6
    result = action.result # => PromptResult object
7
end

prompt_ringtone

This is a helper function that refines the use of prompt. This function simplifies playing TTS while collecting user’s input from the call, such as digits and speech.

Parameters

See prompt for the parameter list, plus:

Returns

Relay::Calling::PromptResult - The result object to interact with.

Examples

Play US ringtone for 30 seconds while collecting digits.

1
result = call.prompt_ringtone(name: 'us', duration: 30, digits_max: 3)
2
3
if result.successful
4
  type = promptResult.type # digit
5
  digits = promptResult.result # digits entered by the user
6
end

prompt_ringtone!

Asynchronous version of prompt_ringtone. It does not wait the collection to completes but returns a Relay::Calling::PromptAction you can interact with.

Parameters

See prompt_ringtone for the parameter list.

Returns

Relay::Calling::PromptAction - The action object to interact with.

Examples

Play US ringtone for 30 seconds while collecting digits in asynchronous mode.

1
result = call.prompt_ringtone!(name: 'us', duration: 30, digits_max: 3)
2
3
# code is executing here...
4
5
if result.successful
6
  type = promptResult.type # digit
7
  digits = promptResult.result # digits entered by the user
8
end

prompt_tts

This is a helper function that refines the use of prompt. This function simplifies playing TTS while collecting user’s input from the call, such as digits and speech.

Parameters

See prompt for the parameter list, plus:

Returns

Relay::Calling::PromptResult - The result object to interact with.

Examples

Ask user to enter their PIN and collect the digits.

1
result = call.prompt_tts initial_timeout: 10, digits_max: 3, digits_timeout: 5, text: 'Please, enter your 3 digit PIN.', gender: 'male'
2
3
if result.successful
4
  type = promptResult.type # digit
5
  digits = promptResult.result # digits entered by the user
6
end

prompt_tts!

Asynchronous version of prompt_tts. It does not wait for the collection event to complete, it immediately returns a PromptAction object you can interact with.

Parameters

See prompt_tts for the parameter list.

Returns

Relay::Calling::PromptAction - The action object to interact with.

Examples

Ask user to enter their PIN and collect the digits.

1
action = call.prompt_tts! initial_timeout: 10, digits_max: 3, digits_timeout: 5, text: 'Please, enter your 3 digit PIN.', gender: 'male'
2
3
# .. do other important things while collecting user digits..
4
5
if action.completed
6
    result = action.result # => PromptResult object
7
end

record

Start recording the call and waits until the recording ends or fails.

Parameters

Returns

Relay::Calling::RecordResult - The result object to interact with.

Examples

Start recording audio in the call for both direction in stereo mode, if successful, print the url from the RecordResult object.

1
result = call.record(stereo: true, direction: 'both')
2
3
if result.successful
4
  puts result.url # the HTTP URL of the recording
5
end

record!

Asynchronous version of record. It does not wait for the end of the recording, it immediately returns a RecordAction object you can interact with.

Parameters

See record for the parameter list.

Returns

Relay::Calling::RecordAction - The action object to interact with.

Examples

Start recording audio in the call for both direction in stereo mode and stop it after 2 seconds.

1
action = call.record!(stereo: true, direction: 'both')
2
sleep 2
3
action.stop

send_digits

This method sends DTMF digits to the other party on the call.

Parameters

Returns

Relay::Calling::SendDigitsResult - The result object to interact with.

Examples

Send some digits.

1
call.send_digits('123')

send_digits!

Asynchronous version of send_digits. It does not wait for the sending event to complete, and immediately returns a SendDigitsAction object you can interact with.

Parameters

See send_digits for the parameter list.

Returns

Relay::Calling::SendDigitsAction - The action object to interact with.

Examples

Send some digits.

1
action = call.send_digits!('123123123123123')
2
# Do something while digits are sending...

tap_media

Intercept call media and stream it to the specified endpoint. It waits until the end of the call.

This method is named tap_media instead of tap in the Ruby SDK because of a reserved method.

Parameters

Returns

Relay::Calling::TapResult - The result object to interact with.

Examples

Tapping audio from the call, if successful, print both source and destination devices from the TapResult object.

1
result = call.tap_media(audio_direction: "listen", target_addr: "127.0.0.1", target_port: 1234)
2
3
if result.successful)
4
  puts result.source_device
5
  puts result.destination_device
6
end

Tapping audio into a WSS endpoint, if successful, print both source and destination devices from the TapResult object.

1
result = call.tap_media(audio_direction: "listen", target_type: 'ws', target_uri: 'wss://somewss.com')
2
3
if result.successful)
4
  puts result.source_device
5
  puts result.destination_device
6
end

tap_media!

Asynchronous version of tap_media. It does not wait the end of tapping but returns a TapAction object you can interact with.

Parameters

See tap_media for the parameter list.

Returns

Relay::Calling::TapAction - The action object to interact with.

Examples

Tapping audio from the call and then stop it using the TapAction object.

1
action = call.tap_media!(audio_direction: "listen", target_addr: "127.0.0.1", target_port: 1234)
2
sleep 5
3
action.stop

wait_for

Wait for specific events on the Call or returns false if the Call ends without getting one.

Parameters

Returns

Boolean - true/false.

Examples

Wait for ending or ended events.

1
if call.wait_for('ending', 'ended')
2
  # ending or ended was received
3
end

wait_for_answered

This is a helper function that refines the use of wait_for. This simplifies waiting for the answered state.

Parameters

None

Returns

Boolean - true/false.

Examples

Wait for the answered event.

1
if call.wait_for_answered
2
  # answered was received
3
end

wait_for_ended

This is a helper function that refines the use of wait_for. This simplifies waiting for the ended state.

Parameters

None

Returns

Boolean - true/false.

Examples

Wait for the ended event.

1
if call.wait_for_ended
2
  # ended was received
3
end

wait_for_ending

This is a helper function that refines the use of wait_for. This simplifies waiting for the ending state.

Parameters

None

Returns

Boolean - true/false.

Examples

Wait for the ending event.

1
if call.wait_for_ending
2
  # ending was received
3
end

wait_for_ringing

This is a helper function that refines the use of wait_for. This simplifies waiting for the ringing state.

Parameters

None

Returns

Boolean - true/false.

Examples

Wait for the ringing event.

1
if call.wait_for_ringing
2
  # ringing was received
3
end

Events

All these events can be used to track the calls lifecycle and instruct SignalWire on what to do for each different state.

State Events

To track the state of a call.

Connect Events

To track the connect state of a call.

Play Events

To track a playback state.

Record Events

To track a recording state.

Prompt Events

To track a prompt state.

Ringtones

Here you can find all the accepted values for playing a ringtone, based on short country codes: