Class: ARI::Client

Inherits:

Object

• Object
• ARI::Client

Defined in:

lib/ari/client.rb

Instance Attribute Summary

• #host ⇒ String readonly

  Host name.

• #password ⇒ String readonly

  Password for basic auth.

• #port ⇒ Integer readonly

  Port number.

• #prefix ⇒ String readonly

  Prefix allows you to specify a prefix for all requests to the server.

• #username ⇒ String readonly

  Username for basic auth.

Instance Method Summary

• #applications_get(application_name) ⇒ Object

  GET /applications/:applicationName Application Get details of an application.

• #applications_list ⇒ Object

  GET /applications List List all applications.

• #applications_subscribe(application_name, params = {}) ⇒ Object

  POST /applications/:applicationName/subscription Application Subscribe an application to a event source.

• #applications_unsubscribe(application_name, params = {}) ⇒ Object

  DELETE /applications/:applicationName/subscription Application Unsubscribe an application from an event source.

• #asterisk_get_global_var(params = {}) ⇒ Object

  GET /asterisk/variable Variable Get the value of a global variable.

• #asterisk_get_info ⇒ Object

  GET /asterisk/info AsteriskInfo Gets Asterisk system information.

• #asterisk_set_global_var(params = {}) ⇒ Object

  POST /asterisk/variable void Set the value of a global variable.

• #bridges_add_channel(bridge_id, params = {}) ⇒ Object

  POST /bridges/:bridgeId/addChannel void Add a channel to a bridge.

• #bridges_create(params = {}) ⇒ Object

  POST /bridges Bridge Create a new bridge.

• #bridges_create_or_update_with_id(bridge_id, params = {}) ⇒ Object

  POST /bridges/:bridgeId Bridge Create a new bridge or updates an existing one.

• #bridges_destroy(bridge_id) ⇒ Object

  DELETE /bridges/:bridgeId void Shut down a bridge.

• #bridges_get(bridge_id) ⇒ Object

  GET /bridges/:bridgeId Bridge Get bridge details.

• #bridges_list ⇒ Object

  GET /bridges List List all active bridges in Asterisk.

• #bridges_play(bridge_id, params = {}) ⇒ Object

  POST /bridges/:bridgeId/play Playback Start playback of media on a bridge.

• #bridges_play_with_id(bridge_id, playback_id, params = {}) ⇒ Object

  POST /bridges/:bridgeId/play/:playbackId Playback Start playback of media on a bridge.

• #bridges_record(bridge_id, params = {}) ⇒ Object

  POST /bridges/:bridgeId/record LiveRecording Start a recording.

• #bridges_remove_channel(bridge_id, params = {}) ⇒ Object

  POST /bridges/:bridgeId/removeChannel void Remove a channel from a bridge.

• #bridges_start_moh(bridge_id, params = {}) ⇒ Object

  POST /bridges/:bridgeId/moh void Play music on hold to a bridge or change the MOH class that is playing.

• #bridges_stop_moh(bridge_id) ⇒ Object

  DELETE /bridges/:bridgeId/moh void Stop playing music on hold to a bridge.

• #channels_answer(channel_id) ⇒ Object

  POST /channels/:channelId/answer void Answer a channel.

• #channels_continue_in_dialplan(channel_id, params = {}) ⇒ Object

  POST /channels/:channelId/continue void Exit application; continue execution in the dialplan.

• #channels_get(channel_id) ⇒ Object

  GET /channels/:channelId Channel Channel details.

• #channels_get_channel_var(channel_id, params = {}) ⇒ Object

  GET /channels/:channelId/variable Variable Get the value of a channel variable or function.

• #channels_hangup(channel_id, params = {}) ⇒ Object

  DELETE /channels/:channelId void Delete (i.e. hangup) a channel.

• #channels_hold(channel_id) ⇒ Object

  POST /channels/:channelId/hold void Hold a channel.

• #channels_list ⇒ Object

  Channels REST API GET /channels List List all active channels in Asterisk.

• #channels_mute(channel_id, params = {}) ⇒ Object

  POST /channels/:channelId/mute void Mute a channel.

• #channels_originate(params = {}) ⇒ Object

  POST /channels Channel Create a new channel (originate).

• #channels_originate_with_id(channel_id, params = {}) ⇒ Object

  POST /channels/:channelId Channel Create a new channel (originate with id).

• #channels_play(channel_id, params = {}) ⇒ Object

  POST /channels/:channelId/play Playback Start playback of media.

• #channels_play_with_id(channel_id, playback_id, params = {}) ⇒ Object

  POST /channels/:channelId/play/:playbackId Playback Start playback of media and specify the playbackId.

• #channels_record(channel_id, params = {}) ⇒ Object

  POST /channels/:channelId/record LiveRecording Start a recording.

• #channels_ring(channel_id) ⇒ Object

  POST /channels/:channelId/ring void Indicate ringing to a channel.

• #channels_ring_stop(channel_id) ⇒ Object

  DELETE /channels/:channelId/ring void Stop ringing indication on a channel if locally generated.

• #channels_send_dtmf(channel_id, params = {}) ⇒ Object

  POST /channels/:channelId/dtmf void Send provided DTMF to a given channel.

• #channels_set_channel_var(channel_id, params = {}) ⇒ Object

  POST /channels/:channelId/variable void Set the value of a channel variable or function.

• #channels_snoop_channel(channel_id, params = {}) ⇒ Object

  POST /channels/:channelId/snoop Channel Start snooping.

• #channels_snoop_channel_with_id(channel_id, snoop_id, params = {}) ⇒ Object

  POST /channels/:channelId/snoop/:snoopId Channel Start snooping.

• #channels_start_moh(channel_id, params = {}) ⇒ Object

  POST /channels/:channelId/moh void Play music on hold to a channel.

• #channels_start_silence(channel_id) ⇒ Object

  /channels/:channelId/silence void Play silence to a channel.

• #channels_stop_moh(channel_id) ⇒ Object

  DELETE /channels/:channelId/moh void Stop playing music on hold to a channel.

• #channels_stop_silence(channel_id) ⇒ Object

  DELETE /channels/:channelId/silence void Stop playing silence to a channel.

• #channels_unhold(channel_id) ⇒ Object

  DELETE /channels/:channelId/hold void Remove a channel from hold.

• #channels_unmute(channel_id, params = {}) ⇒ Object

  DELETE /channels/:channelId/mute void Unmute a channel.

• #device_states_delete(device_name) ⇒ Object

  DELETE /deviceStates/:deviceName void Destroy a device-state controlled by ARI.

• #device_states_get(device_name) ⇒ Object

  GET /deviceStates/:deviceName DeviceState Retrieve the current state of a device.

• #device_states_list ⇒ Object

  GET /deviceStates List List all ARI controlled device states.

• #device_states_update(device_name, params = {}) ⇒ Object

  PUT /deviceStates/:deviceName void Change the state of a device controlled by ARI.

• #endpoints_get(tech, resource) ⇒ Object

  GET /endpoints/:tech/:resource Endpoint Details for an endpoint.

• #endpoints_list ⇒ Object

  GET /endpoints List List all endpoints.

• #endpoints_list_by_tech(tech) ⇒ Object

  GET /endpoints/:tech List List available endoints for a given endpoint technology.

• #endpoints_send_message(params = {}) ⇒ Object

  PUT /endpoints/sendMessage void Send a message to some technology URI or endpoint.

• #endpoints_send_message_to_endpoint(tech, resource, params = {}) ⇒ Object

  PUT /endpoints/:tech/:resource/sendMessage void Send a message to some endpoint in a technology.

• #events_user_event(event_name, params = {}) ⇒ Object

  POST /events/user/:eventName void Generate a user event.

• #initialize(options = {}) ⇒ Client constructor

  A new instance of Client.

• #mailboxes_delete(mailbox_name) ⇒ Object

  DELETE /mailboxes/:mailboxName void Destroy a mailbox.

• #mailboxes_get(mailbox_name) ⇒ Object

  GET /mailboxes/:mailboxName Mailbox Retrieve the current state of a mailbox.

• #mailboxes_list ⇒ Object

  GET /mailboxes List List all mailboxes.

• #mailboxes_update(mailbox_name, params = {}) ⇒ Object

  PUT /mailboxes/:mailboxName void Change the state of a mailbox.

• #playbacks_control(playback_id, params = {}) ⇒ Object

  POST /playbacks/:playbackId/control void Control a playback.

• #playbacks_get(playback_id) ⇒ Object

  GET /playbacks/:playbackId Playback Get a playback’s details.

• #playbacks_stop(playback_id) ⇒ Object

  DELETE /playbacks/:playbackId void Stop a playback.

• #recordings_cancel(recording_name) ⇒ Object

  DELETE /recordings/live/:recordingName void Stop a live recording and discard it.

• #recordings_copy_stored(recording_name, params = {}) ⇒ Object

  POST /recordings/stored/:recordingName/copy StoredRecording Copy a stored recording.

• #recordings_delete_stored(recording_name) ⇒ Object

  DELETE /recordings/stored/:recordingName void Delete a stored recording.

• #recordings_get_live(recording_name) ⇒ Object

  GET /recordings/live/:recordingName LiveRecording List live recordings.

• #recordings_get_stored(recording_name) ⇒ Object

  GET.

• #recordings_list_stored ⇒ Object

  GET /recordings/stored List List recordings that are complete.

• #recordings_mute(recording_name) ⇒ Object

  POST /recordings/live/:recordingName/mute void Mute a live recording.

• #recordings_pause(recording_name) ⇒ Object

  POST /recordings/live/:recordingName/pause void Pause a live recording.

• #recordings_stop(recording_name) ⇒ Object

  POST /recordings/live/:recordingName/stop void Stop a live recording and store it.

• #recordings_unmute(recording_name) ⇒ Object

  DELETE /recordings/live/:recordingName/mute void Unmute a live recording.

• #recordings_unpause(recording_name) ⇒ Object

  DELETE /recordings/live/:recordingName/pause void Unpause a live recording.

• #sounds_get(sound_id) ⇒ Object

  GET /sounds/:soundId Sound Get a sound’s details.

• #sounds_list(params = {}) ⇒ Object

  GET /sounds List List all sounds.

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.

Parameters:

• options (Hash) (defaults to: {})

Options Hash (options):

• :host (String) — default: "localhost" —

  Host name

• :port (Integer) — default: 8088 —

  Port number

• :prefix (String) —

  Prefix allows you to specify a prefix for all requests to the server.

• :username (String) —

  username for basic auth

• :password (String) —

  password for basic auth

# File 'lib/ari/client.rb', line 23

def initialize(options = {})
  @host     = options[:host] || "localhost"
  @port     = options[:port] || 8088
  @prefix   = options[:prefix] if options[:prefix]
  @username = options[:username] if options[:username]
  @password = options[:password] if options[:password]
end

Instance Attribute Details

#host ⇒ String (readonly)

Returns Host name.

Returns:

• (String) —

  Host name

# File 'lib/ari/client.rb', line 15

