ARI Reference
Events (44 typed variants)
| Variant | Description |
|---|---|
StasisStart | channel entered a Stasis application |
StasisEnd | channel left a Stasis application |
ChannelCreated | channel was created |
ChannelDestroyed | channel was destroyed |
ChannelStateChange | channel state changed |
ChannelDtmfReceived | DTMF digit received on channel |
ChannelHangupRequest | hangup requested on channel |
ChannelVarset | channel variable set |
BridgeCreated | bridge was created |
BridgeDestroyed | bridge was destroyed |
ChannelEnteredBridge | channel entered a bridge |
ChannelLeftBridge | channel left a bridge |
PlaybackStarted | media playback started |
PlaybackFinished | media playback finished |
RecordingStarted | recording started |
RecordingFinished | recording finished |
ChannelCallerId | channel caller id changed |
ChannelConnectedLine | channel connected line changed |
ChannelDialplan | channel dialplan location changed |
ChannelHold | channel placed on hold |
ChannelUnhold | channel removed from hold |
ChannelTalkingStarted | channel talking started |
ChannelTalkingFinished | channel talking finished |
ChannelToneDetected | tone detected on channel |
ChannelTransfer | channel transfer via REFER |
ChannelUserevent | user-defined event from the dialplan |
Dial | dial event with caller and peer channels |
BridgeAttendedTransfer | bridge attended transfer completed |
BridgeBlindTransfer | bridge blind transfer completed |
BridgeMerged | two bridges merged |
BridgeVideoSourceChanged | bridge video source changed |
ContactStatusChange | contact status changed |
DeviceStateChanged | device state changed |
EndpointStateChange | endpoint state changed |
PeerStatusChange | peer status changed |
PlaybackContinuing | playback continuing to next media uri |
RecordingFailed | recording failed |
ApplicationMoveFailed | application move failed |
ApplicationRegistered | application registered |
ApplicationReplaced | application replaced by another websocket connection |
ApplicationUnregistered | application unregistered |
TextMessageReceived | text message received |
RESTResponse | REST API response over websocket |
Unknown | catch-all for event types not yet modeled |
Resources (10 modules)
Application (5 operations)
| Method | Description |
|---|---|
list() | list all stasis applications |
get() | get a specific stasis application |
subscribe() | subscribe an application to an event source |
unsubscribe() | unsubscribe an application from an event source |
set_event_filter() | set the event filter for an application |
Asterisk (16 operations)
| Method | Description |
|---|---|
info() | get asterisk system information |
ping() | ping asterisk |
list_modules() | list all loaded modules |
get_module() | get details for a specific module |
load_module() | load a module |
unload_module() | unload a module |
reload_module() | reload a module |
list_log_channels() | list log channels |
add_log_channel() | add a log channel |
remove_log_channel() | remove a log channel |
rotate_log_channel() | rotate a log channel |
get_variable() | get a global variable |
set_variable() | set a global variable |
get_config() | get dynamic configuration object |
update_config() | update dynamic configuration object |
delete_config() | delete dynamic configuration object |
Bridge (BridgeHandle, 16 operations)
| Method | Description |
|---|---|
add_channel() | add a channel to this bridge |
remove_channel() | remove a channel from this bridge |
play() | play media on the bridge |
record() | start recording on the bridge |
destroy() | destroy this bridge |
start_moh() | start music on hold for the bridge |
stop_moh() | stop music on hold for the bridge |
play_with_id() | play media with a specific playback id |
set_video_source() | set the video source for the bridge |
clear_video_source() | clear the video source for the bridge |
create() | create a new bridge |
list() | list all bridges |
get() | get details for a specific bridge |
create() | create a new bridge |
list() | list all bridges |
get() | get details for a specific bridge |
Channel (ChannelHandle, 32 operations)
| Method | Description |
|---|---|
answer() | answer the channel |
hangup() | hang up the channel with an optional reason |
play() | play media on the channel |
record() | start recording on the channel |
mute() | mute the channel, optionally specifying direction (both, in, out) |
unmute() | unmute the channel, optionally specifying direction |
hold() | place the channel on hold |
unhold() | remove the channel from hold |
send_dtmf() | send dtmf digits to the channel |
get_variable() | get a channel variable |
set_variable() | set a channel variable |
continue_in_dialplan() | continue the channel in the dialplan |
snoop() | snoop on the channel — spy and/or whisper |
redirect() | redirect the channel to a different dialplan location |
ring() | start ringing on the channel |
ring_stop() | stop ringing on the channel |
start_silence() | start silence on the channel |
stop_silence() | stop silence on the channel |
play_with_id() | play media on the channel with additional options |
dial() | dial a created channel |
rtp_statistics() | get rtp statistics for the channel |
external_media() | start an external media session |
list() | list all active channels |
get() | get details for a specific channel |
originate() | originate a new channel |
create() | create a channel without dialing it |
external_media() | start an external media session |
list() | list all active channels |
get() | get details for a specific channel |
originate() | originate a new channel |
create() | create a channel without dialing it |
external_media() | start an external media session |
Device State (4 operations)
| Method | Description |
|---|---|
list() | list all device states |
get() | get a specific device state |
update() | also accepts POST for compatibility |
delete() | delete a device state |
Endpoint (7 operations)
| Method | Description |
|---|---|
list() | list all endpoints |
list_by_tech() | list endpoints for a specific technology |
get() | get a specific endpoint |
send_message() | send a message to some technology uri or endpoint |
refer() | refer an endpoint or technology uri to some technology uri or endpoint |
send_message_to_endpoint() | send a message to an endpoint |
refer_to_endpoint() | refer an endpoint to some technology uri or endpoint |
Mailbox (4 operations)
| Method | Description |
|---|---|
list() | list all mailboxes |
get() | get a specific mailbox |
update() | also accepts POST for compatibility |
delete() | delete a mailbox |
Playback (PlaybackHandle, 3 operations)
| Method | Description |
|---|---|
control() | control the playback (pause, unpause, restart, reverse, forward) |
stop() | stop the playback |
get() | get current playback state |
Recording (RecordingHandle, 8 operations)
| Method | Description |
|---|---|
stop() | stop the live recording |
pause() | pause the live recording |
unpause() | unpause the live recording |
mute() | mute the live recording |
unmute() | unmute the live recording |
get() | get current live recording state |
list_stored() | list all stored recordings |
list_stored() | list all stored recordings |
Sound (2 operations)
| Method | Description |
|---|---|
list() | list all sounds |
get() | get a specific sound |