OSTIP_EXARI v0.1.0 Swagger.Client.Api.ApiDocseventsFormat View Source
API calls for all endpoints tagged ApiDocseventsFormat.
Link to this section Summary
Link to this section Functions
Link to this function
event_websocket(connection, app, opts \\ [])
View Source
event_websocket(Tesla.Env.client(), [String.t()], keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
WebSocket connection for events.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- app ([String.t]): Applications to subscribe to.
opts (KeywordList): [optional] Optional parameters
- :subscribe_all (boolean()): 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'.
Returns
{:ok, %{}} on success {:error, info} on failure
Link to this function
user_event(connection, event_name, application, opts \\ [])
View Source
user_event(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Generate a user event.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- event_name (String.t): Event name
- application (String.t): The name of the application that will receive this event
opts (KeywordList): [optional] Optional parameters
- :source ([String.t]): URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}, deviceState:{deviceName}
- :variables (Containers): The "variables" key in the body object holds custom key/value pairs to add to the user event. Ex. { "variables": { "key": "value" } }
Returns
{:ok, %{}} on success {:error, info} on failure