class Client

  # @param [Hash] options
  # @option options [String] :host ("localhost") Host name
  # @option options [Integer] :port (8088) Port number
  # @option options [String] :prefix Prefix allows you to specify a prefix for all requests to the server.
  # @option options [String] :username username for basic auth
  # @option options [String] :password password for basic auth
  def initialize(options = {})
    @host     = options[:host] || "localhost"
    @port     = options[:port] || 8088
    @prefix   = options[:prefix] if options[:prefix]
    @username = options[:username] if options[:username]
    @password = options[:password] if options[:password]
  end
  attr_reader :host, :port, :prefix, :username, :password

  %w(get post put delete).each do |verb|
    define_method(verb) do |path, params = {}|
      api_call(path, params, verb)
    end
  end

  # Asterisk REST API

  # GET
  # /asterisk/info
  # AsteriskInfo
  # Gets Asterisk system information.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getInfo
  #
  # @param [String] only Filter information returned. Allows comma separated values.
  def asterisk_get_info
    get "asterisk/info"
  end

  # GET
  # /asterisk/variable
  # Variable
  # Get the value of a global variable.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getGlobalVar
  #
  # @param [Hash] params
  # @option params [String] variable *required The variable to get
  #
  # Error Responses
  #
  # return 400 - Missing variable parameter.
  def asterisk_get_global_var(params = {})
    get "asterisk/variable", params
  end

  # POST
  # /asterisk/variable
  # void
  # Set the value of a global variable.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-setGlobalVar
  #
  # @param [Hash] params
  # @option params [String] :variable *required The variable to set
  # @option params [String] :value The value to set the variable to
  #
  # Error Responses
  # 400 - Missing variable parameter.
  def asterisk_set_global_var(params = {})
    post "asterisk/variable", params
  end


  # Bridges REST API
  #

  # GET
  # /bridges
  # List[Bridge]
  # List all active bridges in Asterisk.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-list
  def bridges_list
    get "bridges"
  end

  # POST
  # /bridges
  # Bridge
  # Create a new bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create
  #
  # @param [Hash] params
  # @option params [String] :type Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media).
  # @option params [String] :bridgeId Unique ID to give to the bridge being created.
  # @option params [String] :name Name to give to the bridge being created.
  def bridges_create(params = {})
    post "bridges", params
  end

  # POST
  # /bridges/:bridgeId
  # Bridge
  # Create a new bridge or updates an existing one.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create_or_update_with_id
  #
  # @param [String] bridge_id Unique ID to give to the bridge being created.
  # @param [Hash] params
  # @option params [String] :type Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media) to set.
  # @option params [String] :name Set the name of the bridge.
  def bridges_create_or_update_with_id(bridge_id, params = {})
    post "bridges/#{bridge_id}", params
  end

  # GET
  # /bridges/:bridgeId
  # Bridge
  # Get bridge details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-get
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  def bridges_get(bridge_id)
    get "bridges/#{bridge_id}"
  end

  # DELETE
  # /bridges/:bridgeId
  # void
  # Shut down a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-destroy
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  def bridges_destroy(bridge_id)
    delete "bridges/#{bridge_id}"
  end

  # POST
  # /bridges/:bridgeId/addChannel
  # void
  # Add a channel to a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-addChannel
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :channel *required Ids of channels to add to bridge
  # Allows comma separated values.
  # @option params [String] :role Channel's role in the bridge
  #
  # Error Responses
  #
  # 400 - Channel not found
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application; Channel currently recording
  # 422 - Channel not in Stasis application
  def bridges_add_channel(bridge_id, params = {})
    post "bridges/#{bridge_id}/addChannel", params
  end

  # POST
  # /bridges/:bridgeId/removeChannel
  # void
  # Remove a channel from a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-removeChannel
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :channel *required Ids of channels to remove from bridge. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Channel not found
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  # 422 - Channel not in this bridge
  def bridges_remove_channel(bridge_id, params = {})
    post "bridges/#{bridge_id}/removeChannel", params
  end

  # POST
  # /bridges/:bridgeId/moh
  # void
  # Play music on hold to a bridge or change the MOH class that is playing.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-startMoh
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :mohClass Channel's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  def bridges_start_moh(bridge_id, params = {})
    post "bridges/#{bridge_id}/moh", params
  end

  # DELETE
  # /bridges/:bridgeId/moh
  # void
  # Stop playing music on hold to a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-stopMoh
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  def bridges_stop_moh(bridge_id)
    delete "bridges/#{bridge_id}/moh"
  end

  # POST
  # /bridges/:bridgeId/play
  # Playback
  # Start playback of media on a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-play
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  # @option params [String] :playbackId Playback Id.
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in a Stasis application
  def bridges_play(bridge_id, params = {})
    post "bridges/#{bridge_id}/play", params
  end

  # POST
  # /bridges/:bridgeId/play/:playbackId
  # Playback
  # Start playback of media on a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-playWithId
  #
  # @param [String] bridge_id Bridge's id
  # @param [String] playback_id Playback ID.
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in a Stasis application
  def bridges_play_with_id(bridge_id, playback_id, params = {})
    post "bridges/#{bridge_id}/play/#{playback_id}", params
  end

  # POST
  # /bridges/:bridgeId/record
  # LiveRecording
  # Start a recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-record
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :name *required Recording's filename
  # @option params [String] :format *required Format to encode audio in
  # @option params [Integer] :maxDurationSeconds Maximum duration of the recording, in seconds. 0 for no limit.
  # @option params [Integer] :maxSilenceSeconds Maximum duration of silence, in seconds. 0 for no limit.
  # @option params [String] :ifExists ("fail") Action to take if a recording with the same name already exists.
  # @option params [Boolean] :beep Play beep when recording begins
  # @option params [String] :terminateOn ("none") DTMF input to terminate recording.
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Bridge not found
  # 409 - Bridge is not in a Stasis application; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
  # 422 - The format specified is unknown on this system
  def bridges_record(bridge_id, params = {})
    post "bridges/#{bridge_id}/record", params
  end

  # Channels REST API
  # GET
  # /channels
  # List[Channel]
  # List all active channels in Asterisk.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-list
  #
  def channels_list
    get "channels"
  end

  # POST
  # /channels
  # Channel
  # Create a new channel (originate).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originate
  #
  # @param [Hash] params
  # @option params [String] :endpoint *required Endpoint to call.
  # @option params [String] :extension The extension to dial after the endpoint answers
  # @option params [String] :context The context to dial after the endpoint answers. If omitted, uses 'default'
  # @option params [Long] :priority The priority to dial after the endpoint answers. If omitted, uses 1
  # @option params [String] :app The application that is subscribed to the originated channel, and passed to the Stasis application.
  # @option params [String] :appArgs The application arguments to pass to the Stasis application.
  # @option params [String] :callerId CallerID to use when dialing the endpoint or extension.
  # @option params [Integer] :timeout (30) Timeout (in seconds) before giving up dialing, or -1 for no timeout.
  # @option params [String] :channelId The unique id to assign the channel on creation.
  # @option params [String] :otherChannelId The unique id to assign the second channel when using local channels.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }
  #
  # Error Responses
  #
  # 400 - Invalid parameters for originating a channel.
  def channels_originate(params = {})
    post "channels", params
  end

  # GET
  # /channels/:channelId
  # Channel
  # Channel details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-get
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  def channels_get(channel_id)
    get "channels/#{channel_id}"
  end

  # POST
  # /channels/:channelId
  # Channel
  # Create a new channel (originate with id).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originateWithId
  #
  # @param [String] channel_id The unique id to assign the channel on creation.
  # @param [Hash] params
  # @option params [String] :endpoint *required Endpoint to call.
  # @option params [String] :extension The extension to dial after the endpoint answers
  # @option params [String] :context The context to dial after the endpoint answers. If omitted, uses 'default'
  # @option params [Long] priority The priority to dial after the endpoint answers. If omitted, uses 1
  # @option params [String] :app The application that is subscribed to the originated channel, and passed to the Stasis application.
  # @option params [String] :appArgs The application arguments to pass to the Stasis application.
  # @option params [String] :callerId CallerID to use when dialing the endpoint or extension.
  # @option params [Integer] :timeout (30) Timeout (in seconds) before giving up dialing, or -1 for no timeout.
  # @option params [String] :otherChannelId The unique id to assign the second channel when using local channels.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }
  #
  # Error Responses
  #
  # 400 - Invalid parameters for originating a channel.
  def channels_originate_with_id(channel_id, params = {})
    post "channels/#{channel_id}", params
  end

  # DELETE
  # /channels/:channelId
  # void
  # Delete (i.e. hangup) a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hangup
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :reason Reason for hanging up the channel
  #
  # Error Responses
  #
  # 400 - Invalid reason for hangup provided
  # 404 - Channel not found
  def channels_hangup(channel_id, params = {})
    delete "channels/#{channel_id}", params
  end

  # POST
  # /channels/:channelId/continue
  # void
  # Exit application; continue execution in the dialplan.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-continueInDialplan
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :context The context to continue to.
  # @option params [String] :extension The extension to continue to.
  # @option params [Integer] :priority The priority to continue to.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_continue_in_dialplan(channel_id, params = {})
    post "channels/#{channel_id}/continue", params
  end

  # POST
  # /channels/:channelId/answer
  # void
  # Answer a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-answer
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_answer(channel_id)
    post "channels/#{channel_id}/answer"
  end

  # POST
  # /channels/:channelId/ring
  # void
  # Indicate ringing to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ring
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_ring(channel_id)
    post "channels/#{channel_id}/ring"
  end

  # DELETE
  # /channels/:channelId/ring
  # void
  # Stop ringing indication on a channel if locally generated.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ringStop
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_ring_stop(channel_id)
    delete "channels/#{channel_id}/ring"
  end

  # POST
  # /channels/:channelId/dtmf
  # void
  # Send provided DTMF to a given channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-sendDTMF
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :dtmf DTMF To send.
  # @option params [Integer] :before Amount of time to wait before DTMF digits (specified in milliseconds) start.
  # @option params [Integer] :between (100) Amount of time in between DTMF digits (specified in milliseconds).
  # @option params [Integer] :duration (100) Length of each DTMF digit (specified in milliseconds).
  # @option params [Integer] :after Amount of time to wait after DTMF digits (specified in milliseconds) end.
  #
  # Error Responses
  #
  # 400 - DTMF is required
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_send_dtmf(channel_id, params = {})
    post "channels/#{channel_id}/dtmf", params
  end

  # POST
  # /channels/:channelId/mute
  # void
  # Mute a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-mute
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :direction ("both") Direction in which to mute audio
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_mute(channel_id, params = {})
    post "channels/#{channel_id}/mute", params
  end

  # DELETE
  # /channels/:channelId/mute
  # void
  # Unmute a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unmute
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :direction ("both") Direction in which to unmute audio
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_unmute(channel_id, params = {})
    delete "channels/#{channel_id}/mute", params
  end

  # POST
  # /channels/:channelId/hold
  # void
  # Hold a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hold
  #
  # @param [String] channel_id  Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_hold(channel_id)
    post "channels/#{channel_id}/hold"
  end

  # DELETE
  # /channels/:channelId/hold
  # void
  # Remove a channel from hold.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unhold
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_unhold(channel_id)
    delete "channels/#{channel_id}/hold"
  end

  # POST
  # /channels/:channelId/moh
  # void
  # Play music on hold to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startMoh
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :mohClass Music on hold class to use
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_start_moh(channel_id, params = {})
    post "channels/#{channel_id}/moh", params
  end

  # DELETE
  # /channels/:channelId/moh
  # void
  # Stop playing music on hold to a channel.
  # POST
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopMoh
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_stop_moh(channel_id)
    delete "channels/#{channel_id}/moh"
  end

  # /channels/:channelId/silence
  # void
  # Play silence to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startSilence
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_start_silence(channel_id)
    post "channels/#{channel_id}/silence"
  end

  # DELETE
  # /channels/:channelId/silence
  # void
  # Stop playing silence to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopSilence
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_stop_silence(channel_id)
    delete "channels/#{channel_id}/silence"
  end

  # POST
  # /channels/:channelId/play
  # Playback
  # Start playback of media.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-play
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  # @option params [String] :playbackId Playback ID.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_play(channel_id, params = {})
    post "channels/#{channel_id}/play", params
  end

  # POST
  # /channels/:channelId/play/:playbackId
  # Playback
  # Start playback of media and specify the playbackId.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-playWithId
  #
  # @param [String] channel_id channel_id
  # @param [String] playback_id playback_id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_play_with_id(channel_id, playback_id, params = {})
    post "channels/#{channel_id}/play/#{playback_id}", params
  end

  # POST
  # /channels/:channelId/record
  # LiveRecording
  # Start a recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-record
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :name *required Recording's filename
  # @option params [String] :format *required Format to encode audio in
  # @option params [Integer] :maxDurationSeconds Maximum duration of the recording, in seconds. 0 for no limit
  # @option params [Integer] :maxSilenceSeconds Maximum duration of silence, in seconds. 0 for no limit
  # @option params [String] :ifExists ("fail") - Action to take if a recording with the same name already exists.
  # @option params [Boolen] :beep Play beep when recording begins
  # @option params [String] :terminateOn ("none") DTMF input to terminate recording
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  # 409 - Channel is not in a Stasis application; the channel is currently bridged with other hcannels; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
  # 422 - The format specified is unknown on this system
  def channels_record(channel_id, params = {})
    post "channels/#{channel_id}/record", params
  end

  # GET
  # /channels/:channelId/variable
  # Variable
  # Get the value of a channel variable or function.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-getChannelVar
  #
  # @param [String] channel_id channel_id
  # @param [Hash] params
  # @option params [String] :variable *required The channel variable or function to get
  #
  # Error Responses
  #
  # 400 - Missing variable parameter.
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_get_channel_var(channel_id, params = {})
    get "channels/#{channel_id}/variable", params
  end

  # POST
  # /channels/:channelId/variable
  # void
  # Set the value of a channel variable or function.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-setChannelVar
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :variable *required The channel variable or function to set
  # @option params [String] :value The value to set the variable to
  #
  # Error Responses
  #
  # 400 - Missing variable parameter.
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_set_channel_var(channel_id, params = {})
    post "channels/#{channel_id}/variable", params
  end

  # POST
  # /channels/:channelId/snoop
  # Channel
  # Start snooping.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannel
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :spy ("none") Direction of audio to spy on
  # @option params [String] :whisper ("none") Direction of audio to whisper into
  # @option params [String] :app *required Application the snooping channel is placed into
  # @option params [String] :appArgs The application arguments to pass to the Stasis application
  # @option params [String] :snoopId Unique ID to assign to snooping channel
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  def channels_snoop_channel(channel_id, params = {})
    post "channels/#{channel_id}/snoop", params
  end

  # POST
  # /channels/:channelId/snoop/:snoopId
  # Channel
  # Start snooping.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannelWithId
  #
  # @param [String] channel_id Channel's id
  # @param [String] snoop_id Unique ID to assign to snooping channel
  # @param [Hash] params
  # @option param [String] :spy ("none") Direction of audio to spy on
  # @option param [String] :whisper ("none") Direction of audio to whisper into
  # @option param [String] :app *required Application the snooping channel is placed into
  # @option param [String] :appArgs The application arguments to pass to the Stasis application
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  def channels_snoop_channel_with_id(channel_id, snoop_id, params = {})
    post "channels/#{channel_id}/snoop/#{snoop_id}", params
  end

  # Endpoints REST API

  # GET
  # /endpoints
  # List[Endpoint]
  # List all endpoints.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-list
  def endpoints_list
    get "endpoints"
  end

  # PUT
  # /endpoints/sendMessage
  # void
  # Send a message to some technology URI or endpoint.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessage
  #
  # @param [Hash] params
  # @option param [String] to *required The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.
  # @option param [String] from *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
  # @option param [String] body The body of the message
  #
  # Body parameter
  #
  # variables: containers -
  #
  # Error Responses
  #
  # 404 - Endpoint not found
  def endpoints_send_message(params = {})
    put "endpoints/sendMessage", params
  end

  # GET
  # /endpoints/:tech
  # List[Endpoint]
  # List available endoints for a given endpoint technology.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-listByTech
  #
  # @param [String] tech Technology of the endpoints (sip,iax2,...)
  #
  # Error Responses
  #
  # 404 - Endpoints not found
  def endpoints_list_by_tech(tech)
    get "endpoints/#{tech}"
  end

  # GET
  # /endpoints/:tech/:resource
  # Endpoint
  # Details for an endpoint.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-get
  #
  # @param [String] tech Technology of the endpoint
  # @param [String] resource ID of the endpoint
  #
  # Error Responses
  #
  # 400 - Invalid parameters for sending a message.
  # 404 - Endpoints not found
  def endpoints_get(tech, resource)
    get "endpoints/#{tech}/#{resource}"
  end

  # PUT
  # /endpoints/:tech/:resource/sendMessage
  # void
  # Send a message to some endpoint in a technology.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessageToEndpoint
  #
  # @param [String] tech Technology of the endpoint
  # @param [String] resource ID of the endpoint
  # @param [Hash] params
  # @option params [String] :from *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
  # @option params [String] :body The body of the message
  #
  # Body parameter
  #
  # variables: containers -
  #
  # Error Responses
  #
  # 400 - Invalid parameters for sending a message.
  # 404 - Endpoint not found
  def endpoints_send_message_to_endpoint(tech, resource, params = {})
    put "endpoints/#{tech}/#{resource}/sendMessage", params
  end

  # TODO
  # # Events REST API

  # # GET
  # # /events
  # # Message
  # # WebSocket connection for events.
  # #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-eventWebsocket
  # def events_event_websocket
  #   get "events"
  # end

  # POST
  # /events/user/:eventName
  # void
  # Generate a user event.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-userEvent
  #
  # @param [String] event_name event_name
  # @param [Hash] params
  # @option param [String] application #required The name of the application that will receive this event
  # @option param [String] source URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName}. Allows comma separated values.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds custom key/value pairs to add to the user event. Ex. { "variables": { "key": "value" } }
  #
  # Error Responses
  #
  # 404 - Application does not exist.
  # 422 - Event source not found.
  # 400 - Invalid even tsource URI or userevent data.
  def events_user_event(event_name, params = {})
    post "events/user/#{event_name}", params
  end

  # Recordings REST API

  # GET
  # /recordings/stored
  # List[StoredRecording]
  # List recordings that are complete.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-listStored
  def recordings_list_stored
    get "recordings/stored"
  end

  # GET
  #
  # /recordings/stored/:recordingName
  #
  # StoredRecording
  # Get a stored recording's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getStored
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_get_stored(recording_name)
    get "recordings/stored/#{recording_name}"
  end

  # DELETE
  # /recordings/stored/:recordingName
  # void
  # Delete a stored recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-deleteStored
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_delete_stored(recording_name)
    delete "recordings/stored/#{recording_name}"
  end

  # POST
  # /recordings/stored/:recordingName/copy
  # StoredRecording
  # Copy a stored recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-copyStored
  #
  # @param [String] recording_name The name of the recording to copy
  # @param [Hash] params
  # @option params [String] :destinationRecordingName *required The destination name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - A recording with the same name already exists on the system
  def recordings_copy_stored(recording_name, params = {})
    post "recordings/stored/#{recording_name}/copy", params
  end

  # GET
  # /recordings/live/:recordingName
  # LiveRecording
  # List live recordings.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getLive
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_get_live(recording_name)
    get "recordings/live/#{recording_name}"
  end

  # DELETE
  # /recordings/live/:recordingName
  # void
  # Stop a live recording and discard it.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-cancel
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_cancel(recording_name)
    delete "recordings/live/#{recording_name}"
  end

  # POST
  # /recordings/live/:recordingName/stop
  # void
  # Stop a live recording and store it.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-stop
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_stop(recording_name)
    post "recordings/live/#{recording_name}/stop"
  end

  # POST
  # /recordings/live/:recordingName/pause
  # void
  # Pause a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-pause
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_pause(recording_name)
    post "recordings/live/#{recording_name}/pause"
  end

  # DELETE
  # /recordings/live/:recordingName/pause
  # void
  # Unpause a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unpause
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_unpause(recording_name)
    delete "recordings/live/#{recording_name}/pause"
  end

  # POST
  # /recordings/live/:recordingName/mute
  # void
  # Mute a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-mute
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_mute(recording_name)
    post "recordings/live/#{recording_name}/mute"
  end

  # DELETE
  # /recordings/live/:recordingName/mute
  # void
  # Unmute a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unmute
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_unmute(recording_name)
    delete "recordings/live/#{recording_name}/mute"
  end

  # Sounds REST API

  # GET
  # /sounds
  # List[Sound]
  # List all sounds.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-list
  #
  # @param [Hash] params
  # @option param [String] lang Lookup sound for a specific language.
  # @option param [String] format Lookup sound in a specific format.
  def sounds_list(params = {})
    get "sounds", params
  end

  # GET
  # /sounds/:soundId
  # Sound
  # Get a sound's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-get
  #
  # @param [String] sound_id Sound's id
  def sounds_get(sound_id)
    get "sounds/#{sound_id}"
  end

  # Applications REST API

  # GET
  # /applications
  # List[Application]
  # List all applications.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-list
  def applications_list
    get "applications"
  end

  # GET
  # /applications/:applicationName
  # Application
  # Get details of an application.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-get
  #
  # @param [String] application_name Application's name
  #
  # Error Responses
  #
  # 404 - Application does not exist.
  def applications_get(application_name)
    get "applications/#{application_name}"
  end

  # POST
  # /applications/:applicationName/subscription
  # Application
  # Subscribe an application to a event source.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-subscribe
  #
  # @param [String] application_name Application's name
  # @param [Hash] params
  # @option params [String] :eventSource *required URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Missing parameter.
  # 404 - Application does not exist.
  # 422 - Event source does not exist.
  def applications_subscribe(application_name, params = {})
    post "applications/#{application_name}/subscription", params
  end

  # DELETE
  # /applications/:applicationName/subscription
  # Application
  # Unsubscribe an application from an event source.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-unsubscribe
  #
  # @param [String] application_name Application's name
  # @param [Hash] params
  # @option params [String] :eventSource *required URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Missing parameter.
  # 404 - Application does not exist.
  # 409 - Application not subscribed to event source.
  # 422 - Event source does not exist.
  def applications_unsubscribe(application_name, params = {})
    delete "applications/#{application_name}/subscription", params
  end

  # Playbacks REST API

  # GET
  # /playbacks/:playbackId
  # Playback
  # Get a playback's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-get
  #
  # @param [String] playback_id Playback's id
  #
  # Error Responses
  #
  # 404 - The playback cannot be found
  def playbacks_get(playback_id)
    get "playbacks/#{playback_id}"
  end

  # DELETE
  # /playbacks/:playbackId
  # void
  # Stop a playback.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-stop
  #
  # @param [String] playback_id Playback's id
  #
  # Error Responses
  #
  # 404 - The playback cannot be found
  def playbacks_stop(playback_id)
    delete "playbacks/#{playback_id}"
  end

  # POST
  # /playbacks/:playbackId/control
  # void
  # Control a playback.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-control
  #
  # @param [String] playback_id Playback's id
  # @param [Hash] params
  # @option params [String] :operation *required Operation to perform on the playback.
  #
  # Error Responses
  #
  # 400 - The provided operation parameter was invalid
  # 404 - The playback cannot be found
  # 409 - The operation cannot be performed in the playback's current state
  def playbacks_control(playback_id, params = {})
    post "playbacks/#{playback_id}/control", params
  end

  # Devicestates REST API

  # GET
  # /deviceStates
  # List[DeviceState]
  # List all ARI controlled device states.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-list
  def device_states_list
    get "deviceStates"
  end

  # GET
  # /deviceStates/:deviceName
  # DeviceState
  # Retrieve the current state of a device.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-get
  #
  # @param [String] device_name Name of the device
  def device_states_get(device_name)
    get "deviceStates/#{device_name}"
  end

  # PUT
  # /deviceStates/:deviceName
  # void
  # Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-update
  #
  # @param [String] device_name Name of the device
  # @param [Hash] params
  # @option params [String] :deviceState *required Device state value
  #
  # Error Responses
  #
  # 404 - Device name is missing
  # 409 - Uncontrolled device specified
  def device_states_update(device_name, params = {})
    put "deviceStates/#{device_name}", params
  end

  # DELETE
  # /deviceStates/:deviceName
  # void
  # Destroy a device-state controlled by ARI.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-delete
  #
  # @param [String] device_name Name of the device
  #
  # Error Responses
  #
  # 404 - Device name is missing
  # 409 - Uncontrolled device specified
  def device_states_delete(device_name)
    delete "deviceStates/#{device_name}"
  end

  # Mailboxes REST API

  # GET
  # /mailboxes
  # List[Mailbox]
  # List all mailboxes.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-list
  def mailboxes_list
    get "mailboxes"
  end

  # GET
  # /mailboxes/:mailboxName
  # Mailbox
  # Retrieve the current state of a mailbox.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-get
  #
  # @param [String] mailbox_name Name of the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_get(mailbox_name)
    get "mailboxes/#{mailbox_name}"
  end

  # PUT
  # /mailboxes/:mailboxName
  # void
  # Change the state of a mailbox. (Note - implicitly creates the mailbox).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-update
  #
  # @param [String] mailbox_name Name of the mailbox
  # @param [Hash] params
  # @option params [Integer] :oldMessages *required Count of old messages in the mailbox
  # @option params [Integer] :newMessages *required Count of new messages in the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_update(mailbox_name, params = {})
    put "mailboxes/#{mailbox_name}", params
  end

  # DELETE
  # /mailboxes/:mailboxName
  # void
  # Destroy a mailbox.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-delete
  #
  # @param [String] mailbox_name Name of the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_delete(mailbox_name)
    delete "mailboxes/#{mailbox_name}"
  end

  private

    def api_call(path, args = {}, verb = "get", options = {}, &error_checking_block)
      # Setup args for make_request
      path = "/ari/#{path}" unless path =~ /^\//
      path = "/#{@prefix}#{path}" if @prefix

      options.merge!({:host => @host, :port => @port, :username => @username, :password => @password})
      # Make request via the provided service
      result = ARI.make_request path, args, verb, options

      if result.status >= 500
        error_detail = {
          :http_status => result.status.to_i,
          :body        => result.body
        }
        raise ARI::ServerError.new(result.body, error_detail)
      elsif result.status >= 400
        error_detail = {
          :http_status => result.status.to_i,
          :body        => result.body,
          :data        => ARI::JSON.load(result.body)
        }
        raise ARI::APIError.new(result.body, error_detail)
      end

      # Parse the body
      body = if result.headers["Content-Type"] && result.headers["Content-Type"].match("json")
        ARI::JSON.load result.body.to_s
      else
        result.body.to_s
      end
      # Return result
      if options[:http_component]
        result.send options[:http_component]
      else
        body
      end
    end

end

#password ⇒ String (readonly)

Returns password for basic auth.

Returns:

• (String) —

  password for basic auth

# File 'lib/ari/client.rb', line 15

