elixir_ami v0.0.20 ElixirAmi.Action

An AMI action is represented by this structure.

See: https://wiki.asterisk.org/wiki/display/AST/AMI+Actions

Copyright 2015 Marcelo Gornstein marcelog@gmail.com

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Summary

Functions

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AbsoluteTimeout

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AgentLogoff

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Agents

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AGI

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Bridge

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreSettings

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreShowChannels

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Getvar

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Hangup

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ListCategories

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ListCommands

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Login

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Logoff

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Monitor

Creates a new action structure from the given name, keys, and variables

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Originate

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Originate

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Park

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ParkedCalls

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_PauseMonitor

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Ping

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Redirect

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Reload

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SendText

Transforms an action structure into an iolist suitable to be sent through a socket

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Setvar

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPpeers

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPqualifypeer

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Status

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_StopMonitor

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_UnpauseMonitor

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_UserEvent

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_VoicemailUsersList

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_WaitEvent

Types

t()
t() :: ElixirAmi.Action

Functions

absolute_timeout(channel, timeout)
absolute_timeout(String.t, Integer.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AbsoluteTimeout

agent_logoff(agent, soft)
agent_logoff(String.t, boolean) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AgentLogoff

agents()
agents() :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Agents

agi(channel, command, command_id)

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_AGI

bridge(channel1, channel2, tone)
bridge(String.t, String.t, boolean) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Bridge

core_settings()
core_settings() :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreSettings

core_show_channels()
core_show_channels() :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_CoreShowChannels

get_var(channel, name)
get_var(String.t, String.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Getvar

hangup(channel, cause)
hangup(String.t, Integer.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Hangup

list_categories(filename)

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ListCategories

list_commands()

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ListCommands

login(username, password)
login(String.t, String.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Login

logoff()
logoff() :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Logoff

monitor(channel, file, format, mix)

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Monitor

new(name, keys \\ %{}, variables \\ %{})
new(String.t, Map.t, Map.t) :: t

Creates a new action structure from the given name, keys, and variables.

originate(channel, application, data, timeout, caller_id, account, async, codecs, variables)

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Originate

originate(channel, exten, context, priority, timeout, caller_id, account, async, codecs, variables)

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Originate

park(channel, channel2, timeout, parking_lot)

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Park

parked_calls()
parked_calls() :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_ParkedCalls

pause_monitor(channel)
pause_monitor(String.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_PauseMonitor

ping()
ping() :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Ping

redirect(channel, context, exten, priority)
redirect(String.t, String.t, String.t, String.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Redirect

reload(module)
reload(String.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Reload

send_text(channel, message)
send_text(String.t, String.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SendText

serialize(action)
serialize(t) :: iolist

Transforms an action structure into an iolist suitable to be sent through a socket.

set_var(channel, name, value)
set_var(String.t, String.t, String.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Setvar

sip_peers()
sip_peers() :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPpeers

sip_qualify_peer(peer)
sip_qualify_peer(String.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_SIPqualifypeer

status(variables, channel \\ nil)

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_Status

stop_monitor(channel)
stop_monitor(String.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_StopMonitor

unpause_monitor(channel)
unpause_monitor(String.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_UnpauseMonitor

user_event(event, headers \\ %{})
user_event(String.t, Map.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_UserEvent

voicemail_users_list()
voicemail_users_list() :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_VoicemailUsersList

wait_event(timeout)
wait_event(Integer.t) :: t

See: https://wiki.asterisk.org/wiki/display/AST/ManagerAction_WaitEvent