Module: TropoRest::Client::Signal

Included in:

TropoRest::Client

Defined in:

lib/tropo_rest/client/signal.rb

Constant Summary

PLURAL_PATH =

"sessions/%s/signals".freeze

Instance Method Summary

• #create_signal(session_id, signal) ⇒ Hashie::Mash

  Sends a signal for the given session ID.

Instance Method Details

#create_signal(session_id, signal) ⇒ Hashie::Mash

Sends a signal for the given session ID

Parameters:

• session_id (String) —

  The 16-byte GUID session ID.

• signal (String) —

  The signal to send to the session.

Returns:

• (Hashie::Mash) —

  The signal object. Will have a field “status” with one of these values: “QUEUED”, “NOTFOUND”, “FAILED”

See Also:

• https://www.tropo.com/docs/rest/interrupting_code_one_signal.htm
• https://www.tropo.com/docs/rest/interrupting_code_multiple.htm
• https://www.tropo.com/docs/rest/unnamed_signals.htm
• https://www.tropo.com/docs/rest/redirecting_app_based_on_signal.htm
• https://www.tropo.com/docs/rest/event_queuing.htm
• https://www.tropo.com/docs/rest/starting_session.htm
• https://www.tropo.com/docs/rest/parameters.htm

# File 'lib/tropo_rest/client/signal.rb', line 19

def create_signal(session_id, signal)
  path = get_path(PLURAL_PATH, session_id)
  post(path, {"signal" => signal})
end