class Client

  # @param [Hash] options
  # @option options [String] :host ("localhost") Host name
  # @option options [Integer] :port (8088) Port number
  # @option options [String] :prefix Prefix allows you to specify a prefix for all requests to the server.
  # @option options [String] :username username for basic auth
  # @option options [String] :password password for basic auth
  def initialize(options = {})
    @host     = options[:host] || "localhost"
    @port     = options[:port] || 8088
    @prefix   = options[:prefix] if options[:prefix]
    @username = options[:username] if options[:username]
    @password = options[:password] if options[:password]
  end
  attr_reader :host, :port, :prefix, :username, :password

  %w(get post put delete).each do |verb|
    define_method(verb) do |path, params = {}|
      api_call(path, params, verb)
    end
  end

  # Asterisk REST API

  # GET
  # /asterisk/info
  # AsteriskInfo
  # Gets Asterisk system information.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getInfo
  #
  # @param [String] only Filter information returned. Allows comma separated values.
  def asterisk_get_info
    get "asterisk/info"
  end

  # GET
  # /asterisk/variable
  # Variable
  # Get the value of a global variable.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getGlobalVar
  #
  # @param [Hash] params
  # @option params [String] variable *required The variable to get
  #
  # Error Responses
  #
  # return 400 - Missing variable parameter.
  def asterisk_get_global_var(params = {})
    get "asterisk/variable", params
  end

  # POST
  # /asterisk/variable
  # void
  # Set the value of a global variable.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-setGlobalVar
  #
  # @param [Hash] params
  # @option params [String] :variable *required The variable to set
  # @option params [String] :value The value to set the variable to
  #
  # Error Responses
  # 400 - Missing variable parameter.
  def asterisk_set_global_var(params = {})
    post "asterisk/variable", params
  end


  # Bridges REST API
  #

  # GET
  # /bridges
  # List[Bridge]
  # List all active bridges in Asterisk.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-list
  def bridges_list
    get "bridges"
  end

  # POST
  # /bridges
  # Bridge
  # Create a new bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create
  #
  # @param [Hash] params
  # @option params [String] :type Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media).
  # @option params [String] :bridgeId Unique ID to give to the bridge being created.
  # @option params [String] :name Name to give to the bridge being created.
  def bridges_create(params = {})
    post "bridges", params
  end

  # POST
  # /bridges/:bridgeId
  # Bridge
  # Create a new bridge or updates an existing one.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create_or_update_with_id
  #
  # @param [String] bridge_id Unique ID to give to the bridge being created.
  # @param [Hash] params
  # @option params [String] :type Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media) to set.
  # @option params [String] :name Set the name of the bridge.
  def bridges_create_or_update_with_id(bridge_id, params = {})
    post "bridges/#{bridge_id}", params
  end

  # GET
  # /bridges/:bridgeId
  # Bridge
  # Get bridge details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-get
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  def bridges_get(bridge_id)
    get "bridges/#{bridge_id}"
  end

  # DELETE
  # /bridges/:bridgeId
  # void
  # Shut down a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-destroy
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  def bridges_destroy(bridge_id)
    delete "bridges/#{bridge_id}"
  end

  # POST
  # /bridges/:bridgeId/addChannel
  # void
  # Add a channel to a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-addChannel
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :channel *required Ids of channels to add to bridge
  # Allows comma separated values.
  # @option params [String] :role Channel's role in the bridge
  #
  # Error Responses
  #
  # 400 - Channel not found
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application; Channel currently recording
  # 422 - Channel not in Stasis application
  def bridges_add_channel(bridge_id, params = {})
    post "bridges/#{bridge_id}/addChannel", params
  end

  # POST
  # /bridges/:bridgeId/removeChannel
  # void
  # Remove a channel from a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-removeChannel
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :channel *required Ids of channels to remove from bridge. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Channel not found
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  # 422 - Channel not in this bridge
  def bridges_remove_channel(bridge_id, params = {})
    post "bridges/#{bridge_id}/removeChannel", params
  end

  # POST
  # /bridges/:bridgeId/moh
  # void
  # Play music on hold to a bridge or change the MOH class that is playing.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-startMoh
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :mohClass Channel's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  def bridges_start_moh(bridge_id, params = {})
    post "bridges/#{bridge_id}/moh", params
  end

  # DELETE
  # /bridges/:bridgeId/moh
  # void
  # Stop playing music on hold to a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-stopMoh
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  def bridges_stop_moh(bridge_id)
    delete "bridges/#{bridge_id}/moh"
  end

  # POST
  # /bridges/:bridgeId/play
  # Playback
  # Start playback of media on a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-play
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  # @option params [String] :playbackId Playback Id.
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in a Stasis application
  def bridges_play(bridge_id, params = {})
    post "bridges/#{bridge_id}/play", params
  end

  # POST
  # /bridges/:bridgeId/play/:playbackId
  # Playback
  # Start playback of media on a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-playWithId
  #
  # @param [String] bridge_id Bridge's id
  # @param [String] playback_id Playback ID.
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in a Stasis application
  def bridges_play_with_id(bridge_id, playback_id, params = {})
    post "bridges/#{bridge_id}/play/#{playback_id}", params
  end

  # POST
  # /bridges/:bridgeId/record
  # LiveRecording
  # Start a recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-record
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :name *required Recording's filename
  # @option params [String] :format *required Format to encode audio in
  # @option params [Integer] :maxDurationSeconds Maximum duration of the recording, in seconds. 0 for no limit.
  # @option params [Integer] :maxSilenceSeconds Maximum duration of silence, in seconds. 0 for no limit.
  # @option params [String] :ifExists ("fail") Action to take if a recording with the same name already exists.
  # @option params [Boolean] :beep Play beep when recording begins
  # @option params [String] :terminateOn ("none") DTMF input to terminate recording.
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Bridge not found
  # 409 - Bridge is not in a Stasis application; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
  # 422 - The format specified is unknown on this system
  def bridges_record(bridge_id, params = {})
    post "bridges/#{bridge_id}/record", params
  end

  # Channels REST API
  # GET
  # /channels
  # List[Channel]
  # List all active channels in Asterisk.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-list
  #
  def channels_list
    get "channels"
  end

  # POST
  # /channels
  # Channel
  # Create a new channel (originate).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originate
  #
  # @param [Hash] params
  # @option params [String] :endpoint *required Endpoint to call.
  # @option params [String] :extension The extension to dial after the endpoint answers
  # @option params [String] :context The context to dial after the endpoint answers. If omitted, uses 'default'
  # @option params [Long] :priority The priority to dial after the endpoint answers. If omitted, uses 1
  # @option params [String] :app The application that is subscribed to the originated channel, and passed to the Stasis application.
  # @option params [String] :appArgs The application arguments to pass to the Stasis application.
  # @option params [String] :callerId CallerID to use when dialing the endpoint or extension.
  # @option params [Integer] :timeout (30) Timeout (in seconds) before giving up dialing, or -1 for no timeout.
  # @option params [String] :channelId The unique id to assign the channel on creation.
  # @option params [String] :otherChannelId The unique id to assign the second channel when using local channels.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }
  #
  # Error Responses
  #
  # 400 - Invalid parameters for originating a channel.
  def channels_originate(params = {})
    post "channels", params
  end

  # GET
  # /channels/:channelId
  # Channel
  # Channel details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-get
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  def channels_get(channel_id)
    get "channels/#{channel_id}"
  end

  # POST
  # /channels/:channelId
  # Channel
  # Create a new channel (originate with id).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originateWithId
  #
  # @param [String] channel_id The unique id to assign the channel on creation.
  # @param [Hash] params
  # @option params [String] :endpoint *required Endpoint to call.
  # @option params [String] :extension The extension to dial after the endpoint answers
  # @option params [String] :context The context to dial after the endpoint answers. If omitted, uses 'default'
  # @option params [Long] priority The priority to dial after the endpoint answers. If omitted, uses 1
  # @option params [String] :app The application that is subscribed to the originated channel, and passed to the Stasis application.
  # @option params [String] :appArgs The application arguments to pass to the Stasis application.
  # @option params [String] :callerId CallerID to use when dialing the endpoint or extension.
  # @option params [Integer] :timeout (30) Timeout (in seconds) before giving up dialing, or -1 for no timeout.
  # @option params [String] :otherChannelId The unique id to assign the second channel when using local channels.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }
  #
  # Error Responses
  #
  # 400 - Invalid parameters for originating a channel.
  def channels_originate_with_id(channel_id, params = {})
    post "channels/#{channel_id}", params
  end

  # DELETE
  # /channels/:channelId
  # void
  # Delete (i.e. hangup) a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hangup
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :reason Reason for hanging up the channel
  #
  # Error Responses
  #
  # 400 - Invalid reason for hangup provided
  # 404 - Channel not found
  def channels_hangup(channel_id, params = {})
    delete "channels/#{channel_id}", params
  end

  # POST
  # /channels/:channelId/continue
  # void
  # Exit application; continue execution in the dialplan.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-continueInDialplan
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :context The context to continue to.
  # @option params [String] :extension The extension to continue to.
  # @option params [Integer] :priority The priority to continue to.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_continue_in_dialplan(channel_id, params = {})
    post "channels/#{channel_id}/continue", params
  end

  # POST
  # /channels/:channelId/answer
  # void
  # Answer a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-answer
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_answer(channel_id)
    post "channels/#{channel_id}/answer"
  end

  # POST
  # /channels/:channelId/ring
  # void
  # Indicate ringing to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ring
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_ring(channel_id)
    post "channels/#{channel_id}/ring"
  end

  # DELETE
  # /channels/:channelId/ring
  # void
  # Stop ringing indication on a channel if locally generated.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ringStop
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_ring_stop(channel_id)
    delete "channels/#{channel_id}/ring"
  end

  # POST
  # /channels/:channelId/dtmf
  # void
  # Send provided DTMF to a given channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-sendDTMF
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :dtmf DTMF To send.
  # @option params [Integer] :before Amount of time to wait before DTMF digits (specified in milliseconds) start.
  # @option params [Integer] :between (100) Amount of time in between DTMF digits (specified in milliseconds).
  # @option params [Integer] :duration (100) Length of each DTMF digit (specified in milliseconds).
  # @option params [Integer] :after Amount of time to wait after DTMF digits (specified in milliseconds) end.
  #
  # Error Responses
  #
  # 400 - DTMF is required
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_send_dtmf(channel_id, params = {})
    post "channels/#{channel_id}/dtmf", params
  end

  # POST
  # /channels/:channelId/mute
  # void
  # Mute a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-mute
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :direction ("both") Direction in which to mute audio
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_mute(channel_id, params = {})
    post "channels/#{channel_id}/mute", params
  end

  # DELETE
  # /channels/:channelId/mute
  # void
  # Unmute a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unmute
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :direction ("both") Direction in which to unmute audio
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_unmute(channel_id, params = {})
    delete "channels/#{channel_id}/mute", params
  end

  # POST
  # /channels/:channelId/hold
  # void
  # Hold a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hold
  #
  # @param [String] channel_id  Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_hold(channel_id)
    post "channels/#{channel_id}/hold"
  end

  # DELETE
  # /channels/:channelId/hold
  # void
  # Remove a channel from hold.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unhold
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_unhold(channel_id)
    delete "channels/#{channel_id}/hold"
  end

  # POST
  # /channels/:channelId/moh
  # void
  # Play music on hold to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startMoh
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :mohClass Music on hold class to use
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_start_moh(channel_id, params = {})
    post "channels/#{channel_id}/moh", params
  end

  # DELETE
  # /channels/:channelId/moh
  # void
  # Stop playing music on hold to a channel.
  # POST
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopMoh
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_stop_moh(channel_id)
    delete "channels/#{channel_id}/moh"
  end

  # /channels/:channelId/silence
  # void
  # Play silence to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startSilence
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_start_silence(channel_id)
    post "channels/#{channel_id}/silence"
  end

  # DELETE
  # /channels/:channelId/silence
  # void
  # Stop playing silence to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopSilence
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_stop_silence(channel_id)
    delete "channels/#{channel_id}/silence"
  end

  # POST
  # /channels/:channelId/play
  # Playback
  # Start playback of media.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-play
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  # @option params [String] :playbackId Playback ID.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_play(channel_id, params = {})
    post "channels/#{channel_id}/play", params
  end

  # POST
  # /channels/:channelId/play/:playbackId
  # Playback
  # Start playback of media and specify the playbackId.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-playWithId
  #
  # @param [String] channel_id channel_id
  # @param [String] playback_id playback_id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_play_with_id(channel_id, playback_id, params = {})
    post "channels/#{channel_id}/play/#{playback_id}", params
  end

  # POST
  # /channels/:channelId/record
  # LiveRecording
  # Start a recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-record
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :name *required Recording's filename
  # @option params [String] :format *required Format to encode audio in
  # @option params [Integer] :maxDurationSeconds Maximum duration of the recording, in seconds. 0 for no limit
  # @option params [Integer] :maxSilenceSeconds Maximum duration of silence, in seconds. 0 for no limit
  # @option params [String] :ifExists ("fail") - Action to take if a recording with the same name already exists.
  # @option params [Boolen] :beep Play beep when recording begins
  # @option params [String] :terminateOn ("none") DTMF input to terminate recording
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  # 409 - Channel is not in a Stasis application; the channel is currently bridged with other hcannels; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
  # 422 - The format specified is unknown on this system
  def channels_record(channel_id, params = {})
    post "channels/#{channel_id}/record", params
  end

  # GET
  # /channels/:channelId/variable
  # Variable
  # Get the value of a channel variable or function.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-getChannelVar
  #
  # @param [String] channel_id channel_id
  # @param [Hash] params
  # @option params [String] :variable *required The channel variable or function to get
  #
  # Error Responses
  #
  # 400 - Missing variable parameter.
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_get_channel_var(channel_id, params = {})
    get "channels/#{channel_id}/variable", params
  end

  # POST
  # /channels/:channelId/variable
  # void
  # Set the value of a channel variable or function.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-setChannelVar
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :variable *required The channel variable or function to set
  # @option params [String] :value The value to set the variable to
  #
  # Error Responses
  #
  # 400 - Missing variable parameter.
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_set_channel_var(channel_id, params = {})
    post "channels/#{channel_id}/variable", params
  end

  # POST
  # /channels/:channelId/snoop
  # Channel
  # Start snooping.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannel
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :spy ("none") Direction of audio to spy on
  # @option params [String] :whisper ("none") Direction of audio to whisper into
  # @option params [String] :app *required Application the snooping channel is placed into
  # @option params [String] :appArgs The application arguments to pass to the Stasis application
  # @option params [String] :snoopId Unique ID to assign to snooping channel
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  def channels_snoop_channel(channel_id, params = {})
    post "channels/#{channel_id}/snoop", params
  end

  # POST
  # /channels/:channelId/snoop/:snoopId
  # Channel
  # Start snooping.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannelWithId
  #
  # @param [String] channel_id Channel's id
  # @param [String] snoop_id Unique ID to assign to snooping channel
  # @param [Hash] params
  # @option param [String] :spy ("none") Direction of audio to spy on
  # @option param [String] :whisper ("none") Direction of audio to whisper into
  # @option param [String] :app *required Application the snooping channel is placed into
  # @option param [String] :appArgs The application arguments to pass to the Stasis application
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  def channels_snoop_channel_with_id(channel_id, snoop_id, params = {})
    post "channels/#{channel_id}/snoop/#{snoop_id}", params
  end

  # Endpoints REST API

  # GET
  # /endpoints
  # List[Endpoint]
  # List all endpoints.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-list
  def endpoints_list
    get "endpoints"
  end

  # PUT
  # /endpoints/sendMessage
  # void
  # Send a message to some technology URI or endpoint.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessage
  #
  # @param [Hash] params
  # @option param [String] to *required The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.
  # @option param [String] from *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
  # @option param [String] body The body of the message
  #
  # Body parameter
  #
  # variables: containers -
  #
  # Error Responses
  #
  # 404 - Endpoint not found
  def endpoints_send_message(params = {})
    put "endpoints/sendMessage", params
  end

  # GET
  # /endpoints/:tech
  # List[Endpoint]
  # List available endoints for a given endpoint technology.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-listByTech
  #
  # @param [String] tech Technology of the endpoints (sip,iax2,...)
  #
  # Error Responses
  #
  # 404 - Endpoints not found
  def endpoints_list_by_tech(tech)
    get "endpoints/#{tech}"
  end

  # GET
  # /endpoints/:tech/:resource
  # Endpoint
  # Details for an endpoint.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-get
  #
  # @param [String] tech Technology of the endpoint
  # @param [String] resource ID of the endpoint
  #
  # Error Responses
  #
  # 400 - Invalid parameters for sending a message.
  # 404 - Endpoints not found
  def endpoints_get(tech, resource)
    get "endpoints/#{tech}/#{resource}"
  end

  # PUT
  # /endpoints/:tech/:resource/sendMessage
  # void
  # Send a message to some endpoint in a technology.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessageToEndpoint
  #
  # @param [String] tech Technology of the endpoint
  # @param [String] resource ID of the endpoint
  # @param [Hash] params
  # @option params [String] :from *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
  # @option params [String] :body The body of the message
  #
  # Body parameter
  #
  # variables: containers -
  #
  # Error Responses
  #
  # 400 - Invalid parameters for sending a message.
  # 404 - Endpoint not found
  def endpoints_send_message_to_endpoint(tech, resource, params = {})
    put "endpoints/#{tech}/#{resource}/sendMessage", params
  end

  # TODO
  # # Events REST API

  # # GET
  # # /events
  # # Message
  # # WebSocket connection for events.
  # #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-eventWebsocket
  # def events_event_websocket
  #   get "events"
  # end

  # POST
  # /events/user/:eventName
  # void
  # Generate a user event.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-userEvent
  #
  # @param [String] event_name event_name
  # @param [Hash] params
  # @option param [String] application #required The name of the application that will receive this event
  # @option param [String] source URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName}. Allows comma separated values.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds custom key/value pairs to add to the user event. Ex. { "variables": { "key": "value" } }
  #
  # Error Responses
  #
  # 404 - Application does not exist.
  # 422 - Event source not found.
  # 400 - Invalid even tsource URI or userevent data.
  def events_user_event(event_name, params = {})
    post "events/user/#{event_name}", params
  end

  # Recordings REST API

  # GET
  # /recordings/stored
  # List[StoredRecording]
  # List recordings that are complete.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-listStored
  def recordings_list_stored
    get "recordings/stored"
  end

  # GET
  #
  # /recordings/stored/:recordingName
  #
  # StoredRecording
  # Get a stored recording's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getStored
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_get_stored(recording_name)
    get "recordings/stored/#{recording_name}"
  end

  # DELETE
  # /recordings/stored/:recordingName
  # void
  # Delete a stored recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-deleteStored
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_delete_stored(recording_name)
    delete "recordings/stored/#{recording_name}"
  end

  # POST
  # /recordings/stored/:recordingName/copy
  # StoredRecording
  # Copy a stored recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-copyStored
  #
  # @param [String] recording_name The name of the recording to copy
  # @param [Hash] params
  # @option params [String] :destinationRecordingName *required The destination name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - A recording with the same name already exists on the system
  def recordings_copy_stored(recording_name, params = {})
    post "recordings/stored/#{recording_name}/copy", params
  end

  # GET
  # /recordings/live/:recordingName
  # LiveRecording
  # List live recordings.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getLive
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_get_live(recording_name)
    get "recordings/live/#{recording_name}"
  end

  # DELETE
  # /recordings/live/:recordingName
  # void
  # Stop a live recording and discard it.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-cancel
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_cancel(recording_name)
    delete "recordings/live/#{recording_name}"
  end

  # POST
  # /recordings/live/:recordingName/stop
  # void
  # Stop a live recording and store it.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-stop
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_stop(recording_name)
    post "recordings/live/#{recording_name}/stop"
  end

  # POST
  # /recordings/live/:recordingName/pause
  # void
  # Pause a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-pause
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_pause(recording_name)
    post "recordings/live/#{recording_name}/pause"
  end

  # DELETE
  # /recordings/live/:recordingName/pause
  # void
  # Unpause a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unpause
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_unpause(recording_name)
    delete "recordings/live/#{recording_name}/pause"
  end

  # POST
  # /recordings/live/:recordingName/mute
  # void
  # Mute a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-mute
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_mute(recording_name)
    post "recordings/live/#{recording_name}/mute"
  end

  # DELETE
  # /recordings/live/:recordingName/mute
  # void
  # Unmute a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unmute
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_unmute(recording_name)
    delete "recordings/live/#{recording_name}/mute"
  end

  # Sounds REST API

  # GET
  # /sounds
  # List[Sound]
  # List all sounds.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-list
  #
  # @param [Hash] params
  # @option param [String] lang Lookup sound for a specific language.
  # @option param [String] format Lookup sound in a specific format.
  def sounds_list(params = {})
    get "sounds", params
  end

  # GET
  # /sounds/:soundId
  # Sound
  # Get a sound's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-get
  #
  # @param [String] sound_id Sound's id
  def sounds_get(sound_id)
    get "sounds/#{sound_id}"
  end

  # Applications REST API

  # GET
  # /applications
  # List[Application]
  # List all applications.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-list
  def applications_list
    get "applications"
  end

  # GET
  # /applications/:applicationName
  # Application
  # Get details of an application.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-get
  #
  # @param [String] application_name Application's name
  #
  # Error Responses
  #
  # 404 - Application does not exist.
  def applications_get(application_name)
    get "applications/#{application_name}"
  end

  # POST
  # /applications/:applicationName/subscription
  # Application
  # Subscribe an application to a event source.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-subscribe
  #
  # @param [String] application_name Application's name
  # @param [Hash] params
  # @option params [String] :eventSource *required URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Missing parameter.
  # 404 - Application does not exist.
  # 422 - Event source does not exist.
  def applications_subscribe(application_name, params = {})
    post "applications/#{application_name}/subscription", params
  end

  # DELETE
  # /applications/:applicationName/subscription
  # Application
  # Unsubscribe an application from an event source.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-unsubscribe
  #
  # @param [String] application_name Application's name
  # @param [Hash] params
  # @option params [String] :eventSource *required URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Missing parameter.
  # 404 - Application does not exist.
  # 409 - Application not subscribed to event source.
  # 422 - Event source does not exist.
  def applications_unsubscribe(application_name, params = {})
    delete "applications/#{application_name}/subscription", params
  end

  # Playbacks REST API

  # GET
  # /playbacks/:playbackId
  # Playback
  # Get a playback's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-get
  #
  # @param [String] playback_id Playback's id
  #
  # Error Responses
  #
  # 404 - The playback cannot be found
  def playbacks_get(playback_id)
    get "playbacks/#{playback_id}"
  end

  # DELETE
  # /playbacks/:playbackId
  # void
  # Stop a playback.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-stop
  #
  # @param [String] playback_id Playback's id
  #
  # Error Responses
  #
  # 404 - The playback cannot be found
  def playbacks_stop(playback_id)
    delete "playbacks/#{playback_id}"
  end

  # POST
  # /playbacks/:playbackId/control
  # void
  # Control a playback.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-control
  #
  # @param [String] playback_id Playback's id
  # @param [Hash] params
  # @option params [String] :operation *required Operation to perform on the playback.
  #
  # Error Responses
  #
  # 400 - The provided operation parameter was invalid
  # 404 - The playback cannot be found
  # 409 - The operation cannot be performed in the playback's current state
  def playbacks_control(playback_id, params = {})
    post "playbacks/#{playback_id}/control", params
  end

  # Devicestates REST API

  # GET
  # /deviceStates
  # List[DeviceState]
  # List all ARI controlled device states.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-list
  def device_states_list
    get "deviceStates"
  end

  # GET
  # /deviceStates/:deviceName
  # DeviceState
  # Retrieve the current state of a device.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-get
  #
  # @param [String] device_name Name of the device
  def device_states_get(device_name)
    get "deviceStates/#{device_name}"
  end

  # PUT
  # /deviceStates/:deviceName
  # void
  # Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-update
  #
  # @param [String] device_name Name of the device
  # @param [Hash] params
  # @option params [String] :deviceState *required Device state value
  #
  # Error Responses
  #
  # 404 - Device name is missing
  # 409 - Uncontrolled device specified
  def device_states_update(device_name, params = {})
    put "deviceStates/#{device_name}", params
  end

  # DELETE
  # /deviceStates/:deviceName
  # void
  # Destroy a device-state controlled by ARI.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-delete
  #
  # @param [String] device_name Name of the device
  #
  # Error Responses
  #
  # 404 - Device name is missing
  # 409 - Uncontrolled device specified
  def device_states_delete(device_name)
    delete "deviceStates/#{device_name}"
  end

  # Mailboxes REST API

  # GET
  # /mailboxes
  # List[Mailbox]
  # List all mailboxes.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-list
  def mailboxes_list
    get "mailboxes"
  end

  # GET
  # /mailboxes/:mailboxName
  # Mailbox
  # Retrieve the current state of a mailbox.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-get
  #
  # @param [String] mailbox_name Name of the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_get(mailbox_name)
    get "mailboxes/#{mailbox_name}"
  end

  # PUT
  # /mailboxes/:mailboxName
  # void
  # Change the state of a mailbox. (Note - implicitly creates the mailbox).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-update
  #
  # @param [String] mailbox_name Name of the mailbox
  # @param [Hash] params
  # @option params [Integer] :oldMessages *required Count of old messages in the mailbox
  # @option params [Integer] :newMessages *required Count of new messages in the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_update(mailbox_name, params = {})
    put "mailboxes/#{mailbox_name}", params
  end

  # DELETE
  # /mailboxes/:mailboxName
  # void
  # Destroy a mailbox.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-delete
  #
  # @param [String] mailbox_name Name of the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_delete(mailbox_name)
    delete "mailboxes/#{mailbox_name}"
  end

  private

    def api_call(path, args = {}, verb = "get", options = {}, &error_checking_block)
      # Setup args for make_request
      path = "/ari/#{path}" unless path =~ /^\//
      path = "/#{@prefix}#{path}" if @prefix

      options.merge!({:host => @host, :port => @port, :username => @username, :password => @password})
      # Make request via the provided service
      result = ARI.make_request path, args, verb, options

      if result.status >= 500
        error_detail = {
          :http_status => result.status.to_i,
          :body        => result.body
        }
        raise ARI::ServerError.new(result.body, error_detail)
      elsif result.status >= 400
        error_detail = {
          :http_status => result.status.to_i,
          :body        => result.body,
          :data        => ARI::JSON.load(result.body)
        }
        raise ARI::APIError.new(result.body, error_detail)
      end

      # Parse the body
      body = if result.headers["Content-Type"] && result.headers["Content-Type"].match("json")
        ARI::JSON.load result.body.to_s
      else
        result.body.to_s
      end
      # Return result
      if options[:http_component]
        result.send options[:http_component]
      else
        body
      end
    end

end

#port ⇒ Integer (readonly)

Returns Port number.

Returns:

• (Integer) —

  Port number

# File 'lib/ari/client.rb', line 15

