ARI v0.1.2 ARI.RecordCall View Source
A Stasis application to handle recording phone calls. This uses the ARI.HTTP.Channels.snoop/6
functionality of Asterisk to record the call.
Example
Channels.snoop(
state.channel,
UUID.uuid4(),
"record_call",
"in",
"none",
"originating_app_name,state.channel"
)
This would be initiated in an event handler for your current call. The state.channel
should be the ID of the incoming call.
The example above would only record the incoming audio, you could record incoming and outgoing audio by using "both" instead of "in".
This assumes you registered the Stasis application under the name "record_call", like so.
{ARI.Stasis, [sup, %{name: "record_call", module: ARI.RecordCall}, ws_host, un, pw]}
This application will by default stop recording after 2 seconds of silence. Once recording is finished it pushes an event to the originating channel that looks like this.
{:ari, %{type: "CommandCaptured", recording: "recording-id"}}
By default the wav file will be recorded in the Asterisk spool directory, you can override this with Asterisk settings.
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.
Called when an incoming call is received.
Arguments are Channel ID
, Caller ID
, Args
, StasisStart Event
and App Config
Link to this section Types
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
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
.
Called when an incoming call is received.
Arguments are Channel ID
, Caller ID
, Args
, StasisStart Event
and App Config
Callback implementation for ARI.Stasis.state/5
.