ARI v0.1.2 ARI.HTTP.Channels View Source
HTTP Interface for CRUD operations on Channel objects
REST Reference: https://wiki.asterisk.org/wiki/display/AST/Asterisk+16+Channels+REST+API
Channel Object: https://wiki.asterisk.org/wiki/display/AST/Asterisk+16+REST+Data+Models#Asterisk16RESTDataModels-Channel
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor.
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
dial(id, caller \\ "", timeout \\ 1000)
View Sourcedial(String.t(), String.t(), integer()) :: ARI.HTTPClient.Response.t()
get(id)
View Sourceget(String.t()) :: ARI.HTTPClient.Response.t()
get(map()) :: ARI.HTTPClient.Response.t()
get_var(id, name)
View Sourceget_var(String.t(), String.t()) :: ARI.HTTPClient.Response.t()
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
,
except that it also sets a timeout. See the "Timeouts" section
in the module documentation for more information.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
move(id, app, args \\ "")
View Sourcemove(String.t(), String.t(), String.t()) :: ARI.HTTPClient.Response.t()
mute(id, direction \\ "both")
View Sourcemute(String.t(), String.t()) :: ARI.HTTPClient.Response.t()
originate(id, payload)
View Sourceoriginate(binary(), map()) :: ARI.HTTPClient.Response.t()
play(id, playback_id, media, lang \\ "en", offsetms \\ 0, skipms \\ 3000)
View Sourcerecord(id, name, format, max_duration \\ 0, max_silence \\ 0, if_exists \\ "fail", beep \\ "no", terminate_on \\ "#")
View Sourceredirect(id, endpoint)
View Sourceredirect(String.t(), String.t()) :: ARI.HTTPClient.Response.t()
request(method, path, from, state, body \\ nil)
View Sourcerequest( String.t(), String.t(), GenServer.from(), ARI.HTTPClient.State.t(), map() | String.t() | nil ) :: ARI.HTTPClient.State.t()
ring_stop(id)
View Sourcering_stop(String.t()) :: ARI.HTTPClient.Response.t()
send_dtmf(id, dtmf, before \\ 100, between \\ 100, duration \\ 100, after_ms \\ 100)
View Sourceset_var(id, name, value)
View Sourceset_var(String.t(), String.t(), String.t()) :: ARI.HTTPClient.Response.t()
snoop(id, snoop_id, app, spy \\ "none", whisper \\ "none", app_args \\ "")
View Sourcestart_moh(id, moh_class)
View Sourcestart_moh(String.t(), String.t()) :: ARI.HTTPClient.Response.t()
start_silence(id)
View Sourcestart_silence(String.t()) :: ARI.HTTPClient.Response.t()
stop_silence(id)
View Sourcestop_silence(String.t()) :: ARI.HTTPClient.Response.t()
unmute(id, direction \\ "both")
View Sourceunmute(String.t(), String.t()) :: ARI.HTTPClient.Response.t()