class Client

  # @param [Hash] options
  # @option options [String] :host ("localhost") Host name
  # @option options [Integer] :port (8088) Port number
  # @option options [String] :prefix Prefix allows you to specify a prefix for all requests to the server.
  # @option options [String] :username username for basic auth
  # @option options [String] :password password for basic auth
  def initialize(options = {})
    @host     = options[:host] || "localhost"
    @port     = options[:port] || 8088
    @prefix   = options[:prefix] if options[:prefix]
    @username = options[:username] if options[:username]
    @password = options[:password] if options[:password]
  end
  attr_reader :host, :port, :prefix, :username, :password

  %w(get post put delete).each do |verb|
    define_method(verb) do |path, params = {}|
      api_call(path, params, verb)
    end
  end

  # Asterisk REST API

  # GET
  # /asterisk/info
  # AsteriskInfo
  # Gets Asterisk system information.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getInfo
  #
  # @param [String] only Filter information returned. Allows comma separated values.
  def asterisk_get_info
    get "asterisk/info"
  end

  # GET
  # /asterisk/variable
  # Variable
  # Get the value of a global variable.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getGlobalVar
  #
  # @param [Hash] params
  # @option params [String] variable *required The variable to get
  #
  # Error Responses
  #
  # return 400 - Missing variable parameter.
  def asterisk_get_global_var(params = {})
    get "asterisk/variable", params
  end

  # POST
  # /asterisk/variable
  # void
  # Set the value of a global variable.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-setGlobalVar
  #
  # @param [Hash] params
  # @option params [String] :variable *required The variable to set
  # @option params [String] :value The value to set the variable to
  #
  # Error Responses
  # 400 - Missing variable parameter.
  def asterisk_set_global_var(params = {})
    post "asterisk/variable", params
  end


  # Bridges REST API
  #

  # GET
  # /bridges
  # List[Bridge]
  # List all active bridges in Asterisk.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-list
  def bridges_list
    get "bridges"
  end

  # POST
  # /bridges
  # Bridge
  # Create a new bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create
  #
  # @param [Hash] params
  # @option params [String] :type Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media).
  # @option params [String] :bridgeId Unique ID to give to the bridge being created.
  # @option params [String] :name Name to give to the bridge being created.
  def bridges_create(params = {})
    post "bridges", params
  end

  # POST
  # /bridges/:bridgeId
  # Bridge
  # Create a new bridge or updates an existing one.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create_or_update_with_id
  #
  # @param [String] bridge_id Unique ID to give to the bridge being created.
  # @param [Hash] params
  # @option params [String] :type Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media) to set.
  # @option params [String] :name Set the name of the bridge.
  def bridges_create_or_update_with_id(bridge_id, params = {})
    post "bridges/#{bridge_id}", params
  end

  # GET
  # /bridges/:bridgeId
  # Bridge
  # Get bridge details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-get
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  def bridges_get(bridge_id)
    get "bridges/#{bridge_id}"
  end

  # DELETE
  # /bridges/:bridgeId
  # void
  # Shut down a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-destroy
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  def bridges_destroy(bridge_id)
    delete "bridges/#{bridge_id}"
  end

  # POST
  # /bridges/:bridgeId/addChannel
  # void
  # Add a channel to a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-addChannel
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :channel *required Ids of channels to add to bridge
  # Allows comma separated values.
  # @option params [String] :role Channel's role in the bridge
  #
  # Error Responses
  #
  # 400 - Channel not found
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application; Channel currently recording
  # 422 - Channel not in Stasis application
  def bridges_add_channel(bridge_id, params = {})
    post "bridges/#{bridge_id}/addChannel", params
  end

  # POST
  # /bridges/:bridgeId/removeChannel
  # void
  # Remove a channel from a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-removeChannel
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :channel *required Ids of channels to remove from bridge. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Channel not found
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  # 422 - Channel not in this bridge
  def bridges_remove_channel(bridge_id, params = {})
    post "bridges/#{bridge_id}/removeChannel", params
  end

  # POST
  # /bridges/:bridgeId/moh
  # void
  # Play music on hold to a bridge or change the MOH class that is playing.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-startMoh
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :mohClass Channel's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  def bridges_start_moh(bridge_id, params = {})
    post "bridges/#{bridge_id}/moh", params
  end

  # DELETE
  # /bridges/:bridgeId/moh
  # void
  # Stop playing music on hold to a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-stopMoh
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  def bridges_stop_moh(bridge_id)
    delete "bridges/#{bridge_id}/moh"
  end

  # POST
  # /bridges/:bridgeId/play
  # Playback
  # Start playback of media on a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-play
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  # @option params [String] :playbackId Playback Id.
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in a Stasis application
  def bridges_play(bridge_id, params = {})
    post "bridges/#{bridge_id}/play", params
  end

  # POST
  # /bridges/:bridgeId/play/:playbackId
  # Playback
  # Start playback of media on a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-playWithId
  #
  # @param [String] bridge_id Bridge's id
  # @param [String] playback_id Playback ID.
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in a Stasis application
  def bridges_play_with_id(bridge_id, playback_id, params = {})
    post "bridges/#{bridge_id}/play/#{playback_id}", params
  end

  # POST
  # /bridges/:bridgeId/record
  # LiveRecording
  # Start a recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-record
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :name *required Recording's filename
  # @option params [String] :format *required Format to encode audio in
  # @option params [Integer] :maxDurationSeconds Maximum duration of the recording, in seconds. 0 for no limit.
  # @option params [Integer] :maxSilenceSeconds Maximum duration of silence, in seconds. 0 for no limit.
  # @option params [String] :ifExists ("fail") Action to take if a recording with the same name already exists.
  # @option params [Boolean] :beep Play beep when recording begins
  # @option params [String] :terminateOn ("none") DTMF input to terminate recording.
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Bridge not found
  # 409 - Bridge is not in a Stasis application; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
  # 422 - The format specified is unknown on this system
  def bridges_record(bridge_id, params = {})
    post "bridges/#{bridge_id}/record", params
  end

  # Channels REST API
  # GET
  # /channels
  # List[Channel]
  # List all active channels in Asterisk.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-list
  #
  def channels_list
    get "channels"
  end

  # POST
  # /channels
  # Channel
  # Create a new channel (originate).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originate
  #
  # @param [Hash] params
  # @option params [String] :endpoint *required Endpoint to call.
  # @option params [String] :extension The extension to dial after the endpoint answers
  # @option params [String] :context The context to dial after the endpoint answers. If omitted, uses 'default'
  # @option params [Long] :priority The priority to dial after the endpoint answers. If omitted, uses 1
  # @option params [String] :app The application that is subscribed to the originated channel, and passed to the Stasis application.
  # @option params [String] :appArgs The application arguments to pass to the Stasis application.
  # @option params [String] :callerId CallerID to use when dialing the endpoint or extension.
  # @option params [Integer] :timeout (30) Timeout (in seconds) before giving up dialing, or -1 for no timeout.
  # @option params [String] :channelId The unique id to assign the channel on creation.
  # @option params [String] :otherChannelId The unique id to assign the second channel when using local channels.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }
  #
  # Error Responses
  #
  # 400 - Invalid parameters for originating a channel.
  def channels_originate(params = {})
    post "channels", params
  end

  # GET
  # /channels/:channelId
  # Channel
  # Channel details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-get
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  def channels_get(channel_id)
    get "channels/#{channel_id}"
  end

  # POST
  # /channels/:channelId
  # Channel
  # Create a new channel (originate with id).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originateWithId
  #
  # @param [String] channel_id The unique id to assign the channel on creation.
  # @param [Hash] params
  # @option params [String] :endpoint *required Endpoint to call.
  # @option params [String] :extension The extension to dial after the endpoint answers
  # @option params [String] :context The context to dial after the endpoint answers. If omitted, uses 'default'
  # @option params [Long] priority The priority to dial after the endpoint answers. If omitted, uses 1
  # @option params [String] :app The application that is subscribed to the originated channel, and passed to the Stasis application.
  # @option params [String] :appArgs The application arguments to pass to the Stasis application.
  # @option params [String] :callerId CallerID to use when dialing the endpoint or extension.
  # @option params [Integer] :timeout (30) Timeout (in seconds) before giving up dialing, or -1 for no timeout.
  # @option params [String] :otherChannelId The unique id to assign the second channel when using local channels.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }
  #
  # Error Responses
  #
  # 400 - Invalid parameters for originating a channel.
  def channels_originate_with_id(channel_id, params = {})
    post "channels/#{channel_id}", params
  end

  # DELETE
  # /channels/:channelId
  # void
  # Delete (i.e. hangup) a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hangup
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :reason Reason for hanging up the channel
  #
  # Error Responses
  #
  # 400 - Invalid reason for hangup provided
  # 404 - Channel not found
  def channels_hangup(channel_id, params = {})
    delete "channels/#{channel_id}", params
  end

  # POST
  # /channels/:channelId/continue
  # void
  # Exit application; continue execution in the dialplan.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-continueInDialplan
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :context The context to continue to.
  # @option params [String] :extension The extension to continue to.
  # @option params [Integer] :priority The priority to continue to.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_continue_in_dialplan(channel_id, params = {})
    post "channels/#{channel_id}/continue", params
  end

  # POST
  # /channels/:channelId/answer
  # void
  # Answer a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-answer
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_answer(channel_id)
    post "channels/#{channel_id}/answer"
  end

  # POST
  # /channels/:channelId/ring
  # void
  # Indicate ringing to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ring
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_ring(channel_id)
    post "channels/#{channel_id}/ring"
  end

  # DELETE
  # /channels/:channelId/ring
  # void
  # Stop ringing indication on a channel if locally generated.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ringStop
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_ring_stop(channel_id)
    delete "channels/#{channel_id}/ring"
  end

  # POST
  # /channels/:channelId/dtmf
  # void
  # Send provided DTMF to a given channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-sendDTMF
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :dtmf DTMF To send.
  # @option params [Integer] :before Amount of time to wait before DTMF digits (specified in milliseconds) start.
  # @option params [Integer] :between (100) Amount of time in between DTMF digits (specified in milliseconds).
  # @option params [Integer] :duration (100) Length of each DTMF digit (specified in milliseconds).
  # @option params [Integer] :after Amount of time to wait after DTMF digits (specified in milliseconds) end.
  #
  # Error Responses
  #
  # 400 - DTMF is required
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_send_dtmf(channel_id, params = {})
    post "channels/#{channel_id}/dtmf", params
  end

  # POST
  # /channels/:channelId/mute
  # void
  # Mute a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-mute
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :direction ("both") Direction in which to mute audio
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_mute(channel_id, params = {})
    post "channels/#{channel_id}/mute", params
  end

  # DELETE
  # /channels/:channelId/mute
  # void
  # Unmute a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unmute
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :direction ("both") Direction in which to unmute audio
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_unmute(channel_id, params = {})
    delete "channels/#{channel_id}/mute", params
  end

  # POST
  # /channels/:channelId/hold
  # void
  # Hold a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hold
  #
  # @param [String] channel_id  Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_hold(channel_id)
    post "channels/#{channel_id}/hold"
  end

  # DELETE
  # /channels/:channelId/hold
  # void
  # Remove a channel from hold.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unhold
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_unhold(channel_id)
    delete "channels/#{channel_id}/hold"
  end

  # POST
  # /channels/:channelId/moh
  # void
  # Play music on hold to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startMoh
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :mohClass Music on hold class to use
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_start_moh(channel_id, params = {})
    post "channels/#{channel_id}/moh", params
  end

  # DELETE
  # /channels/:channelId/moh
  # void
  # Stop playing music on hold to a channel.
  # POST
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopMoh
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_stop_moh(channel_id)
    delete "channels/#{channel_id}/moh"
  end

  # /channels/:channelId/silence
  # void
  # Play silence to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startSilence
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_start_silence(channel_id)
    post "channels/#{channel_id}/silence"
  end

  # DELETE
  # /channels/:channelId/silence
  # void
  # Stop playing silence to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopSilence
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_stop_silence(channel_id)
    delete "channels/#{channel_id}/silence"
  end

  # POST
  # /channels/:channelId/play
  # Playback
  # Start playback of media.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-play
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  # @option params [String] :playbackId Playback ID.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_play(channel_id, params = {})
    post "channels/#{channel_id}/play", params
  end

  # POST
  # /channels/:channelId/play/:playbackId
  # Playback
  # Start playback of media and specify the playbackId.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-playWithId
  #
  # @param [String] channel_id channel_id
  # @param [String] playback_id playback_id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_play_with_id(channel_id, playback_id, params = {})
    post "channels/#{channel_id}/play/#{playback_id}", params
  end

  # POST
  # /channels/:channelId/record
  # LiveRecording
  # Start a recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-record
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :name *required Recording's filename
  # @option params [String] :format *required Format to encode audio in
  # @option params [Integer] :maxDurationSeconds Maximum duration of the recording, in seconds. 0 for no limit
  # @option params [Integer] :maxSilenceSeconds Maximum duration of silence, in seconds. 0 for no limit
  # @option params [String] :ifExists ("fail") - Action to take if a recording with the same name already exists.
  # @option params [Boolen] :beep Play beep when recording begins
  # @option params [String] :terminateOn ("none") DTMF input to terminate recording
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  # 409 - Channel is not in a Stasis application; the channel is currently bridged with other hcannels; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
  # 422 - The format specified is unknown on this system
  def channels_record(channel_id, params = {})
    post "channels/#{channel_id}/record", params
  end

  # GET
  # /channels/:channelId/variable
  # Variable
  # Get the value of a channel variable or function.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-getChannelVar
  #
  # @param [String] channel_id channel_id
  # @param [Hash] params
  # @option params [String] :variable *required The channel variable or function to get
  #
  # Error Responses
  #
  # 400 - Missing variable parameter.
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_get_channel_var(channel_id, params = {})
    get "channels/#{channel_id}/variable", params
  end

  # POST
  # /channels/:channelId/variable
  # void
  # Set the value of a channel variable or function.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-setChannelVar
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :variable *required The channel variable or function to set
  # @option params [String] :value The value to set the variable to
  #
  # Error Responses
  #
  # 400 - Missing variable parameter.
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_set_channel_var(channel_id, params = {})
    post "channels/#{channel_id}/variable", params
  end

  # POST
  # /channels/:channelId/snoop
  # Channel
  # Start snooping.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannel
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :spy ("none") Direction of audio to spy on
  # @option params [String] :whisper ("none") Direction of audio to whisper into
  # @option params [String] :app *required Application the snooping channel is placed into
  # @option params [String] :appArgs The application arguments to pass to the Stasis application
  # @option params [String] :snoopId Unique ID to assign to snooping channel
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  def channels_snoop_channel(channel_id, params = {})
    post "channels/#{channel_id}/snoop", params
  end

  # POST
  # /channels/:channelId/snoop/:snoopId
  # Channel
  # Start snooping.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannelWithId
  #
  # @param [String] channel_id Channel's id
  # @param [String] snoop_id Unique ID to assign to snooping channel
  # @param [Hash] params
  # @option param [String] :spy ("none") Direction of audio to spy on
  # @option param [String] :whisper ("none") Direction of audio to whisper into
  # @option param [String] :app *required Application the snooping channel is placed into
  # @option param [String] :appArgs The application arguments to pass to the Stasis application
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  def channels_snoop_channel_with_id(channel_id, snoop_id, params = {})
    post "channels/#{channel_id}/snoop/#{snoop_id}", params
  end

  # Endpoints REST API

  # GET
  # /endpoints
  # List[Endpoint]
  # List all endpoints.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-list
  def endpoints_list
    get "endpoints"
  end

  # PUT
  # /endpoints/sendMessage
  # void
  # Send a message to some technology URI or endpoint.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessage
  #
  # @param [Hash] params
  # @option param [String] to *required The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.
  # @option param [String] from *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
  # @option param [String] body The body of the message
  #
  # Body parameter
  #
  # variables: containers -
  #
  # Error Responses
  #
  # 404 - Endpoint not found
  def endpoints_send_message(params = {})
    put "endpoints/sendMessage", params
  end

  # GET
  # /endpoints/:tech
  # List[Endpoint]
  # List available endoints for a given endpoint technology.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-listByTech
  #
  # @param [String] tech Technology of the endpoints (sip,iax2,...)
  #
  # Error Responses
  #
  # 404 - Endpoints not found
  def endpoints_list_by_tech(tech)
    get "endpoints/#{tech}"
  end

  # GET
  # /endpoints/:tech/:resource
  # Endpoint
  # Details for an endpoint.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-get
  #
  # @param [String] tech Technology of the endpoint
  # @param [String] resource ID of the endpoint
  #
  # Error Responses
  #
  # 400 - Invalid parameters for sending a message.
  # 404 - Endpoints not found
  def endpoints_get(tech, resource)
    get "endpoints/#{tech}/#{resource}"
  end

  # PUT
  # /endpoints/:tech/:resource/sendMessage
  # void
  # Send a message to some endpoint in a technology.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessageToEndpoint
  #
  # @param [String] tech Technology of the endpoint
  # @param [String] resource ID of the endpoint
  # @param [Hash] params
  # @option params [String] :from *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
  # @option params [String] :body The body of the message
  #
  # Body parameter
  #
  # variables: containers -
  #
  # Error Responses
  #
  # 400 - Invalid parameters for sending a message.
  # 404 - Endpoint not found
  def endpoints_send_message_to_endpoint(tech, resource, params = {})
    put "endpoints/#{tech}/#{resource}/sendMessage", params
  end

  # TODO
  # # Events REST API

  # # GET
  # # /events
  # # Message
  # # WebSocket connection for events.
  # #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-eventWebsocket
  # def events_event_websocket
  #   get "events"
  # end

  # POST
  # /events/user/:eventName
  # void
  # Generate a user event.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-userEvent
  #
  # @param [String] event_name event_name
  # @param [Hash] params
  # @option param [String] application #required The name of the application that will receive this event
  # @option param [String] source URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName}. Allows comma separated values.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds custom key/value pairs to add to the user event. Ex. { "variables": { "key": "value" } }
  #
  # Error Responses
  #
  # 404 - Application does not exist.
  # 422 - Event source not found.
  # 400 - Invalid even tsource URI or userevent data.
  def events_user_event(event_name, params = {})
    post "events/user/#{event_name}", params
  end

  # Recordings REST API

  # GET
  # /recordings/stored
  # List[StoredRecording]
  # List recordings that are complete.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-listStored
  def recordings_list_stored
    get "recordings/stored"
  end

  # GET
  #
  # /recordings/stored/:recordingName
  #
  # StoredRecording
  # Get a stored recording's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getStored
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_get_stored(recording_name)
    get "recordings/stored/#{recording_name}"
  end

  # DELETE
  # /recordings/stored/:recordingName
  # void
  # Delete a stored recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-deleteStored
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_delete_stored(recording_name)
    delete "recordings/stored/#{recording_name}"
  end

  # POST
  # /recordings/stored/:recordingName/copy
  # StoredRecording
  # Copy a stored recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-copyStored
  #
  # @param [String] recording_name The name of the recording to copy
  # @param [Hash] params
  # @option params [String] :destinationRecordingName *required The destination name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - A recording with the same name already exists on the system
  def recordings_copy_stored(recording_name, params = {})
    post "recordings/stored/#{recording_name}/copy", params
  end

  # GET
  # /recordings/live/:recordingName
  # LiveRecording
  # List live recordings.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getLive
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_get_live(recording_name)
    get "recordings/live/#{recording_name}"
  end

  # DELETE
  # /recordings/live/:recordingName
  # void
  # Stop a live recording and discard it.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-cancel
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_cancel(recording_name)
    delete "recordings/live/#{recording_name}"
  end

  # POST
  # /recordings/live/:recordingName/stop
  # void
  # Stop a live recording and store it.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-stop
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_stop(recording_name)
    post "recordings/live/#{recording_name}/stop"
  end

  # POST
  # /recordings/live/:recordingName/pause
  # void
  # Pause a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-pause
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_pause(recording_name)
    post "recordings/live/#{recording_name}/pause"
  end

  # DELETE
  # /recordings/live/:recordingName/pause
  # void
  # Unpause a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unpause
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_unpause(recording_name)
    delete "recordings/live/#{recording_name}/pause"
  end

  # POST
  # /recordings/live/:recordingName/mute
  # void
  # Mute a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-mute
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_mute(recording_name)
    post "recordings/live/#{recording_name}/mute"
  end

  # DELETE
  # /recordings/live/:recordingName/mute
  # void
  # Unmute a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unmute
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_unmute(recording_name)
    delete "recordings/live/#{recording_name}/mute"
  end

  # Sounds REST API

  # GET
  # /sounds
  # List[Sound]
  # List all sounds.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-list
  #
  # @param [Hash] params
  # @option param [String] lang Lookup sound for a specific language.
  # @option param [String] format Lookup sound in a specific format.
  def sounds_list(params = {})
    get "sounds", params
  end

  # GET
  # /sounds/:soundId
  # Sound
  # Get a sound's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-get
  #
  # @param [String] sound_id Sound's id
  def sounds_get(sound_id)
    get "sounds/#{sound_id}"
  end

  # Applications REST API

  # GET
  # /applications
  # List[Application]
  # List all applications.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-list
  def applications_list
    get "applications"
  end

  # GET
  # /applications/:applicationName
  # Application
  # Get details of an application.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-get
  #
  # @param [String] application_name Application's name
  #
  # Error Responses
  #
  # 404 - Application does not exist.
  def applications_get(application_name)
    get "applications/#{application_name}"
  end

  # POST
  # /applications/:applicationName/subscription
  # Application
  # Subscribe an application to a event source.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-subscribe
  #
  # @param [String] application_name Application's name
  # @param [Hash] params
  # @option params [String] :eventSource *required URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Missing parameter.
  # 404 - Application does not exist.
  # 422 - Event source does not exist.
  def applications_subscribe(application_name, params = {})
    post "applications/#{application_name}/subscription", params
  end

  # DELETE
  # /applications/:applicationName/subscription
  # Application
  # Unsubscribe an application from an event source.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-unsubscribe
  #
  # @param [String] application_name Application's name
  # @param [Hash] params
  # @option params [String] :eventSource *required URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Missing parameter.
  # 404 - Application does not exist.
  # 409 - Application not subscribed to event source.
  # 422 - Event source does not exist.
  def applications_unsubscribe(application_name, params = {})
    delete "applications/#{application_name}/subscription", params
  end

  # Playbacks REST API

  # GET
  # /playbacks/:playbackId
  # Playback
  # Get a playback's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-get
  #
  # @param [String] playback_id Playback's id
  #
  # Error Responses
  #
  # 404 - The playback cannot be found
  def playbacks_get(playback_id)
    get "playbacks/#{playback_id}"
  end

  # DELETE
  # /playbacks/:playbackId
  # void
  # Stop a playback.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-stop
  #
  # @param [String] playback_id Playback's id
  #
  # Error Responses
  #
  # 404 - The playback cannot be found
  def playbacks_stop(playback_id)
    delete "playbacks/#{playback_id}"
  end

  # POST
  # /playbacks/:playbackId/control
  # void
  # Control a playback.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-control
  #
  # @param [String] playback_id Playback's id
  # @param [Hash] params
  # @option params [String] :operation *required Operation to perform on the playback.
  #
  # Error Responses
  #
  # 400 - The provided operation parameter was invalid
  # 404 - The playback cannot be found
  # 409 - The operation cannot be performed in the playback's current state
  def playbacks_control(playback_id, params = {})
    post "playbacks/#{playback_id}/control", params
  end

  # Devicestates REST API

  # GET
  # /deviceStates
  # List[DeviceState]
  # List all ARI controlled device states.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-list
  def device_states_list
    get "deviceStates"
  end

  # GET
  # /deviceStates/:deviceName
  # DeviceState
  # Retrieve the current state of a device.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-get
  #
  # @param [String] device_name Name of the device
  def device_states_get(device_name)
    get "deviceStates/#{device_name}"
  end

  # PUT
  # /deviceStates/:deviceName
  # void
  # Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-update
  #
  # @param [String] device_name Name of the device
  # @param [Hash] params
  # @option params [String] :deviceState *required Device state value
  #
  # Error Responses
  #
  # 404 - Device name is missing
  # 409 - Uncontrolled device specified
  def device_states_update(device_name, params = {})
    put "deviceStates/#{device_name}", params
  end

  # DELETE
  # /deviceStates/:deviceName
  # void
  # Destroy a device-state controlled by ARI.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-delete
  #
  # @param [String] device_name Name of the device
  #
  # Error Responses
  #
  # 404 - Device name is missing
  # 409 - Uncontrolled device specified
  def device_states_delete(device_name)
    delete "deviceStates/#{device_name}"
  end

  # Mailboxes REST API

  # GET
  # /mailboxes
  # List[Mailbox]
  # List all mailboxes.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-list
  def mailboxes_list
    get "mailboxes"
  end

  # GET
  # /mailboxes/:mailboxName
  # Mailbox
  # Retrieve the current state of a mailbox.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-get
  #
  # @param [String] mailbox_name Name of the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_get(mailbox_name)
    get "mailboxes/#{mailbox_name}"
  end

  # PUT
  # /mailboxes/:mailboxName
  # void
  # Change the state of a mailbox. (Note - implicitly creates the mailbox).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-update
  #
  # @param [String] mailbox_name Name of the mailbox
  # @param [Hash] params
  # @option params [Integer] :oldMessages *required Count of old messages in the mailbox
  # @option params [Integer] :newMessages *required Count of new messages in the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_update(mailbox_name, params = {})
    put "mailboxes/#{mailbox_name}", params
  end

  # DELETE
  # /mailboxes/:mailboxName
  # void
  # Destroy a mailbox.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-delete
  #
  # @param [String] mailbox_name Name of the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_delete(mailbox_name)
    delete "mailboxes/#{mailbox_name}"
  end

  private

    def api_call(path, args = {}, verb = "get", options = {}, &error_checking_block)
      # Setup args for make_request
      path = "/ari/#{path}" unless path =~ /^\//
      path = "/#{@prefix}#{path}" if @prefix

      options.merge!({:host => @host, :port => @port, :username => @username, :password => @password})
      # Make request via the provided service
      result = ARI.make_request path, args, verb, options

      if result.status >= 500
        error_detail = {
          :http_status => result.status.to_i,
          :body        => result.body
        }
        raise ARI::ServerError.new(result.body, error_detail)
      elsif result.status >= 400
        error_detail = {
          :http_status => result.status.to_i,
          :body        => result.body,
          :data        => ARI::JSON.load(result.body)
        }
        raise ARI::APIError.new(result.body, error_detail)
      end

      # Parse the body
      body = if result.headers["Content-Type"] && result.headers["Content-Type"].match("json")
        ARI::JSON.load result.body.to_s
      else
        result.body.to_s
      end
      # Return result
      if options[:http_component]
        result.send options[:http_component]
      else
        body
      end
    end

