class Asterisk::ARI::Events

Defined in:

asterisk/ari/resources/events.cr
asterisk/ari/events/message.cr
asterisk/ari/events/event.cr
asterisk/ari/events/application_move_failed.cr
asterisk/ari/events/application_replaced.cr
asterisk/ari/events/bridge_attended_transfer.cr
asterisk/ari/events/bridge_blind_transfer.cr
asterisk/ari/events/bridge_created.cr
asterisk/ari/events/bridge_destroyed.cr
asterisk/ari/events/bridge_merged.cr
asterisk/ari/events/bridge_video_source_changed.cr
asterisk/ari/events/channel_caller_id.cr
asterisk/ari/events/channel_connected_line.cr
asterisk/ari/events/channel_created.cr
asterisk/ari/events/channel_destroyed.cr
asterisk/ari/events/channel_dialplan.cr
asterisk/ari/events/channel_dtmf_received.cr
asterisk/ari/events/channel_entered_bridge.cr
asterisk/ari/events/channel_hangup_request.cr
asterisk/ari/events/channel_hold.cr
asterisk/ari/events/channel_left_bridge.cr
asterisk/ari/events/channel_state_change.cr
asterisk/ari/events/channel_talking_finished.cr
asterisk/ari/events/channel_talking_started.cr
asterisk/ari/events/channel_unhold.cr
asterisk/ari/events/channel_userevent.cr
asterisk/ari/events/channel_varset.cr
asterisk/ari/events/contact_info.cr
asterisk/ari/events/contact_status_change.cr
asterisk/ari/events/device_state_changed.cr
asterisk/ari/events/dial.cr
asterisk/ari/events/endpoint_state_change.cr
asterisk/ari/events/missing_params.cr
asterisk/ari/events/peer.cr
asterisk/ari/events/peer_status_change.cr
asterisk/ari/events/playback_continuing.cr
asterisk/ari/events/playback_finished.cr
asterisk/ari/events/playback_started.cr
asterisk/ari/events/recording_failed.cr
asterisk/ari/events/recording_finished.cr
asterisk/ari/events/recording_started.cr
asterisk/ari/events/stasis_end.cr
asterisk/ari/events/stasis_start.cr
asterisk/ari/events/text_message_received.cr

Instance Method Summary

Instance methods inherited from class Asterisk::ARI::Resources

ari : ARI ari

Constructor methods inherited from class Asterisk::ARI::Resources

new(ari) new

Instance Method Detail

def event_websocket(app : String, subscribe_all : Bool? = nil) : HTTP::Client::Response | Message #

WebSocket connection for events.

Arguments:

  • app - applications to subscribe to. (required). Allow multiple instances (comma-separated list);
  • subscribe_all - subscribe to all Asterisk events. If provided, the applications listed will be subscribed to all events, effectively disabling the application specific subscriptions. Default is 'false';

[View source]
def user_event(event_name : String, application : String, source : String? = nil, variables : Hash(String, String | Bool | Int32 | Float32)? = nil) #

Generate a user event.

Arguments:

  • event_name - event name. (required);
  • application - the name of the application that will receive this event. (required);
  • source - uRI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName}.. Allow multiple instances (comma-separated list);
  • variables - 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.

[View source]