end

#prefix ⇒ String (readonly)

Returns Prefix allows you to specify a prefix for all requests to the server.

Returns:

• (String) —

  Prefix allows you to specify a prefix for all requests to the server.

# File 'lib/ari/client.rb', line 15

class Client

  # @param [Hash] options
  # @option options [String] :host ("localhost") Host name
  # @option options [Integer] :port (8088) Port number
  # @option options [String] :prefix Prefix allows you to specify a prefix for all requests to the server.
  # @option options [String] :username username for basic auth
  # @option options [String] :password password for basic auth
  def initialize(options = {})
    @host     = options[:host] || "localhost"
    @port     = options[:port] || 8088
    @prefix   = options[:prefix] if options[:prefix]
    @username = options[:username] if options[:username]
    @password = options[:password] if options[:password]
  end
  attr_reader :host, :port, :prefix, :username, :password

  %w(get post put delete).each do |verb|
    define_method(verb) do |path, params = {}|
      api_call(path, params, verb)
    end
  end

  # Asterisk REST API

  # GET
  # /asterisk/info
  # AsteriskInfo
  # Gets Asterisk system information.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getInfo
  #
  # @param [String] only Filter information returned. Allows comma separated values.
  def asterisk_get_info
    get "asterisk/info"
  end

  # GET
  # /asterisk/variable
  # Variable
  # Get the value of a global variable.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getGlobalVar
  #
  # @param [Hash] params
  # @option params [String] variable *required The variable to get
  #
  # Error Responses
  #
  # return 400 - Missing variable parameter.
  def asterisk_get_global_var(params = {})
    get "asterisk/variable", params
  end

  # POST
  # /asterisk/variable
  # void
  # Set the value of a global variable.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-setGlobalVar
  #
  # @param [Hash] params
  # @option params [String] :variable *required The variable to set
  # @option params [String] :value The value to set the variable to
  #
  # Error Responses
  # 400 - Missing variable parameter.
  def asterisk_set_global_var(params = {})
    post "asterisk/variable", params
  end


  # Bridges REST API
  #

  # GET
  # /bridges
  # List[Bridge]
  # List all active bridges in Asterisk.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-list
  def bridges_list
    get "bridges"
  end

  # POST
  # /bridges
  # Bridge
  # Create a new bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create
  #
  # @param [Hash] params
  # @option params [String] :type Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media).
  # @option params [String] :bridgeId Unique ID to give to the bridge being created.
  # @option params [String] :name Name to give to the bridge being created.
  def bridges_create(params = {})
    post "bridges", params
  end

  # POST
  # /bridges/:bridgeId
  # Bridge
  # Create a new bridge or updates an existing one.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create_or_update_with_id
  #
  # @param [String] bridge_id Unique ID to give to the bridge being created.
  # @param [Hash] params
  # @option params [String] :type Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media) to set.
  # @option params [String] :name Set the name of the bridge.
  def bridges_create_or_update_with_id(bridge_id, params = {})
    post "bridges/#{bridge_id}", params
  end

  # GET
  # /bridges/:bridgeId
  # Bridge
  # Get bridge details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-get
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  def bridges_get(bridge_id)
    get "bridges/#{bridge_id}"
  end

  # DELETE
  # /bridges/:bridgeId
  # void
  # Shut down a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-destroy
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  def bridges_destroy(bridge_id)
    delete "bridges/#{bridge_id}"
  end

  # POST
  # /bridges/:bridgeId/addChannel
  # void
  # Add a channel to a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-addChannel
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :channel *required Ids of channels to add to bridge
  # Allows comma separated values.
  # @option params [String] :role Channel's role in the bridge
  #
  # Error Responses
  #
  # 400 - Channel not found
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application; Channel currently recording
  # 422 - Channel not in Stasis application
  def bridges_add_channel(bridge_id, params = {})
    post "bridges/#{bridge_id}/addChannel", params
  end

  # POST
  # /bridges/:bridgeId/removeChannel
  # void
  # Remove a channel from a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-removeChannel
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :channel *required Ids of channels to remove from bridge. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Channel not found
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  # 422 - Channel not in this bridge
  def bridges_remove_channel(bridge_id, params = {})
    post "bridges/#{bridge_id}/removeChannel", params
  end

  # POST
  # /bridges/:bridgeId/moh
  # void
  # Play music on hold to a bridge or change the MOH class that is playing.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-startMoh
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :mohClass Channel's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  def bridges_start_moh(bridge_id, params = {})
    post "bridges/#{bridge_id}/moh", params
  end

  # DELETE
  # /bridges/:bridgeId/moh
  # void
  # Stop playing music on hold to a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-stopMoh
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  def bridges_stop_moh(bridge_id)
    delete "bridges/#{bridge_id}/moh"
  end

  # POST
  # /bridges/:bridgeId/play
  # Playback
  # Start playback of media on a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-play
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  # @option params [String] :playbackId Playback Id.
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in a Stasis application
  def bridges_play(bridge_id, params = {})
    post "bridges/#{bridge_id}/play", params
  end

  # POST
  # /bridges/:bridgeId/play/:playbackId
  # Playback
  # Start playback of media on a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-playWithId
  #
  # @param [String] bridge_id Bridge's id
  # @param [String] playback_id Playback ID.
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in a Stasis application
  def bridges_play_with_id(bridge_id, playback_id, params = {})
    post "bridges/#{bridge_id}/play/#{playback_id}", params
  end

  # POST
  # /bridges/:bridgeId/record
  # LiveRecording
  # Start a recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-record
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :name *required Recording's filename
  # @option params [String] :format *required Format to encode audio in
  # @option params [Integer] :maxDurationSeconds Maximum duration of the recording, in seconds. 0 for no limit.
  # @option params [Integer] :maxSilenceSeconds Maximum duration of silence, in seconds. 0 for no limit.
  # @option params [String] :ifExists ("fail") Action to take if a recording with the same name already exists.
  # @option params [Boolean] :beep Play beep when recording begins
  # @option params [String] :terminateOn ("none") DTMF input to terminate recording.
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Bridge not found
  # 409 - Bridge is not in a Stasis application; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
  # 422 - The format specified is unknown on this system
  def bridges_record(bridge_id, params = {})
    post "bridges/#{bridge_id}/record", params
  end

  # Channels REST API
  # GET
  # /channels
  # List[Channel]
  # List all active channels in Asterisk.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-list
  #
  def channels_list
    get "channels"
  end

  # POST
  # /channels
  # Channel
  # Create a new channel (originate).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originate
  #
  # @param [Hash] params
  # @option params [String] :endpoint *required Endpoint to call.
  # @option params [String] :extension The extension to dial after the endpoint answers
  # @option params [String] :context The context to dial after the endpoint answers. If omitted, uses 'default'
  # @option params [Long] :priority The priority to dial after the endpoint answers. If omitted, uses 1
  # @option params [String] :app The application that is subscribed to the originated channel, and passed to the Stasis application.
  # @option params [String] :appArgs The application arguments to pass to the Stasis application.
  # @option params [String] :callerId CallerID to use when dialing the endpoint or extension.
  # @option params [Integer] :timeout (30) Timeout (in seconds) before giving up dialing, or -1 for no timeout.
  # @option params [String] :channelId The unique id to assign the channel on creation.
  # @option params [String] :otherChannelId The unique id to assign the second channel when using local channels.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }
  #
  # Error Responses
  #
  # 400 - Invalid parameters for originating a channel.
  def channels_originate(params = {})
    post "channels", params
  end

  # GET
  # /channels/:channelId
  # Channel
  # Channel details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-get
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  def channels_get(channel_id)
    get "channels/#{channel_id}"
  end

  # POST
  # /channels/:channelId
  # Channel
  # Create a new channel (originate with id).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originateWithId
  #
  # @param [String] channel_id The unique id to assign the channel on creation.
  # @param [Hash] params
  # @option params [String] :endpoint *required Endpoint to call.
  # @option params [String] :extension The extension to dial after the endpoint answers
  # @option params [String] :context The context to dial after the endpoint answers. If omitted, uses 'default'
  # @option params [Long] priority The priority to dial after the endpoint answers. If omitted, uses 1
  # @option params [String] :app The application that is subscribed to the originated channel, and passed to the Stasis application.
  # @option params [String] :appArgs The application arguments to pass to the Stasis application.
  # @option params [String] :callerId CallerID to use when dialing the endpoint or extension.
  # @option params [Integer] :timeout (30) Timeout (in seconds) before giving up dialing, or -1 for no timeout.
  # @option params [String] :otherChannelId The unique id to assign the second channel when using local channels.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }
  #
  # Error Responses
  #
  # 400 - Invalid parameters for originating a channel.
  def channels_originate_with_id(channel_id, params = {})
    post "channels/#{channel_id}", params
  end

  # DELETE
  # /channels/:channelId
  # void
  # Delete (i.e. hangup) a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hangup
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :reason Reason for hanging up the channel
  #
  # Error Responses
  #
  # 400 - Invalid reason for hangup provided
  # 404 - Channel not found
  def channels_hangup(channel_id, params = {})
    delete "channels/#{channel_id}", params
  end

  # POST
  # /channels/:channelId/continue
  # void
  # Exit application; continue execution in the dialplan.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-continueInDialplan
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :context The context to continue to.
  # @option params [String] :extension The extension to continue to.
  # @option params [Integer] :priority The priority to continue to.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_continue_in_dialplan(channel_id, params = {})
    post "channels/#{channel_id}/continue", params
  end

  # POST
  # /channels/:channelId/answer
  # void
  # Answer a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-answer
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_answer(channel_id)
    post "channels/#{channel_id}/answer"
  end

  # POST
  # /channels/:channelId/ring
  # void
  # Indicate ringing to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ring
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_ring(channel_id)
    post "channels/#{channel_id}/ring"
  end

  # DELETE
  # /channels/:channelId/ring
  # void
  # Stop ringing indication on a channel if locally generated.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ringStop
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_ring_stop(channel_id)
    delete "channels/#{channel_id}/ring"
  end

  # POST
  # /channels/:channelId/dtmf
  # void
  # Send provided DTMF to a given channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-sendDTMF
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :dtmf DTMF To send.
  # @option params [Integer] :before Amount of time to wait before DTMF digits (specified in milliseconds) start.
  # @option params [Integer] :between (100) Amount of time in between DTMF digits (specified in milliseconds).
  # @option params [Integer] :duration (100) Length of each DTMF digit (specified in milliseconds).
  # @option params [Integer] :after Amount of time to wait after DTMF digits (specified in milliseconds) end.
  #
  # Error Responses
  #
  # 400 - DTMF is required
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_send_dtmf(channel_id, params = {})
    post "channels/#{channel_id}/dtmf", params
  end

  # POST
  # /channels/:channelId/mute
  # void
  # Mute a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-mute
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :direction ("both") Direction in which to mute audio
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_mute(channel_id, params = {})
    post "channels/#{channel_id}/mute", params
  end

  # DELETE
  # /channels/:channelId/mute
  # void
  # Unmute a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unmute
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :direction ("both") Direction in which to unmute audio
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_unmute(channel_id, params = {})
    delete "channels/#{channel_id}/mute", params
  end

  # POST
  # /channels/:channelId/hold
  # void
  # Hold a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hold
  #
  # @param [String] channel_id  Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_hold(channel_id)
    post "channels/#{channel_id}/hold"
  end

  # DELETE
  # /channels/:channelId/hold
  # void
  # Remove a channel from hold.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unhold
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_unhold(channel_id)
    delete "channels/#{channel_id}/hold"
  end

  # POST
  # /channels/:channelId/moh
  # void
  # Play music on hold to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startMoh
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :mohClass Music on hold class to use
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_start_moh(channel_id, params = {})
    post "channels/#{channel_id}/moh", params
  end

  # DELETE
  # /channels/:channelId/moh
  # void
  # Stop playing music on hold to a channel.
  # POST
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopMoh
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_stop_moh(channel_id)
    delete "channels/#{channel_id}/moh"
  end

  # /channels/:channelId/silence
  # void
  # Play silence to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startSilence
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_start_silence(channel_id)
    post "channels/#{channel_id}/silence"
  end

  # DELETE
  # /channels/:channelId/silence
  # void
  # Stop playing silence to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopSilence
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_stop_silence(channel_id)
    delete "channels/#{channel_id}/silence"
  end

  # POST
  # /channels/:channelId/play
  # Playback
  # Start playback of media.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-play
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  # @option params [String] :playbackId Playback ID.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_play(channel_id, params = {})
    post "channels/#{channel_id}/play", params
  end

  # POST
  # /channels/:channelId/play/:playbackId
  # Playback
  # Start playback of media and specify the playbackId.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-playWithId
  #
  # @param [String] channel_id channel_id
  # @param [String] playback_id playback_id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_play_with_id(channel_id, playback_id, params = {})
    post "channels/#{channel_id}/play/#{playback_id}", params
  end

  # POST
  # /channels/:channelId/record
  # LiveRecording
  # Start a recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-record
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :name *required Recording's filename
  # @option params [String] :format *required Format to encode audio in
  # @option params [Integer] :maxDurationSeconds Maximum duration of the recording, in seconds. 0 for no limit
  # @option params [Integer] :maxSilenceSeconds Maximum duration of silence, in seconds. 0 for no limit
  # @option params [String] :ifExists ("fail") - Action to take if a recording with the same name already exists.
  # @option params [Boolen] :beep Play beep when recording begins
  # @option params [String] :terminateOn ("none") DTMF input to terminate recording
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  # 409 - Channel is not in a Stasis application; the channel is currently bridged with other hcannels; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
  # 422 - The format specified is unknown on this system
  def channels_record(channel_id, params = {})
    post "channels/#{channel_id}/record", params
  end

  # GET
  # /channels/:channelId/variable
  # Variable
  # Get the value of a channel variable or function.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-getChannelVar
  #
  # @param [String] channel_id channel_id
  # @param [Hash] params
  # @option params [String] :variable *required The channel variable or function to get
  #
  # Error Responses
  #
  # 400 - Missing variable parameter.
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_get_channel_var(channel_id, params = {})
    get "channels/#{channel_id}/variable", params
  end

  # POST
  # /channels/:channelId/variable
  # void
  # Set the value of a channel variable or function.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-setChannelVar
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :variable *required The channel variable or function to set
  # @option params [String] :value The value to set the variable to
  #
  # Error Responses
  #
  # 400 - Missing variable parameter.
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_set_channel_var(channel_id, params = {})
    post "channels/#{channel_id}/variable", params
  end

  # POST
  # /channels/:channelId/snoop
  # Channel
  # Start snooping.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannel
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :spy ("none") Direction of audio to spy on
  # @option params [String] :whisper ("none") Direction of audio to whisper into
  # @option params [String] :app *required Application the snooping channel is placed into
  # @option params [String] :appArgs The application arguments to pass to the Stasis application
  # @option params [String] :snoopId Unique ID to assign to snooping channel
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  def channels_snoop_channel(channel_id, params = {})
    post "channels/#{channel_id}/snoop", params
  end

  # POST
  # /channels/:channelId/snoop/:snoopId
  # Channel
  # Start snooping.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannelWithId
  #
  # @param [String] channel_id Channel's id
  # @param [String] snoop_id Unique ID to assign to snooping channel
  # @param [Hash] params
  # @option param [String] :spy ("none") Direction of audio to spy on
  # @option param [String] :whisper ("none") Direction of audio to whisper into
  # @option param [String] :app *required Application the snooping channel is placed into
  # @option param [String] :appArgs The application arguments to pass to the Stasis application
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  def channels_snoop_channel_with_id(channel_id, snoop_id, params = {})
    post "channels/#{channel_id}/snoop/#{snoop_id}", params
  end

  # Endpoints REST API

  # GET
  # /endpoints
  # List[Endpoint]
  # List all endpoints.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-list
  def endpoints_list
    get "endpoints"
  end

  # PUT
  # /endpoints/sendMessage
  # void
  # Send a message to some technology URI or endpoint.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessage
  #
  # @param [Hash] params
  # @option param [String] to *required The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.
  # @option param [String] from *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
  # @option param [String] body The body of the message
  #
  # Body parameter
  #
  # variables: containers -
  #
  # Error Responses
  #
  # 404 - Endpoint not found
  def endpoints_send_message(params = {})
    put "endpoints/sendMessage", params
  end

  # GET
  # /endpoints/:tech
  # List[Endpoint]
  # List available endoints for a given endpoint technology.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-listByTech
  #
  # @param [String] tech Technology of the endpoints (sip,iax2,...)
  #
  # Error Responses
  #
  # 404 - Endpoints not found
  def endpoints_list_by_tech(tech)
    get "endpoints/#{tech}"
  end

  # GET
  # /endpoints/:tech/:resource
  # Endpoint
  # Details for an endpoint.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-get
  #
  # @param [String] tech Technology of the endpoint
  # @param [String] resource ID of the endpoint
  #
  # Error Responses
  #
  # 400 - Invalid parameters for sending a message.
  # 404 - Endpoints not found
  def endpoints_get(tech, resource)
    get "endpoints/#{tech}/#{resource}"
  end

  # PUT
  # /endpoints/:tech/:resource/sendMessage
  # void
  # Send a message to some endpoint in a technology.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessageToEndpoint
  #
  # @param [String] tech Technology of the endpoint
  # @param [String] resource ID of the endpoint
  # @param [Hash] params
  # @option params [String] :from *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
  # @option params [String] :body The body of the message
  #
  # Body parameter
  #
  # variables: containers -
  #
  # Error Responses
  #
  # 400 - Invalid parameters for sending a message.
  # 404 - Endpoint not found
  def endpoints_send_message_to_endpoint(tech, resource, params = {})
    put "endpoints/#{tech}/#{resource}/sendMessage", params
  end

  # TODO
  # # Events REST API

  # # GET
  # # /events
  # # Message
  # # WebSocket connection for events.
  # #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-eventWebsocket
  # def events_event_websocket
  #   get "events"
  # end

  # POST
  # /events/user/:eventName
  # void
  # Generate a user event.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-userEvent
  #
  # @param [String] event_name event_name
  # @param [Hash] params
  # @option param [String] application #required The name of the application that will receive this event
  # @option param [String] source URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName}. Allows comma separated values.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds custom key/value pairs to add to the user event. Ex. { "variables": { "key": "value" } }
  #
  # Error Responses
  #
  # 404 - Application does not exist.
  # 422 - Event source not found.
  # 400 - Invalid even tsource URI or userevent data.
  def events_user_event(event_name, params = {})
    post "events/user/#{event_name}", params
  end

  # Recordings REST API

  # GET
  # /recordings/stored
  # List[StoredRecording]
  # List recordings that are complete.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-listStored
  def recordings_list_stored
    get "recordings/stored"
  end

  # GET
  #
  # /recordings/stored/:recordingName
  #
  # StoredRecording
  # Get a stored recording's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getStored
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_get_stored(recording_name)
    get "recordings/stored/#{recording_name}"
  end

  # DELETE
  # /recordings/stored/:recordingName
  # void
  # Delete a stored recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-deleteStored
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_delete_stored(recording_name)
    delete "recordings/stored/#{recording_name}"
  end

  # POST
  # /recordings/stored/:recordingName/copy
  # StoredRecording
  # Copy a stored recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-copyStored
  #
  # @param [String] recording_name The name of the recording to copy
  # @param [Hash] params
  # @option params [String] :destinationRecordingName *required The destination name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - A recording with the same name already exists on the system
  def recordings_copy_stored(recording_name, params = {})
    post "recordings/stored/#{recording_name}/copy", params
  end

  # GET
  # /recordings/live/:recordingName
  # LiveRecording
  # List live recordings.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getLive
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_get_live(recording_name)
    get "recordings/live/#{recording_name}"
  end

  # DELETE
  # /recordings/live/:recordingName
  # void
  # Stop a live recording and discard it.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-cancel
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_cancel(recording_name)
    delete "recordings/live/#{recording_name}"
  end

  # POST
  # /recordings/live/:recordingName/stop
  # void
  # Stop a live recording and store it.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-stop
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_stop(recording_name)
    post "recordings/live/#{recording_name}/stop"
  end

  # POST
  # /recordings/live/:recordingName/pause
  # void
  # Pause a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-pause
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_pause(recording_name)
    post "recordings/live/#{recording_name}/pause"
  end

  # DELETE
  # /recordings/live/:recordingName/pause
  # void
  # Unpause a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unpause
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_unpause(recording_name)
    delete "recordings/live/#{recording_name}/pause"
  end

  # POST
  # /recordings/live/:recordingName/mute
  # void
  # Mute a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-mute
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_mute(recording_name)
    post "recordings/live/#{recording_name}/mute"
  end

  # DELETE
  # /recordings/live/:recordingName/mute
  # void
  # Unmute a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unmute
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_unmute(recording_name)
    delete "recordings/live/#{recording_name}/mute"
  end

  # Sounds REST API

  # GET
  # /sounds
  # List[Sound]
  # List all sounds.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-list
  #
  # @param [Hash] params
  # @option param [String] lang Lookup sound for a specific language.
  # @option param [String] format Lookup sound in a specific format.
  def sounds_list(params = {})
    get "sounds", params
  end

  # GET
  # /sounds/:soundId
  # Sound
  # Get a sound's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-get
  #
  # @param [String] sound_id Sound's id
  def sounds_get(sound_id)
    get "sounds/#{sound_id}"
  end

  # Applications REST API

  # GET
  # /applications
  # List[Application]
  # List all applications.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-list
  def applications_list
    get "applications"
  end

  # GET
  # /applications/:applicationName
  # Application
  # Get details of an application.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-get
  #
  # @param [String] application_name Application's name
  #
  # Error Responses
  #
  # 404 - Application does not exist.
  def applications_get(application_name)
    get "applications/#{application_name}"
  end

  # POST
  # /applications/:applicationName/subscription
  # Application
  # Subscribe an application to a event source.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-subscribe
  #
  # @param [String] application_name Application's name
  # @param [Hash] params
  # @option params [String] :eventSource *required URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Missing parameter.
  # 404 - Application does not exist.
  # 422 - Event source does not exist.
  def applications_subscribe(application_name, params = {})
    post "applications/#{application_name}/subscription", params
  end

  # DELETE
  # /applications/:applicationName/subscription
  # Application
  # Unsubscribe an application from an event source.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-unsubscribe
  #
  # @param [String] application_name Application's name
  # @param [Hash] params
  # @option params [String] :eventSource *required URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Missing parameter.
  # 404 - Application does not exist.
  # 409 - Application not subscribed to event source.
  # 422 - Event source does not exist.
  def applications_unsubscribe(application_name, params = {})
    delete "applications/#{application_name}/subscription", params
  end

  # Playbacks REST API

  # GET
  # /playbacks/:playbackId
  # Playback
  # Get a playback's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-get
  #
  # @param [String] playback_id Playback's id
  #
  # Error Responses
  #
  # 404 - The playback cannot be found
  def playbacks_get(playback_id)
    get "playbacks/#{playback_id}"
  end

  # DELETE
  # /playbacks/:playbackId
  # void
  # Stop a playback.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-stop
  #
  # @param [String] playback_id Playback's id
  #
  # Error Responses
  #
  # 404 - The playback cannot be found
  def playbacks_stop(playback_id)
    delete "playbacks/#{playback_id}"
  end

  # POST
  # /playbacks/:playbackId/control
  # void
  # Control a playback.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-control
  #
  # @param [String] playback_id Playback's id
  # @param [Hash] params
  # @option params [String] :operation *required Operation to perform on the playback.
  #
  # Error Responses
  #
  # 400 - The provided operation parameter was invalid
  # 404 - The playback cannot be found
  # 409 - The operation cannot be performed in the playback's current state
  def playbacks_control(playback_id, params = {})
    post "playbacks/#{playback_id}/control", params
  end

  # Devicestates REST API

  # GET
  # /deviceStates
  # List[DeviceState]
  # List all ARI controlled device states.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-list
  def device_states_list
    get "deviceStates"
  end

  # GET
  # /deviceStates/:deviceName
  # DeviceState
  # Retrieve the current state of a device.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-get
  #
  # @param [String] device_name Name of the device
  def device_states_get(device_name)
    get "deviceStates/#{device_name}"
  end

  # PUT
  # /deviceStates/:deviceName
  # void
  # Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-update
  #
  # @param [String] device_name Name of the device
  # @param [Hash] params
  # @option params [String] :deviceState *required Device state value
  #
  # Error Responses
  #
  # 404 - Device name is missing
  # 409 - Uncontrolled device specified
  def device_states_update(device_name, params = {})
    put "deviceStates/#{device_name}", params
  end

  # DELETE
  # /deviceStates/:deviceName
  # void
  # Destroy a device-state controlled by ARI.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-delete
  #
  # @param [String] device_name Name of the device
  #
  # Error Responses
  #
  # 404 - Device name is missing
  # 409 - Uncontrolled device specified
  def device_states_delete(device_name)
    delete "deviceStates/#{device_name}"
  end

  # Mailboxes REST API

  # GET
  # /mailboxes
  # List[Mailbox]
  # List all mailboxes.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-list
  def mailboxes_list
    get "mailboxes"
  end

  # GET
  # /mailboxes/:mailboxName
  # Mailbox
  # Retrieve the current state of a mailbox.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-get
  #
  # @param [String] mailbox_name Name of the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_get(mailbox_name)
    get "mailboxes/#{mailbox_name}"
  end

  # PUT
  # /mailboxes/:mailboxName
  # void
  # Change the state of a mailbox. (Note - implicitly creates the mailbox).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-update
  #
  # @param [String] mailbox_name Name of the mailbox
  # @param [Hash] params
  # @option params [Integer] :oldMessages *required Count of old messages in the mailbox
  # @option params [Integer] :newMessages *required Count of new messages in the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_update(mailbox_name, params = {})
    put "mailboxes/#{mailbox_name}", params
  end

  # DELETE
  # /mailboxes/:mailboxName
  # void
  # Destroy a mailbox.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-delete
  #
  # @param [String] mailbox_name Name of the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_delete(mailbox_name)
    delete "mailboxes/#{mailbox_name}"
  end

  private

    def api_call(path, args = {}, verb = "get", options = {}, &error_checking_block)
      # Setup args for make_request
      path = "/ari/#{path}" unless path =~ /^\//
      path = "/#{@prefix}#{path}" if @prefix

      options.merge!({:host => @host, :port => @port, :username => @username, :password => @password})
      # Make request via the provided service
      result = ARI.make_request path, args, verb, options

      if result.status >= 500
        error_detail = {
          :http_status => result.status.to_i,
          :body        => result.body
        }
        raise ARI::ServerError.new(result.body, error_detail)
      elsif result.status >= 400
        error_detail = {
          :http_status => result.status.to_i,
          :body        => result.body,
          :data        => ARI::JSON.load(result.body)
        }
        raise ARI::APIError.new(result.body, error_detail)
      end

      # Parse the body
      body = if result.headers["Content-Type"] && result.headers["Content-Type"].match("json")
        ARI::JSON.load result.body.to_s
      else
        result.body.to_s
      end
      # Return result
      if options[:http_component]
        result.send options[:http_component]
      else
        body
      end
    end

end

#username ⇒ String (readonly)

Returns username for basic auth.

Returns:

• (String) —

  username for basic auth

# File 'lib/ari/client.rb', line 15

class Client

  # @param [Hash] options
  # @option options [String] :host ("localhost") Host name
  # @option options [Integer] :port (8088) Port number
  # @option options [String] :prefix Prefix allows you to specify a prefix for all requests to the server.
  # @option options [String] :username username for basic auth
  # @option options [String] :password password for basic auth
  def initialize(options = {})
    @host     = options[:host] || "localhost"
    @port     = options[:port] || 8088
    @prefix   = options[:prefix] if options[:prefix]
    @username = options[:username] if options[:username]
    @password = options[:password] if options[:password]
  end
  attr_reader :host, :port, :prefix, :username, :password

  %w(get post put delete).each do |verb|
    define_method(verb) do |path, params = {}|
      api_call(path, params, verb)
    end
  end

  # Asterisk REST API

  # GET
  # /asterisk/info
  # AsteriskInfo
  # Gets Asterisk system information.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getInfo
  #
  # @param [String] only Filter information returned. Allows comma separated values.
  def asterisk_get_info
    get "asterisk/info"
  end

  # GET
  # /asterisk/variable
  # Variable
  # Get the value of a global variable.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getGlobalVar
  #
  # @param [Hash] params
  # @option params [String] variable *required The variable to get
  #
  # Error Responses
  #
  # return 400 - Missing variable parameter.
  def asterisk_get_global_var(params = {})
    get "asterisk/variable", params
  end

  # POST
  # /asterisk/variable
  # void
  # Set the value of a global variable.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-setGlobalVar
  #
  # @param [Hash] params
  # @option params [String] :variable *required The variable to set
  # @option params [String] :value The value to set the variable to
  #
  # Error Responses
  # 400 - Missing variable parameter.
  def asterisk_set_global_var(params = {})
    post "asterisk/variable", params
  end


  # Bridges REST API
  #

  # GET
  # /bridges
  # List[Bridge]
  # List all active bridges in Asterisk.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-list
  def bridges_list
    get "bridges"
  end

  # POST
  # /bridges
  # Bridge
  # Create a new bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create
  #
  # @param [Hash] params
  # @option params [String] :type Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media).
  # @option params [String] :bridgeId Unique ID to give to the bridge being created.
  # @option params [String] :name Name to give to the bridge being created.
  def bridges_create(params = {})
    post "bridges", params
  end

  # POST
  # /bridges/:bridgeId
  # Bridge
  # Create a new bridge or updates an existing one.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create_or_update_with_id
  #
  # @param [String] bridge_id Unique ID to give to the bridge being created.
  # @param [Hash] params
  # @option params [String] :type Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media) to set.
  # @option params [String] :name Set the name of the bridge.
  def bridges_create_or_update_with_id(bridge_id, params = {})
    post "bridges/#{bridge_id}", params
  end

  # GET
  # /bridges/:bridgeId
  # Bridge
  # Get bridge details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-get
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  def bridges_get(bridge_id)
    get "bridges/#{bridge_id}"
  end

  # DELETE
  # /bridges/:bridgeId
  # void
  # Shut down a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-destroy
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  def bridges_destroy(bridge_id)
    delete "bridges/#{bridge_id}"
  end

  # POST
  # /bridges/:bridgeId/addChannel
  # void
  # Add a channel to a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-addChannel
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :channel *required Ids of channels to add to bridge
  # Allows comma separated values.
  # @option params [String] :role Channel's role in the bridge
  #
  # Error Responses
  #
  # 400 - Channel not found
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application; Channel currently recording
  # 422 - Channel not in Stasis application
  def bridges_add_channel(bridge_id, params = {})
    post "bridges/#{bridge_id}/addChannel", params
  end

  # POST
  # /bridges/:bridgeId/removeChannel
  # void
  # Remove a channel from a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-removeChannel
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :channel *required Ids of channels to remove from bridge. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Channel not found
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  # 422 - Channel not in this bridge
  def bridges_remove_channel(bridge_id, params = {})
    post "bridges/#{bridge_id}/removeChannel", params
  end

  # POST
  # /bridges/:bridgeId/moh
  # void
  # Play music on hold to a bridge or change the MOH class that is playing.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-startMoh
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :mohClass Channel's id
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  def bridges_start_moh(bridge_id, params = {})
    post "bridges/#{bridge_id}/moh", params
  end

  # DELETE
  # /bridges/:bridgeId/moh
  # void
  # Stop playing music on hold to a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-stopMoh
  #
  # @param [String] bridge_id Bridge's id
  #
  # Error Responses
  # 404 - Bridge not found
  # 409 - Bridge not in Stasis application
  def bridges_stop_moh(bridge_id)
    delete "bridges/#{bridge_id}/moh"
  end

  # POST
  # /bridges/:bridgeId/play
  # Playback
  # Start playback of media on a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-play
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  # @option params [String] :playbackId Playback Id.
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in a Stasis application
  def bridges_play(bridge_id, params = {})
    post "bridges/#{bridge_id}/play", params
  end

  # POST
  # /bridges/:bridgeId/play/:playbackId
  # Playback
  # Start playback of media on a bridge.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-playWithId
  #
  # @param [String] bridge_id Bridge's id
  # @param [String] playback_id Playback ID.
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  #
  # Error Responses
  #
  # 404 - Bridge not found
  # 409 - Bridge not in a Stasis application
  def bridges_play_with_id(bridge_id, playback_id, params = {})
    post "bridges/#{bridge_id}/play/#{playback_id}", params
  end

  # POST
  # /bridges/:bridgeId/record
  # LiveRecording
  # Start a recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-record
  #
  # @param [String] bridge_id Bridge's id
  # @param [Hash] params
  # @option params [String] :name *required Recording's filename
  # @option params [String] :format *required Format to encode audio in
  # @option params [Integer] :maxDurationSeconds Maximum duration of the recording, in seconds. 0 for no limit.
  # @option params [Integer] :maxSilenceSeconds Maximum duration of silence, in seconds. 0 for no limit.
  # @option params [String] :ifExists ("fail") Action to take if a recording with the same name already exists.
  # @option params [Boolean] :beep Play beep when recording begins
  # @option params [String] :terminateOn ("none") DTMF input to terminate recording.
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Bridge not found
  # 409 - Bridge is not in a Stasis application; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
  # 422 - The format specified is unknown on this system
  def bridges_record(bridge_id, params = {})
    post "bridges/#{bridge_id}/record", params
  end

  # Channels REST API
  # GET
  # /channels
  # List[Channel]
  # List all active channels in Asterisk.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-list
  #
  def channels_list
    get "channels"
  end

  # POST
  # /channels
  # Channel
  # Create a new channel (originate).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originate
  #
  # @param [Hash] params
  # @option params [String] :endpoint *required Endpoint to call.
  # @option params [String] :extension The extension to dial after the endpoint answers
  # @option params [String] :context The context to dial after the endpoint answers. If omitted, uses 'default'
  # @option params [Long] :priority The priority to dial after the endpoint answers. If omitted, uses 1
  # @option params [String] :app The application that is subscribed to the originated channel, and passed to the Stasis application.
  # @option params [String] :appArgs The application arguments to pass to the Stasis application.
  # @option params [String] :callerId CallerID to use when dialing the endpoint or extension.
  # @option params [Integer] :timeout (30) Timeout (in seconds) before giving up dialing, or -1 for no timeout.
  # @option params [String] :channelId The unique id to assign the channel on creation.
  # @option params [String] :otherChannelId The unique id to assign the second channel when using local channels.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }
  #
  # Error Responses
  #
  # 400 - Invalid parameters for originating a channel.
  def channels_originate(params = {})
    post "channels", params
  end

  # GET
  # /channels/:channelId
  # Channel
  # Channel details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-get
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  def channels_get(channel_id)
    get "channels/#{channel_id}"
  end

  # POST
  # /channels/:channelId
  # Channel
  # Create a new channel (originate with id).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originateWithId
  #
  # @param [String] channel_id The unique id to assign the channel on creation.
  # @param [Hash] params
  # @option params [String] :endpoint *required Endpoint to call.
  # @option params [String] :extension The extension to dial after the endpoint answers
  # @option params [String] :context The context to dial after the endpoint answers. If omitted, uses 'default'
  # @option params [Long] priority The priority to dial after the endpoint answers. If omitted, uses 1
  # @option params [String] :app The application that is subscribed to the originated channel, and passed to the Stasis application.
  # @option params [String] :appArgs The application arguments to pass to the Stasis application.
  # @option params [String] :callerId CallerID to use when dialing the endpoint or extension.
  # @option params [Integer] :timeout (30) Timeout (in seconds) before giving up dialing, or -1 for no timeout.
  # @option params [String] :otherChannelId The unique id to assign the second channel when using local channels.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }
  #
  # Error Responses
  #
  # 400 - Invalid parameters for originating a channel.
  def channels_originate_with_id(channel_id, params = {})
    post "channels/#{channel_id}", params
  end

  # DELETE
  # /channels/:channelId
  # void
  # Delete (i.e. hangup) a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hangup
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :reason Reason for hanging up the channel
  #
  # Error Responses
  #
  # 400 - Invalid reason for hangup provided
  # 404 - Channel not found
  def channels_hangup(channel_id, params = {})
    delete "channels/#{channel_id}", params
  end

  # POST
  # /channels/:channelId/continue
  # void
  # Exit application; continue execution in the dialplan.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-continueInDialplan
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :context The context to continue to.
  # @option params [String] :extension The extension to continue to.
  # @option params [Integer] :priority The priority to continue to.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_continue_in_dialplan(channel_id, params = {})
    post "channels/#{channel_id}/continue", params
  end

  # POST
  # /channels/:channelId/answer
  # void
  # Answer a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-answer
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_answer(channel_id)
    post "channels/#{channel_id}/answer"
  end

  # POST
  # /channels/:channelId/ring
  # void
  # Indicate ringing to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ring
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_ring(channel_id)
    post "channels/#{channel_id}/ring"
  end

  # DELETE
  # /channels/:channelId/ring
  # void
  # Stop ringing indication on a channel if locally generated.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ringStop
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_ring_stop(channel_id)
    delete "channels/#{channel_id}/ring"
  end

  # POST
  # /channels/:channelId/dtmf
  # void
  # Send provided DTMF to a given channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-sendDTMF
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :dtmf DTMF To send.
  # @option params [Integer] :before Amount of time to wait before DTMF digits (specified in milliseconds) start.
  # @option params [Integer] :between (100) Amount of time in between DTMF digits (specified in milliseconds).
  # @option params [Integer] :duration (100) Length of each DTMF digit (specified in milliseconds).
  # @option params [Integer] :after Amount of time to wait after DTMF digits (specified in milliseconds) end.
  #
  # Error Responses
  #
  # 400 - DTMF is required
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_send_dtmf(channel_id, params = {})
    post "channels/#{channel_id}/dtmf", params
  end

  # POST
  # /channels/:channelId/mute
  # void
  # Mute a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-mute
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :direction ("both") Direction in which to mute audio
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_mute(channel_id, params = {})
    post "channels/#{channel_id}/mute", params
  end

  # DELETE
  # /channels/:channelId/mute
  # void
  # Unmute a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unmute
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :direction ("both") Direction in which to unmute audio
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_unmute(channel_id, params = {})
    delete "channels/#{channel_id}/mute", params
  end

  # POST
  # /channels/:channelId/hold
  # void
  # Hold a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hold
  #
  # @param [String] channel_id  Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_hold(channel_id)
    post "channels/#{channel_id}/hold"
  end

  # DELETE
  # /channels/:channelId/hold
  # void
  # Remove a channel from hold.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unhold
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_unhold(channel_id)
    delete "channels/#{channel_id}/hold"
  end

  # POST
  # /channels/:channelId/moh
  # void
  # Play music on hold to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startMoh
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :mohClass Music on hold class to use
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_start_moh(channel_id, params = {})
    post "channels/#{channel_id}/moh", params
  end

  # DELETE
  # /channels/:channelId/moh
  # void
  # Stop playing music on hold to a channel.
  # POST
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopMoh
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_stop_moh(channel_id)
    delete "channels/#{channel_id}/moh"
  end

  # /channels/:channelId/silence
  # void
  # Play silence to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startSilence
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_start_silence(channel_id)
    post "channels/#{channel_id}/silence"
  end

  # DELETE
  # /channels/:channelId/silence
  # void
  # Stop playing silence to a channel.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopSilence
  #
  # @param [String] channel_id Channel's id
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_stop_silence(channel_id)
    delete "channels/#{channel_id}/silence"
  end

  # POST
  # /channels/:channelId/play
  # Playback
  # Start playback of media.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-play
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  # @option params [String] :playbackId Playback ID.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_play(channel_id, params = {})
    post "channels/#{channel_id}/play", params
  end

  # POST
  # /channels/:channelId/play/:playbackId
  # Playback
  # Start playback of media and specify the playbackId.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-playWithId
  #
  # @param [String] channel_id channel_id
  # @param [String] playback_id playback_id
  # @param [Hash] params
  # @option params [String] :media *required Media's URI to play.
  # @option params [String] :lang For sounds, selects language for sound.
  # @option params [Integer] :offsetms Number of media to skip before playing.
  # @option params [Integer] :skipms (3000) Number of milliseconds to skip for forward/reverse operations.
  #
  # Error Responses
  #
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_play_with_id(channel_id, playback_id, params = {})
    post "channels/#{channel_id}/play/#{playback_id}", params
  end

  # POST
  # /channels/:channelId/record
  # LiveRecording
  # Start a recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-record
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :name *required Recording's filename
  # @option params [String] :format *required Format to encode audio in
  # @option params [Integer] :maxDurationSeconds Maximum duration of the recording, in seconds. 0 for no limit
  # @option params [Integer] :maxSilenceSeconds Maximum duration of silence, in seconds. 0 for no limit
  # @option params [String] :ifExists ("fail") - Action to take if a recording with the same name already exists.
  # @option params [Boolen] :beep Play beep when recording begins
  # @option params [String] :terminateOn ("none") DTMF input to terminate recording
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  # 409 - Channel is not in a Stasis application; the channel is currently bridged with other hcannels; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail
  # 422 - The format specified is unknown on this system
  def channels_record(channel_id, params = {})
    post "channels/#{channel_id}/record", params
  end

  # GET
  # /channels/:channelId/variable
  # Variable
  # Get the value of a channel variable or function.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-getChannelVar
  #
  # @param [String] channel_id channel_id
  # @param [Hash] params
  # @option params [String] :variable *required The channel variable or function to get
  #
  # Error Responses
  #
  # 400 - Missing variable parameter.
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_get_channel_var(channel_id, params = {})
    get "channels/#{channel_id}/variable", params
  end

  # POST
  # /channels/:channelId/variable
  # void
  # Set the value of a channel variable or function.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-setChannelVar
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :variable *required The channel variable or function to set
  # @option params [String] :value The value to set the variable to
  #
  # Error Responses
  #
  # 400 - Missing variable parameter.
  # 404 - Channel not found
  # 409 - Channel not in a Stasis application
  def channels_set_channel_var(channel_id, params = {})
    post "channels/#{channel_id}/variable", params
  end

  # POST
  # /channels/:channelId/snoop
  # Channel
  # Start snooping.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannel
  #
  # @param [String] channel_id Channel's id
  # @param [Hash] params
  # @option params [String] :spy ("none") Direction of audio to spy on
  # @option params [String] :whisper ("none") Direction of audio to whisper into
  # @option params [String] :app *required Application the snooping channel is placed into
  # @option params [String] :appArgs The application arguments to pass to the Stasis application
  # @option params [String] :snoopId Unique ID to assign to snooping channel
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  def channels_snoop_channel(channel_id, params = {})
    post "channels/#{channel_id}/snoop", params
  end

  # POST
  # /channels/:channelId/snoop/:snoopId
  # Channel
  # Start snooping.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannelWithId
  #
  # @param [String] channel_id Channel's id
  # @param [String] snoop_id Unique ID to assign to snooping channel
  # @param [Hash] params
  # @option param [String] :spy ("none") Direction of audio to spy on
  # @option param [String] :whisper ("none") Direction of audio to whisper into
  # @option param [String] :app *required Application the snooping channel is placed into
  # @option param [String] :appArgs The application arguments to pass to the Stasis application
  #
  # Error Responses
  #
  # 400 - Invalid parameters
  # 404 - Channel not found
  def channels_snoop_channel_with_id(channel_id, snoop_id, params = {})
    post "channels/#{channel_id}/snoop/#{snoop_id}", params
  end

  # Endpoints REST API

  # GET
  # /endpoints
  # List[Endpoint]
  # List all endpoints.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-list
  def endpoints_list
    get "endpoints"
  end

  # PUT
  # /endpoints/sendMessage
  # void
  # Send a message to some technology URI or endpoint.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessage
  #
  # @param [Hash] params
  # @option param [String] to *required The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.
  # @option param [String] from *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
  # @option param [String] body The body of the message
  #
  # Body parameter
  #
  # variables: containers -
  #
  # Error Responses
  #
  # 404 - Endpoint not found
  def endpoints_send_message(params = {})
    put "endpoints/sendMessage", params
  end

  # GET
  # /endpoints/:tech
  # List[Endpoint]
  # List available endoints for a given endpoint technology.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-listByTech
  #
  # @param [String] tech Technology of the endpoints (sip,iax2,...)
  #
  # Error Responses
  #
  # 404 - Endpoints not found
  def endpoints_list_by_tech(tech)
    get "endpoints/#{tech}"
  end

  # GET
  # /endpoints/:tech/:resource
  # Endpoint
  # Details for an endpoint.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-get
  #
  # @param [String] tech Technology of the endpoint
  # @param [String] resource ID of the endpoint
  #
  # Error Responses
  #
  # 400 - Invalid parameters for sending a message.
  # 404 - Endpoints not found
  def endpoints_get(tech, resource)
    get "endpoints/#{tech}/#{resource}"
  end

  # PUT
  # /endpoints/:tech/:resource/sendMessage
  # void
  # Send a message to some endpoint in a technology.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessageToEndpoint
  #
  # @param [String] tech Technology of the endpoint
  # @param [String] resource ID of the endpoint
  # @param [Hash] params
  # @option params [String] :from *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
  # @option params [String] :body The body of the message
  #
  # Body parameter
  #
  # variables: containers -
  #
  # Error Responses
  #
  # 400 - Invalid parameters for sending a message.
  # 404 - Endpoint not found
  def endpoints_send_message_to_endpoint(tech, resource, params = {})
    put "endpoints/#{tech}/#{resource}/sendMessage", params
  end

  # TODO
  # # Events REST API

  # # GET
  # # /events
  # # Message
  # # WebSocket connection for events.
  # #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-eventWebsocket
  # def events_event_websocket
  #   get "events"
  # end

  # POST
  # /events/user/:eventName
  # void
  # Generate a user event.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-userEvent
  #
  # @param [String] event_name event_name
  # @param [Hash] params
  # @option param [String] application #required The name of the application that will receive this event
  # @option param [String] source URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName}. Allows comma separated values.
  #
  # Body parameter
  #
  # variables: containers - The "variables" key in the body object holds custom key/value pairs to add to the user event. Ex. { "variables": { "key": "value" } }
  #
  # Error Responses
  #
  # 404 - Application does not exist.
  # 422 - Event source not found.
  # 400 - Invalid even tsource URI or userevent data.
  def events_user_event(event_name, params = {})
    post "events/user/#{event_name}", params
  end

  # Recordings REST API

  # GET
  # /recordings/stored
  # List[StoredRecording]
  # List recordings that are complete.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-listStored
  def recordings_list_stored
    get "recordings/stored"
  end

  # GET
  #
  # /recordings/stored/:recordingName
  #
  # StoredRecording
  # Get a stored recording's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getStored
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_get_stored(recording_name)
    get "recordings/stored/#{recording_name}"
  end

  # DELETE
  # /recordings/stored/:recordingName
  # void
  # Delete a stored recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-deleteStored
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_delete_stored(recording_name)
    delete "recordings/stored/#{recording_name}"
  end

  # POST
  # /recordings/stored/:recordingName/copy
  # StoredRecording
  # Copy a stored recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-copyStored
  #
  # @param [String] recording_name The name of the recording to copy
  # @param [Hash] params
  # @option params [String] :destinationRecordingName *required The destination name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - A recording with the same name already exists on the system
  def recordings_copy_stored(recording_name, params = {})
    post "recordings/stored/#{recording_name}/copy", params
  end

  # GET
  # /recordings/live/:recordingName
  # LiveRecording
  # List live recordings.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getLive
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_get_live(recording_name)
    get "recordings/live/#{recording_name}"
  end

  # DELETE
  # /recordings/live/:recordingName
  # void
  # Stop a live recording and discard it.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-cancel
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_cancel(recording_name)
    delete "recordings/live/#{recording_name}"
  end

  # POST
  # /recordings/live/:recordingName/stop
  # void
  # Stop a live recording and store it.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-stop
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  def recordings_stop(recording_name)
    post "recordings/live/#{recording_name}/stop"
  end

  # POST
  # /recordings/live/:recordingName/pause
  # void
  # Pause a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-pause
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_pause(recording_name)
    post "recordings/live/#{recording_name}/pause"
  end

  # DELETE
  # /recordings/live/:recordingName/pause
  # void
  # Unpause a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unpause
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_unpause(recording_name)
    delete "recordings/live/#{recording_name}/pause"
  end

  # POST
  # /recordings/live/:recordingName/mute
  # void
  # Mute a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-mute
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_mute(recording_name)
    post "recordings/live/#{recording_name}/mute"
  end

  # DELETE
  # /recordings/live/:recordingName/mute
  # void
  # Unmute a live recording.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unmute
  #
  # @param [String] recording_name The name of the recording
  #
  # Error Responses
  #
  # 404 - Recording not found
  # 409 - Recording not in session
  def recordings_unmute(recording_name)
    delete "recordings/live/#{recording_name}/mute"
  end

  # Sounds REST API

  # GET
  # /sounds
  # List[Sound]
  # List all sounds.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-list
  #
  # @param [Hash] params
  # @option param [String] lang Lookup sound for a specific language.
  # @option param [String] format Lookup sound in a specific format.
  def sounds_list(params = {})
    get "sounds", params
  end

  # GET
  # /sounds/:soundId
  # Sound
  # Get a sound's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-get
  #
  # @param [String] sound_id Sound's id
  def sounds_get(sound_id)
    get "sounds/#{sound_id}"
  end

  # Applications REST API

  # GET
  # /applications
  # List[Application]
  # List all applications.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-list
  def applications_list
    get "applications"
  end

  # GET
  # /applications/:applicationName
  # Application
  # Get details of an application.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-get
  #
  # @param [String] application_name Application's name
  #
  # Error Responses
  #
  # 404 - Application does not exist.
  def applications_get(application_name)
    get "applications/#{application_name}"
  end

  # POST
  # /applications/:applicationName/subscription
  # Application
  # Subscribe an application to a event source.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-subscribe
  #
  # @param [String] application_name Application's name
  # @param [Hash] params
  # @option params [String] :eventSource *required URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Missing parameter.
  # 404 - Application does not exist.
  # 422 - Event source does not exist.
  def applications_subscribe(application_name, params = {})
    post "applications/#{application_name}/subscription", params
  end

  # DELETE
  # /applications/:applicationName/subscription
  # Application
  # Unsubscribe an application from an event source.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-unsubscribe
  #
  # @param [String] application_name Application's name
  # @param [Hash] params
  # @option params [String] :eventSource *required URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}[/{resource}], deviceState:{deviceName}. Allows comma separated values.
  #
  # Error Responses
  #
  # 400 - Missing parameter.
  # 404 - Application does not exist.
  # 409 - Application not subscribed to event source.
  # 422 - Event source does not exist.
  def applications_unsubscribe(application_name, params = {})
    delete "applications/#{application_name}/subscription", params
  end

  # Playbacks REST API

  # GET
  # /playbacks/:playbackId
  # Playback
  # Get a playback's details.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-get
  #
  # @param [String] playback_id Playback's id
  #
  # Error Responses
  #
  # 404 - The playback cannot be found
  def playbacks_get(playback_id)
    get "playbacks/#{playback_id}"
  end

  # DELETE
  # /playbacks/:playbackId
  # void
  # Stop a playback.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-stop
  #
  # @param [String] playback_id Playback's id
  #
  # Error Responses
  #
  # 404 - The playback cannot be found
  def playbacks_stop(playback_id)
    delete "playbacks/#{playback_id}"
  end

  # POST
  # /playbacks/:playbackId/control
  # void
  # Control a playback.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-control
  #
  # @param [String] playback_id Playback's id
  # @param [Hash] params
  # @option params [String] :operation *required Operation to perform on the playback.
  #
  # Error Responses
  #
  # 400 - The provided operation parameter was invalid
  # 404 - The playback cannot be found
  # 409 - The operation cannot be performed in the playback's current state
  def playbacks_control(playback_id, params = {})
    post "playbacks/#{playback_id}/control", params
  end

  # Devicestates REST API

  # GET
  # /deviceStates
  # List[DeviceState]
  # List all ARI controlled device states.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-list
  def device_states_list
    get "deviceStates"
  end

  # GET
  # /deviceStates/:deviceName
  # DeviceState
  # Retrieve the current state of a device.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-get
  #
  # @param [String] device_name Name of the device
  def device_states_get(device_name)
    get "deviceStates/#{device_name}"
  end

  # PUT
  # /deviceStates/:deviceName
  # void
  # Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-update
  #
  # @param [String] device_name Name of the device
  # @param [Hash] params
  # @option params [String] :deviceState *required Device state value
  #
  # Error Responses
  #
  # 404 - Device name is missing
  # 409 - Uncontrolled device specified
  def device_states_update(device_name, params = {})
    put "deviceStates/#{device_name}", params
  end

  # DELETE
  # /deviceStates/:deviceName
  # void
  # Destroy a device-state controlled by ARI.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-delete
  #
  # @param [String] device_name Name of the device
  #
  # Error Responses
  #
  # 404 - Device name is missing
  # 409 - Uncontrolled device specified
  def device_states_delete(device_name)
    delete "deviceStates/#{device_name}"
  end

  # Mailboxes REST API

  # GET
  # /mailboxes
  # List[Mailbox]
  # List all mailboxes.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-list
  def mailboxes_list
    get "mailboxes"
  end

  # GET
  # /mailboxes/:mailboxName
  # Mailbox
  # Retrieve the current state of a mailbox.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-get
  #
  # @param [String] mailbox_name Name of the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_get(mailbox_name)
    get "mailboxes/#{mailbox_name}"
  end

  # PUT
  # /mailboxes/:mailboxName
  # void
  # Change the state of a mailbox. (Note - implicitly creates the mailbox).
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-update
  #
  # @param [String] mailbox_name Name of the mailbox
  # @param [Hash] params
  # @option params [Integer] :oldMessages *required Count of old messages in the mailbox
  # @option params [Integer] :newMessages *required Count of new messages in the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_update(mailbox_name, params = {})
    put "mailboxes/#{mailbox_name}", params
  end

  # DELETE
  # /mailboxes/:mailboxName
  # void
  # Destroy a mailbox.
  #
  # @see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-delete
  #
  # @param [String] mailbox_name Name of the mailbox
  #
  # Error Responses
  #
  # 404 - Mailbox not found
  def mailboxes_delete(mailbox_name)
    delete "mailboxes/#{mailbox_name}"
  end

  private

    def api_call(path, args = {}, verb = "get", options = {}, &error_checking_block)
      # Setup args for make_request
      path = "/ari/#{path}" unless path =~ /^\//
      path = "/#{@prefix}#{path}" if @prefix

      options.merge!({:host => @host, :port => @port, :username => @username, :password => @password})
      # Make request via the provided service
      result = ARI.make_request path, args, verb, options

      if result.status >= 500
        error_detail = {
          :http_status => result.status.to_i,
          :body        => result.body
        }
        raise ARI::ServerError.new(result.body, error_detail)
      elsif result.status >= 400
        error_detail = {
          :http_status => result.status.to_i,
          :body        => result.body,
          :data        => ARI::JSON.load(result.body)
        }
        raise ARI::APIError.new(result.body, error_detail)
      end

      # Parse the body
      body = if result.headers["Content-Type"] && result.headers["Content-Type"].match("json")
        ARI::JSON.load result.body.to_s
      else
        result.body.to_s
      end
      # Return result
      if options[:http_component]
        result.send options[:http_component]
      else
        body
      end
    end

end

Instance Method Details

#applications_get(application_name) ⇒ Object

GET /applications/:applicationName Application Get details of an application.

Error Responses

404 - Application does not exist.

Parameters:

• application_name (String) —

  Application’s name

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-get

# File 'lib/ari/client.rb', line 1184

def applications_get(application_name)
  get "applications/#{application_name}"
end

#applications_list ⇒ Object

GET /applications List List all applications.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-list

# File 'lib/ari/client.rb', line 1168

def applications_list
  get "applications"
end

#applications_subscribe(application_name, params = {}) ⇒ Object

POST /applications/:applicationName/subscription Application Subscribe an application to a event source.

Error Responses

400 - Missing parameter. 404 - Application does not exist. 422 - Event source does not exist.

Parameters:

• application_name (String) —

  Application’s name

• params (Hash) (defaults to: {})

Options Hash (params):

• :eventSource (String) —

  *required URI for event source (channel:channelId}, bridge:bridgeId, endpoint:deviceState:{deviceName. Allows comma separated values.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-subscribe

# File 'lib/ari/client.rb', line 1204

def applications_subscribe(application_name, params = {})
  post "applications/#{application_name}/subscription", params
end

#applications_unsubscribe(application_name, params = {}) ⇒ Object

DELETE /applications/:applicationName/subscription Application Unsubscribe an application from an event source.

Error Responses

400 - Missing parameter. 404 - Application does not exist. 409 - Application not subscribed to event source. 422 - Event source does not exist.

Parameters:

• application_name (String) —

  Application’s name

• params (Hash) (defaults to: {})

Options Hash (params):

• :eventSource (String) —

  *required URI for event source (channel:channelId}, bridge:bridgeId, endpoint:deviceState:{deviceName. Allows comma separated values.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Applications+REST+API#Asterisk12ApplicationsRESTAPI-unsubscribe

# File 'lib/ari/client.rb', line 1225

def applications_unsubscribe(application_name, params = {})
  delete "applications/#{application_name}/subscription", params
end

#asterisk_get_global_var(params = {}) ⇒ Object

GET /asterisk/variable Variable Get the value of a global variable.

Error Responses

return 400 - Missing variable parameter.

Parameters:

• params (Hash) (defaults to: {})

Options Hash (params):

• variable (String) —

  *required The variable to get

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getGlobalVar

# File 'lib/ari/client.rb', line 65

def asterisk_get_global_var(params = {})
  get "asterisk/variable", params
end

#asterisk_get_info ⇒ Object

GET /asterisk/info AsteriskInfo Gets Asterisk system information.

Parameters:

• only (String) —

  Filter information returned. Allows comma separated values.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-getInfo

# File 'lib/ari/client.rb', line 48

def asterisk_get_info
  get "asterisk/info"
end

#asterisk_set_global_var(params = {}) ⇒ Object

POST /asterisk/variable void Set the value of a global variable.

Error Responses 400 - Missing variable parameter.

Parameters:

• params (Hash) (defaults to: {})

Options Hash (params):

• :variable (String) —

  *required The variable to set

• :value (String) —

  The value to set the variable to

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Asterisk+REST+API#Asterisk12AsteriskRESTAPI-setGlobalVar

# File 'lib/ari/client.rb', line 82

def asterisk_set_global_var(params = {})
  post "asterisk/variable", params
end

#bridges_add_channel(bridge_id, params = {}) ⇒ Object

POST /bridges/:bridgeId/addChannel void Add a channel to a bridge.

Allows comma separated values. Error Responses

400 - Channel not found 404 - Bridge not found 409 - Bridge not in Stasis application; Channel currently recording 422 - Channel not in Stasis application

Parameters:

• bridge_id (String) —

  Bridge’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :channel (String) —

  *required Ids of channels to add to bridge

• :role (String) —

  Channel’s role in the bridge

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-addChannel

# File 'lib/ari/client.rb', line 181

def bridges_add_channel(bridge_id, params = {})
  post "bridges/#{bridge_id}/addChannel", params
end

#bridges_create(params = {}) ⇒ Object

POST /bridges Bridge Create a new bridge.

Parameters:

• params (Hash) (defaults to: {})

Options Hash (params):

• :type (String) —

  Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media).

• :bridgeId (String) —

  Unique ID to give to the bridge being created.

• :name (String) —

  Name to give to the bridge being created.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create

# File 'lib/ari/client.rb', line 111

def bridges_create(params = {})
  post "bridges", params
end

#bridges_create_or_update_with_id(bridge_id, params = {}) ⇒ Object

POST /bridges/:bridgeId Bridge Create a new bridge or updates an existing one.

Parameters:

• bridge_id (String) —

  Unique ID to give to the bridge being created.

• params (Hash) (defaults to: {})

Options Hash (params):

• :type (String) —

  Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media) to set.

• :name (String) —

  Set the name of the bridge.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-create_or_update_with_id

# File 'lib/ari/client.rb', line 126

def bridges_create_or_update_with_id(bridge_id, params = {})
  post "bridges/#{bridge_id}", params
end

#bridges_destroy(bridge_id) ⇒ Object

DELETE /bridges/:bridgeId void Shut down a bridge.

Error Responses

404 - Bridge not found

Parameters:

• bridge_id (String) —

  Bridge’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-destroy

# File 'lib/ari/client.rb', line 158

def bridges_destroy(bridge_id)
  delete "bridges/#{bridge_id}"
end

#bridges_get(bridge_id) ⇒ Object

GET /bridges/:bridgeId Bridge Get bridge details.

Error Responses

404 - Bridge not found

Parameters:

• bridge_id (String) —

  Bridge’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-get

# File 'lib/ari/client.rb', line 142

def bridges_get(bridge_id)
  get "bridges/#{bridge_id}"
end

#bridges_list ⇒ Object

GET /bridges List List all active bridges in Asterisk.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-list

# File 'lib/ari/client.rb', line 96

def bridges_list
  get "bridges"
end

#bridges_play(bridge_id, params = {}) ⇒ Object

POST /bridges/:bridgeId/play Playback Start playback of media on a bridge.

Error Responses

404 - Bridge not found 409 - Bridge not in a Stasis application

Parameters:

• bridge_id (String) —

  Bridge’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :media (String) —

  *required Media’s URI to play.

• :lang (String) —

  For sounds, selects language for sound.

• :offsetms (Integer) —

  Number of media to skip before playing.

• :skipms (Integer) — default: 3000 —

  Number of milliseconds to skip for forward/reverse operations.

• :playbackId (String) —

  Playback Id.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-play

# File 'lib/ari/client.rb', line 260

def bridges_play(bridge_id, params = {})
  post "bridges/#{bridge_id}/play", params
end

#bridges_play_with_id(bridge_id, playback_id, params = {}) ⇒ Object

POST /bridges/:bridgeId/play/:playbackId Playback Start playback of media on a bridge.

Error Responses

404 - Bridge not found 409 - Bridge not in a Stasis application

Parameters:

• bridge_id (String) —

  Bridge’s id

• playback_id (String) —

  Playback ID.

• params (Hash) (defaults to: {})

Options Hash (params):

• :media (String) —

  *required Media’s URI to play.

• :lang (String) —

  For sounds, selects language for sound.

• :offsetms (Integer) —

  Number of media to skip before playing.

• :skipms (Integer) — default: 3000 —

  Number of milliseconds to skip for forward/reverse operations.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-playWithId

# File 'lib/ari/client.rb', line 283

def bridges_play_with_id(bridge_id, playback_id, params = {})
  post "bridges/#{bridge_id}/play/#{playback_id}", params
end

#bridges_record(bridge_id, params = {}) ⇒ Object

POST /bridges/:bridgeId/record LiveRecording Start a recording.

Error Responses

400 - Invalid parameters 404 - Bridge not found 409 - Bridge is not in a Stasis application; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail 422 - The format specified is unknown on this system

Parameters:

• bridge_id (String) —

  Bridge’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :name (String) —

  *required Recording’s filename

• :format (String) —

  *required Format to encode audio in

• :maxDurationSeconds (Integer) —

  Maximum duration of the recording, in seconds. 0 for no limit.

• :maxSilenceSeconds (Integer) —

  Maximum duration of silence, in seconds. 0 for no limit.

• :ifExists (String) — default: "fail" —

  Action to take if a recording with the same name already exists.

• :beep (Boolean) —

  Play beep when recording begins

• :terminateOn (String) — default: "none" —

  DTMF input to terminate recording.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-record

# File 'lib/ari/client.rb', line 310

def bridges_record(bridge_id, params = {})
  post "bridges/#{bridge_id}/record", params
end

#bridges_remove_channel(bridge_id, params = {}) ⇒ Object

POST /bridges/:bridgeId/removeChannel void Remove a channel from a bridge.

Error Responses

400 - Channel not found 404 - Bridge not found 409 - Bridge not in Stasis application 422 - Channel not in this bridge

Parameters:

• bridge_id (String) —

  Bridge’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :channel (String) —

  *required Ids of channels to remove from bridge. Allows comma separated values.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-removeChannel

# File 'lib/ari/client.rb', line 202

def bridges_remove_channel(bridge_id, params = {})
  post "bridges/#{bridge_id}/removeChannel", params
end

#bridges_start_moh(bridge_id, params = {}) ⇒ Object

POST /bridges/:bridgeId/moh void Play music on hold to a bridge or change the MOH class that is playing.

Error Responses

404 - Bridge not found 409 - Bridge not in Stasis application

Parameters:

• bridge_id (String) —

  Bridge’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :mohClass (String) —

  Channel’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-startMoh

# File 'lib/ari/client.rb', line 221

def bridges_start_moh(bridge_id, params = {})
  post "bridges/#{bridge_id}/moh", params
end

#bridges_stop_moh(bridge_id) ⇒ Object

DELETE /bridges/:bridgeId/moh void Stop playing music on hold to a bridge.

Error Responses 404 - Bridge not found 409 - Bridge not in Stasis application

Parameters:

• bridge_id (String) —

  Bridge’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Bridges+REST+API#Asterisk12BridgesRESTAPI-stopMoh

# File 'lib/ari/client.rb', line 237

def bridges_stop_moh(bridge_id)
  delete "bridges/#{bridge_id}/moh"
end

#channels_answer(channel_id) ⇒ Object

POST /channels/:channelId/answer void Answer a channel.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-answer

# File 'lib/ari/client.rb', line 455

def channels_answer(channel_id)
  post "channels/#{channel_id}/answer"
end

#channels_continue_in_dialplan(channel_id, params = {}) ⇒ Object

POST /channels/:channelId/continue void Exit application; continue execution in the dialplan.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :context (String) —

  The context to continue to.

• :extension (String) —

  The extension to continue to.

• :priority (Integer) —

  The priority to continue to.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-continueInDialplan

# File 'lib/ari/client.rb', line 438

def channels_continue_in_dialplan(channel_id, params = {})
  post "channels/#{channel_id}/continue", params
end

#channels_get(channel_id) ⇒ Object

GET /channels/:channelId Channel Channel details.

Error Responses

404 - Channel not found

Parameters:

• channel_id (String) —

  Channel’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-get

# File 'lib/ari/client.rb', line 368

def channels_get(channel_id)
  get "channels/#{channel_id}"
end

#channels_get_channel_var(channel_id, params = {}) ⇒ Object

GET /channels/:channelId/variable Variable Get the value of a channel variable or function.

Error Responses

400 - Missing variable parameter. 404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  channel_id

• params (Hash) (defaults to: {})

Options Hash (params):

• :variable (String) —

  *required The channel variable or function to get

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-getChannelVar

# File 'lib/ari/client.rb', line 748

def channels_get_channel_var(channel_id, params = {})
  get "channels/#{channel_id}/variable", params
end

#channels_hangup(channel_id, params = {}) ⇒ Object

DELETE /channels/:channelId void Delete (i.e. hangup) a channel.

Error Responses

400 - Invalid reason for hangup provided 404 - Channel not found

Parameters:

• channel_id (String) —

  Channel’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :reason (String) —

  Reason for hanging up the channel

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hangup

# File 'lib/ari/client.rb', line 417

def channels_hangup(channel_id, params = {})
  delete "channels/#{channel_id}", params
end

#channels_hold(channel_id) ⇒ Object

POST /channels/:channelId/hold void Hold a channel.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-hold

# File 'lib/ari/client.rb', line 568

def channels_hold(channel_id)
  post "channels/#{channel_id}/hold"
end

#channels_list ⇒ Object

Channels REST API GET /channels List List all active channels in Asterisk.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-list

# File 'lib/ari/client.rb', line 322

def channels_list
  get "channels"
end

#channels_mute(channel_id, params = {}) ⇒ Object

POST /channels/:channelId/mute void Mute a channel.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :direction (String) — default: "both" —

  Direction in which to mute audio

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-mute

# File 'lib/ari/client.rb', line 532

def channels_mute(channel_id, params = {})
  post "channels/#{channel_id}/mute", params
end

#channels_originate(params = {}) ⇒ Object

POST /channels Channel Create a new channel (originate).

Body parameter

variables: containers - The “variables” key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { “endpoint”: “SIP/Alice”, “variables”: { “CALLERID(name)”: “Alice” } }

Error Responses

400 - Invalid parameters for originating a channel.

Parameters:

• params (Hash) (defaults to: {})

Options Hash (params):

• :endpoint (String) —

  *required Endpoint to call.

• :extension (String) —

  The extension to dial after the endpoint answers

• :context (String) —

  The context to dial after the endpoint answers. If omitted, uses ‘default’

• :priority (Long) —

  The priority to dial after the endpoint answers. If omitted, uses 1

• :app (String) —

  The application that is subscribed to the originated channel, and passed to the Stasis application.

• :appArgs (String) —

  The application arguments to pass to the Stasis application.

• :callerId (String) —

  CallerID to use when dialing the endpoint or extension.

• :timeout (Integer) — default: 30 —

  Timeout (in seconds) before giving up dialing, or -1 for no timeout.

• :channelId (String) —

  The unique id to assign the channel on creation.

• :otherChannelId (String) —

  The unique id to assign the second channel when using local channels.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originate

# File 'lib/ari/client.rb', line 352

def channels_originate(params = {})
  post "channels", params
end

#channels_originate_with_id(channel_id, params = {}) ⇒ Object

POST /channels/:channelId Channel Create a new channel (originate with id).

Body parameter

variables: containers - The “variables” key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { “endpoint”: “SIP/Alice”, “variables”: { “CALLERID(name)”: “Alice” } }

Error Responses

400 - Invalid parameters for originating a channel.

Parameters:

• channel_id (String) —

  The unique id to assign the channel on creation.

• params (Hash) (defaults to: {})

Options Hash (params):

• :endpoint (String) —

  *required Endpoint to call.

• :extension (String) —

  The extension to dial after the endpoint answers

• :context (String) —

  The context to dial after the endpoint answers. If omitted, uses ‘default’

• priority (Long) —

  The priority to dial after the endpoint answers. If omitted, uses 1

• :app (String) —

  The application that is subscribed to the originated channel, and passed to the Stasis application.

• :appArgs (String) —

  The application arguments to pass to the Stasis application.

• :callerId (String) —

  CallerID to use when dialing the endpoint or extension.

• :timeout (Integer) — default: 30 —

  Timeout (in seconds) before giving up dialing, or -1 for no timeout.

• :otherChannelId (String) —

  The unique id to assign the second channel when using local channels.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-originateWithId

# File 'lib/ari/client.rb', line 398

def channels_originate_with_id(channel_id, params = {})
  post "channels/#{channel_id}", params
end

#channels_play(channel_id, params = {}) ⇒ Object

POST /channels/:channelId/play Playback Start playback of media.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :media (String) —

  *required Media’s URI to play.

• :lang (String) —

  For sounds, selects language for sound.

• :offsetms (Integer) —

  Number of media to skip before playing.

• :skipms (Integer) — default: 3000 —

  Number of milliseconds to skip for forward/reverse operations.

• :playbackId (String) —

  Playback ID.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-play

# File 'lib/ari/client.rb', line 678

def channels_play(channel_id, params = {})
  post "channels/#{channel_id}/play", params
end

#channels_play_with_id(channel_id, playback_id, params = {}) ⇒ Object

POST /channels/:channelId/play/:playbackId Playback Start playback of media and specify the playbackId.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  channel_id

• playback_id (String) —

  playback_id

• params (Hash) (defaults to: {})

Options Hash (params):

• :media (String) —

  *required Media’s URI to play.

• :lang (String) —

  For sounds, selects language for sound.

• :offsetms (Integer) —

  Number of media to skip before playing.

• :skipms (Integer) — default: 3000 —

  Number of milliseconds to skip for forward/reverse operations.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-playWithId

# File 'lib/ari/client.rb', line 701

def channels_play_with_id(channel_id, playback_id, params = {})
  post "channels/#{channel_id}/play/#{playback_id}", params
end

#channels_record(channel_id, params = {}) ⇒ Object

POST /channels/:channelId/record LiveRecording Start a recording.

Error Responses

400 - Invalid parameters 404 - Channel not found 409 - Channel is not in a Stasis application; the channel is currently bridged with other hcannels; A recording with the same name already exists on the system and can not be overwritten because it is in progress or ifExists=fail 422 - The format specified is unknown on this system

Parameters:

• channel_id (String) —

  Channel’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :name (String) —

  *required Recording’s filename

• :format (String) —

  *required Format to encode audio in

• :maxDurationSeconds (Integer) —

  Maximum duration of the recording, in seconds. 0 for no limit

• :maxSilenceSeconds (Integer) —

  Maximum duration of silence, in seconds. 0 for no limit

• :ifExists (String) — default: "fail" —

  • Action to take if a recording with the same name already exists.

• :beep (Boolen) —

  Play beep when recording begins

• :terminateOn (String) — default: "none" —

  DTMF input to terminate recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-record

# File 'lib/ari/client.rb', line 728

def channels_record(channel_id, params = {})
  post "channels/#{channel_id}/record", params
end

#channels_ring(channel_id) ⇒ Object

POST /channels/:channelId/ring void Indicate ringing to a channel.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ring

# File 'lib/ari/client.rb', line 472

def channels_ring(channel_id)
  post "channels/#{channel_id}/ring"
end

#channels_ring_stop(channel_id) ⇒ Object

DELETE /channels/:channelId/ring void Stop ringing indication on a channel if locally generated.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-ringStop

# File 'lib/ari/client.rb', line 489

def channels_ring_stop(channel_id)
  delete "channels/#{channel_id}/ring"
end

#channels_send_dtmf(channel_id, params = {}) ⇒ Object

POST /channels/:channelId/dtmf void Send provided DTMF to a given channel.

Error Responses

400 - DTMF is required 404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :dtmf (String) —

  DTMF To send.

• :before (Integer) —

  Amount of time to wait before DTMF digits (specified in milliseconds) start.

• :between (Integer) — default: 100 —

  Amount of time in between DTMF digits (specified in milliseconds).

• :duration (Integer) — default: 100 —

  Length of each DTMF digit (specified in milliseconds).

• :after (Integer) —

  Amount of time to wait after DTMF digits (specified in milliseconds) end.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-sendDTMF

# File 'lib/ari/client.rb', line 513

def channels_send_dtmf(channel_id, params = {})
  post "channels/#{channel_id}/dtmf", params
end

#channels_set_channel_var(channel_id, params = {}) ⇒ Object

POST /channels/:channelId/variable void Set the value of a channel variable or function.

Error Responses

400 - Missing variable parameter. 404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :variable (String) —

  *required The channel variable or function to set

• :value (String) —

  The value to set the variable to

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-setChannelVar

# File 'lib/ari/client.rb', line 769

def channels_set_channel_var(channel_id, params = {})
  post "channels/#{channel_id}/variable", params
end

#channels_snoop_channel(channel_id, params = {}) ⇒ Object

POST /channels/:channelId/snoop Channel Start snooping.

Error Responses

400 - Invalid parameters 404 - Channel not found

Parameters:

• channel_id (String) —

  Channel’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :spy (String) — default: "none" —

  Direction of audio to spy on

• :whisper (String) — default: "none" —

  Direction of audio to whisper into

• :app (String) —

  *required Application the snooping channel is placed into

• :appArgs (String) —

  The application arguments to pass to the Stasis application

• :snoopId (String) —

  Unique ID to assign to snooping channel

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannel

# File 'lib/ari/client.rb', line 792

def channels_snoop_channel(channel_id, params = {})
  post "channels/#{channel_id}/snoop", params
end

#channels_snoop_channel_with_id(channel_id, snoop_id, params = {}) ⇒ Object

POST /channels/:channelId/snoop/:snoopId Channel Start snooping.

Error Responses

400 - Invalid parameters 404 - Channel not found

Parameters:

• channel_id (String) —

  Channel’s id

• snoop_id (String) —

  Unique ID to assign to snooping channel

• params (Hash) (defaults to: {})
• param (Hash) —

  a customizable set of options

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-snoopChannelWithId

# File 'lib/ari/client.rb', line 815

def channels_snoop_channel_with_id(channel_id, snoop_id, params = {})
  post "channels/#{channel_id}/snoop/#{snoop_id}", params
end

#channels_start_moh(channel_id, params = {}) ⇒ Object

POST /channels/:channelId/moh void Play music on hold to a channel.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :mohClass (String) —

  Music on hold class to use

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startMoh

# File 'lib/ari/client.rb', line 604

def channels_start_moh(channel_id, params = {})
  post "channels/#{channel_id}/moh", params
end

#channels_start_silence(channel_id) ⇒ Object

/channels/:channelId/silence void Play silence to a channel.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-startSilence

# File 'lib/ari/client.rb', line 638

def channels_start_silence(channel_id)
  post "channels/#{channel_id}/silence"
end

#channels_stop_moh(channel_id) ⇒ Object

DELETE /channels/:channelId/moh void Stop playing music on hold to a channel. POST

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopMoh

# File 'lib/ari/client.rb', line 622

def channels_stop_moh(channel_id)
  delete "channels/#{channel_id}/moh"
end

#channels_stop_silence(channel_id) ⇒ Object

DELETE /channels/:channelId/silence void Stop playing silence to a channel.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-stopSilence

# File 'lib/ari/client.rb', line 655

def channels_stop_silence(channel_id)
  delete "channels/#{channel_id}/silence"
end

#channels_unhold(channel_id) ⇒ Object

DELETE /channels/:channelId/hold void Remove a channel from hold.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unhold

# File 'lib/ari/client.rb', line 585

def channels_unhold(channel_id)
  delete "channels/#{channel_id}/hold"
end

#channels_unmute(channel_id, params = {}) ⇒ Object

DELETE /channels/:channelId/mute void Unmute a channel.

Error Responses

404 - Channel not found 409 - Channel not in a Stasis application

Parameters:

• channel_id (String) —

  Channel’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :direction (String) — default: "both" —

  Direction in which to unmute audio

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Channels+REST+API#Asterisk12ChannelsRESTAPI-unmute

# File 'lib/ari/client.rb', line 551

def channels_unmute(channel_id, params = {})
  delete "channels/#{channel_id}/mute", params
end

#device_states_delete(device_name) ⇒ Object

DELETE /deviceStates/:deviceName void Destroy a device-state controlled by ARI.

Error Responses

404 - Device name is missing 409 - Uncontrolled device specified

Parameters:

• device_name (String) —

  Name of the device

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-delete

# File 'lib/ari/client.rb', line 1339

def device_states_delete(device_name)
  delete "deviceStates/#{device_name}"
end

#device_states_get(device_name) ⇒ Object

GET /deviceStates/:deviceName DeviceState Retrieve the current state of a device.

Parameters:

• device_name (String) —

  Name of the device

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-get

# File 'lib/ari/client.rb', line 1303

def device_states_get(device_name)
  get "deviceStates/#{device_name}"
end

#device_states_list ⇒ Object

GET /deviceStates List List all ARI controlled device states.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-list

# File 'lib/ari/client.rb', line 1291

def device_states_list
  get "deviceStates"
end

#device_states_update(device_name, params = {}) ⇒ Object

PUT /deviceStates/:deviceName void Change the state of a device controlled by ARI. (Note - implicitly creates the device state).

Error Responses

404 - Device name is missing 409 - Uncontrolled device specified

Parameters:

• device_name (String) —

  Name of the device

• params (Hash) (defaults to: {})

Options Hash (params):

• :deviceState (String) —

  *required Device state value

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Devicestates+REST+API#Asterisk12DevicestatesRESTAPI-update

# File 'lib/ari/client.rb', line 1322

def device_states_update(device_name, params = {})
  put "deviceStates/#{device_name}", params
end

#endpoints_get(tech, resource) ⇒ Object

GET /endpoints/:tech/:resource Endpoint Details for an endpoint.

Error Responses

400 - Invalid parameters for sending a message. 404 - Endpoints not found

Parameters:

• tech (String) —

  Technology of the endpoint

• resource (String) —

  ID of the endpoint

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-get

# File 'lib/ari/client.rb', line 884

def endpoints_get(tech, resource)
  get "endpoints/#{tech}/#{resource}"
end

#endpoints_list ⇒ Object

GET /endpoints List List all endpoints.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-list

# File 'lib/ari/client.rb', line 827

def endpoints_list
  get "endpoints"
end

#endpoints_list_by_tech(tech) ⇒ Object

GET /endpoints/:tech List List available endoints for a given endpoint technology.

Error Responses

404 - Endpoints not found

Parameters:

• tech (String) —

  Technology of the endpoints (sip,iax2,…)

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-listByTech

# File 'lib/ari/client.rb', line 866

def endpoints_list_by_tech(tech)
  get "endpoints/#{tech}"
end

#endpoints_send_message(params = {}) ⇒ Object

PUT /endpoints/sendMessage void Send a message to some technology URI or endpoint.

Body parameter

variables: containers -

Error Responses

404 - Endpoint not found

Parameters:

• params (Hash) (defaults to: {})
• param (Hash) —

  a customizable set of options

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessage

# File 'lib/ari/client.rb', line 850

def endpoints_send_message(params = {})
  put "endpoints/sendMessage", params
end

#endpoints_send_message_to_endpoint(tech, resource, params = {}) ⇒ Object

PUT /endpoints/:tech/:resource/sendMessage void Send a message to some endpoint in a technology.

Body parameter

variables: containers -

Error Responses

400 - Invalid parameters for sending a message. 404 - Endpoint not found

Parameters:

• tech (String) —

  Technology of the endpoint

• resource (String) —

  ID of the endpoint

• params (Hash) (defaults to: {})

Options Hash (params):

• :from (String) —

  *required The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.

• :body (String) —

  The body of the message

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Endpoints+REST+API#Asterisk12EndpointsRESTAPI-sendMessageToEndpoint

# File 'lib/ari/client.rb', line 909

def endpoints_send_message_to_endpoint(tech, resource, params = {})
  put "endpoints/#{tech}/#{resource}/sendMessage", params
end

#events_user_event(event_name, params = {}) ⇒ Object

POST /events/user/:eventName void Generate a user event.

Body parameter

variables: containers - The “variables” key in the body object holds custom key/value pairs to add to the user event. Ex. { “variables”: { “key”: “value” } }

Error Responses

404 - Application does not exist. 422 - Event source not found. 400 - Invalid even tsource URI or userevent data.

Parameters:

• event_name (String) —

  event_name

• params (Hash) (defaults to: {})
• param (Hash) —

  a customizable set of options

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Events+REST+API#Asterisk12EventsRESTAPI-userEvent

# File 'lib/ari/client.rb', line 947

def events_user_event(event_name, params = {})
  post "events/user/#{event_name}", params
end

#mailboxes_delete(mailbox_name) ⇒ Object

DELETE /mailboxes/:mailboxName void Destroy a mailbox.

Error Responses

404 - Mailbox not found

Parameters:

• mailbox_name (String) —

  Name of the mailbox

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-delete

# File 'lib/ari/client.rb', line 1402

def mailboxes_delete(mailbox_name)
  delete "mailboxes/#{mailbox_name}"
end

#mailboxes_get(mailbox_name) ⇒ Object

GET /mailboxes/:mailboxName Mailbox Retrieve the current state of a mailbox.

Error Responses

404 - Mailbox not found

Parameters:

• mailbox_name (String) —

  Name of the mailbox

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-get

# File 'lib/ari/client.rb', line 1367

def mailboxes_get(mailbox_name)
  get "mailboxes/#{mailbox_name}"
end

#mailboxes_list ⇒ Object

GET /mailboxes List List all mailboxes.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-list

# File 'lib/ari/client.rb', line 1351

def mailboxes_list
  get "mailboxes"
end

#mailboxes_update(mailbox_name, params = {}) ⇒ Object

PUT /mailboxes/:mailboxName void Change the state of a mailbox. (Note - implicitly creates the mailbox).

Error Responses

404 - Mailbox not found

Parameters:

• mailbox_name (String) —

  Name of the mailbox

• params (Hash) (defaults to: {})

Options Hash (params):

• :oldMessages (Integer) —

  *required Count of old messages in the mailbox

• :newMessages (Integer) —

  *required Count of new messages in the mailbox

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Mailboxes+REST+API#Asterisk12MailboxesRESTAPI-update

# File 'lib/ari/client.rb', line 1386

def mailboxes_update(mailbox_name, params = {})
  put "mailboxes/#{mailbox_name}", params
end

#playbacks_control(playback_id, params = {}) ⇒ Object

POST /playbacks/:playbackId/control void Control a playback.

Error Responses

400 - The provided operation parameter was invalid 404 - The playback cannot be found 409 - The operation cannot be performed in the playback’s current state

Parameters:

• playback_id (String) —

  Playback’s id

• params (Hash) (defaults to: {})

Options Hash (params):

• :operation (String) —

  *required Operation to perform on the playback.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-control

# File 'lib/ari/client.rb', line 1279

def playbacks_control(playback_id, params = {})
  post "playbacks/#{playback_id}/control", params
end

#playbacks_get(playback_id) ⇒ Object

GET /playbacks/:playbackId Playback Get a playback’s details.

Error Responses

404 - The playback cannot be found

Parameters:

• playback_id (String) —

  Playback’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-get

# File 'lib/ari/client.rb', line 1243

def playbacks_get(playback_id)
  get "playbacks/#{playback_id}"
end

#playbacks_stop(playback_id) ⇒ Object

DELETE /playbacks/:playbackId void Stop a playback.

Error Responses

404 - The playback cannot be found

Parameters:

• playback_id (String) —

  Playback’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Playbacks+REST+API#Asterisk12PlaybacksRESTAPI-stop

# File 'lib/ari/client.rb', line 1259

def playbacks_stop(playback_id)
  delete "playbacks/#{playback_id}"
end

#recordings_cancel(recording_name) ⇒ Object

DELETE /recordings/live/:recordingName void Stop a live recording and discard it.

Error Responses

404 - Recording not found

Parameters:

• recording_name (String) —

  The name of the recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-cancel

# File 'lib/ari/client.rb', line 1044

def recordings_cancel(recording_name)
  delete "recordings/live/#{recording_name}"
end

#recordings_copy_stored(recording_name, params = {}) ⇒ Object

POST /recordings/stored/:recordingName/copy StoredRecording Copy a stored recording.

Error Responses

404 - Recording not found 409 - A recording with the same name already exists on the system

Parameters:

• recording_name (String) —

  The name of the recording to copy

• params (Hash) (defaults to: {})

Options Hash (params):

• :destinationRecordingName (String) —

  *required The destination name of the recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-copyStored

# File 'lib/ari/client.rb', line 1012

def recordings_copy_stored(recording_name, params = {})
  post "recordings/stored/#{recording_name}/copy", params
end

#recordings_delete_stored(recording_name) ⇒ Object

DELETE /recordings/stored/:recordingName void Delete a stored recording.

Error Responses

404 - Recording not found

Parameters:

• recording_name (String) —

  The name of the recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-deleteStored

# File 'lib/ari/client.rb', line 993

def recordings_delete_stored(recording_name)
  delete "recordings/stored/#{recording_name}"
end

#recordings_get_live(recording_name) ⇒ Object

GET /recordings/live/:recordingName LiveRecording List live recordings.

Error Responses

404 - Recording not found

Parameters:

• recording_name (String) —

  The name of the recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getLive

# File 'lib/ari/client.rb', line 1028

def recordings_get_live(recording_name)
  get "recordings/live/#{recording_name}"
end

#recordings_get_stored(recording_name) ⇒ Object

GET

/recordings/stored/:recordingName

StoredRecording Get a stored recording’s details.

Error Responses

404 - Recording not found

Parameters:

• recording_name (String) —

  The name of the recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-getStored

# File 'lib/ari/client.rb', line 977

def recordings_get_stored(recording_name)
  get "recordings/stored/#{recording_name}"
end

#recordings_list_stored ⇒ Object

GET /recordings/stored List List recordings that are complete.

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-listStored

# File 'lib/ari/client.rb', line 959

def recordings_list_stored
  get "recordings/stored"
end

#recordings_mute(recording_name) ⇒ Object

POST /recordings/live/:recordingName/mute void Mute a live recording.

Error Responses

404 - Recording not found 409 - Recording not in session

Parameters:

• recording_name (String) —

  The name of the recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-mute

# File 'lib/ari/client.rb', line 1111

def recordings_mute(recording_name)
  post "recordings/live/#{recording_name}/mute"
end

#recordings_pause(recording_name) ⇒ Object

POST /recordings/live/:recordingName/pause void Pause a live recording.

Error Responses

404 - Recording not found 409 - Recording not in session

Parameters:

• recording_name (String) —

  The name of the recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-pause

# File 'lib/ari/client.rb', line 1077

def recordings_pause(recording_name)
  post "recordings/live/#{recording_name}/pause"
end

#recordings_stop(recording_name) ⇒ Object

POST /recordings/live/:recordingName/stop void Stop a live recording and store it.

Error Responses

404 - Recording not found

Parameters:

• recording_name (String) —

  The name of the recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-stop

# File 'lib/ari/client.rb', line 1060

def recordings_stop(recording_name)
  post "recordings/live/#{recording_name}/stop"
end

#recordings_unmute(recording_name) ⇒ Object

DELETE /recordings/live/:recordingName/mute void Unmute a live recording.

Error Responses

404 - Recording not found 409 - Recording not in session

Parameters:

• recording_name (String) —

  The name of the recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unmute

# File 'lib/ari/client.rb', line 1128

def recordings_unmute(recording_name)
  delete "recordings/live/#{recording_name}/mute"
end

#recordings_unpause(recording_name) ⇒ Object

DELETE /recordings/live/:recordingName/pause void Unpause a live recording.

Error Responses

404 - Recording not found 409 - Recording not in session

Parameters:

• recording_name (String) —

  The name of the recording

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Recordings+REST+API#Asterisk12RecordingsRESTAPI-unpause

# File 'lib/ari/client.rb', line 1094

def recordings_unpause(recording_name)
  delete "recordings/live/#{recording_name}/pause"
end

#sounds_get(sound_id) ⇒ Object

GET /sounds/:soundId Sound Get a sound’s details.

Parameters:

• sound_id (String) —

  Sound’s id

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-get

# File 'lib/ari/client.rb', line 1156

def sounds_get(sound_id)
  get "sounds/#{sound_id}"
end

#sounds_list(params = {}) ⇒ Object

GET /sounds List List all sounds.

Parameters:

• params (Hash) (defaults to: {})
• param (Hash) —

  a customizable set of options

See Also:

• https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Sounds+REST+API#Asterisk12SoundsRESTAPI-list

# File 'lib/ari/client.rb', line 1144

def sounds_list(params = {})
  get "sounds", params
end