Skip to content

safchain/asyncio-ari

BranchesTags

Repository files navigation

swagger-client

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 4.0.2
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/safchain/asyncio-ari.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/safchain/asyncio-ari.git)

Then import the package:

import swagger_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi(swagger_client.ApiClient(configuration))
application_name = 'application_name_example' # str | Application's name
filter = NULL # object | Specify which event types to allow/disallow (optional)

try:
    # Filter application events types.
    api_response = api_instance.applications_application_name_event_filter_put(application_name, filter=filter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationsApi->applications_application_name_event_filter_put: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8088/ari

Class Method HTTP request Description
ApplicationsApi applications_application_name_event_filter_put PUT /applications/{applicationName}/eventFilter Filter application events types.
ApplicationsApi applications_application_name_get GET /applications/{applicationName} Get details of an application.
ApplicationsApi applications_application_name_subscription_delete DELETE /applications/{applicationName}/subscription Unsubscribe an application from an event source.
ApplicationsApi applications_application_name_subscription_post POST /applications/{applicationName}/subscription Subscribe an application to a event source.
ApplicationsApi applications_get GET /applications List all applications.
AsteriskApi asterisk_config_dynamic_config_class_object_type_id_delete DELETE /asterisk/config/dynamic/{configClass}/{objectType}/{id} Delete a dynamic configuration object.
AsteriskApi asterisk_config_dynamic_config_class_object_type_id_get GET /asterisk/config/dynamic/{configClass}/{objectType}/{id} Retrieve a dynamic configuration object.
AsteriskApi asterisk_config_dynamic_config_class_object_type_id_put PUT /asterisk/config/dynamic/{configClass}/{objectType}/{id} Create or update a dynamic configuration object.
AsteriskApi asterisk_info_get GET /asterisk/info Gets Asterisk system information.
AsteriskApi asterisk_logging_get GET /asterisk/logging Gets Asterisk log channel information.
AsteriskApi asterisk_logging_log_channel_name_delete DELETE /asterisk/logging/{logChannelName} Deletes a log channel.
AsteriskApi asterisk_logging_log_channel_name_post POST /asterisk/logging/{logChannelName} Adds a log channel.
AsteriskApi asterisk_logging_log_channel_name_rotate_put PUT /asterisk/logging/{logChannelName}/rotate Rotates a log channel.
AsteriskApi asterisk_modules_get GET /asterisk/modules List Asterisk modules.
AsteriskApi asterisk_modules_module_name_delete DELETE /asterisk/modules/{moduleName} Unload an Asterisk module.
AsteriskApi asterisk_modules_module_name_get GET /asterisk/modules/{moduleName} Get Asterisk module information.
AsteriskApi asterisk_modules_module_name_post POST /asterisk/modules/{moduleName} Load an Asterisk module.
AsteriskApi asterisk_modules_module_name_put PUT /asterisk/modules/{moduleName} Reload an Asterisk module.
AsteriskApi asterisk_ping_get GET /asterisk/ping Response pong message.
AsteriskApi asterisk_variable_get GET /asterisk/variable Get the value of a global variable.
AsteriskApi asterisk_variable_post POST /asterisk/variable Set the value of a global variable.
BridgesApi bridges_bridge_id_add_channel_post POST /bridges/{bridgeId}/addChannel Add a channel to a bridge.
BridgesApi bridges_bridge_id_delete DELETE /bridges/{bridgeId} Shut down a bridge.
BridgesApi bridges_bridge_id_get GET /bridges/{bridgeId} Get bridge details.
BridgesApi bridges_bridge_id_moh_delete DELETE /bridges/{bridgeId}/moh Stop playing music on hold to a bridge.
BridgesApi bridges_bridge_id_moh_post POST /bridges/{bridgeId}/moh Play music on hold to a bridge or change the MOH class that is playing.
BridgesApi bridges_bridge_id_play_playback_id_post POST /bridges/{bridgeId}/play/{playbackId} Start playback of media on a bridge.
BridgesApi bridges_bridge_id_play_post POST /bridges/{bridgeId}/play Start playback of media on a bridge.
BridgesApi bridges_bridge_id_post POST /bridges/{bridgeId} Create a new bridge or updates an existing one.
BridgesApi bridges_bridge_id_record_post POST /bridges/{bridgeId}/record Start a recording.
BridgesApi bridges_bridge_id_remove_channel_post POST /bridges/{bridgeId}/removeChannel Remove a channel from a bridge.
BridgesApi bridges_bridge_id_variable_get GET /bridges/{bridgeId}/variable Get the value of a bridge variable or function.
BridgesApi bridges_bridge_id_variable_post POST /bridges/{bridgeId}/variable Set the value of a bridge variable or function.
BridgesApi bridges_bridge_id_video_source_channel_id_post POST /bridges/{bridgeId}/videoSource/{channelId} Set a channel as the video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants.
BridgesApi bridges_bridge_id_video_source_delete DELETE /bridges/{bridgeId}/videoSource Removes any explicit video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants. When no explicit video source is set, talk detection will be used to determine the active video stream.
BridgesApi bridges_get GET /bridges List all active bridges in Asterisk.
BridgesApi bridges_post POST /bridges Create a new bridge.
ChannelsApi channels_channel_id_answer_post POST /channels/{channelId}/answer Answer a channel.
ChannelsApi channels_channel_id_continue_post POST /channels/{channelId}/continue Exit application; continue execution in the dialplan.
ChannelsApi channels_channel_id_delete DELETE /channels/{channelId} Delete (i.e. hangup) a channel.
ChannelsApi channels_channel_id_dial_post POST /channels/{channelId}/dial Dial a created channel.
ChannelsApi channels_channel_id_dtmf_post POST /channels/{channelId}/dtmf Send provided DTMF to a given channel.
ChannelsApi channels_channel_id_get GET /channels/{channelId} Channel details.
ChannelsApi channels_channel_id_hold_delete DELETE /channels/{channelId}/hold Remove a channel from hold.
ChannelsApi channels_channel_id_hold_post POST /channels/{channelId}/hold Hold a channel.
ChannelsApi channels_channel_id_moh_delete DELETE /channels/{channelId}/moh Stop playing music on hold to a channel.
ChannelsApi channels_channel_id_moh_post POST /channels/{channelId}/moh Play music on hold to a channel.
ChannelsApi channels_channel_id_move_post POST /channels/{channelId}/move Move the channel from one Stasis application to another.
ChannelsApi channels_channel_id_mute_delete DELETE /channels/{channelId}/mute Unmute a channel.
ChannelsApi channels_channel_id_mute_post POST /channels/{channelId}/mute Mute a channel.
ChannelsApi channels_channel_id_play_playback_id_post POST /channels/{channelId}/play/{playbackId} Start playback of media and specify the playbackId.
ChannelsApi channels_channel_id_play_post POST /channels/{channelId}/play Start playback of media.
ChannelsApi channels_channel_id_post POST /channels/{channelId} Create a new channel (originate with id).
ChannelsApi channels_channel_id_record_post POST /channels/{channelId}/record Start a recording.
ChannelsApi channels_channel_id_redirect_post POST /channels/{channelId}/redirect Redirect the channel to a different location.
ChannelsApi channels_channel_id_ring_delete DELETE /channels/{channelId}/ring Stop ringing indication on a channel if locally generated.
ChannelsApi channels_channel_id_ring_post POST /channels/{channelId}/ring Indicate ringing to a channel.
ChannelsApi channels_channel_id_rtp_statistics_get GET /channels/{channelId}/rtp_statistics RTP stats on a channel.
ChannelsApi channels_channel_id_silence_delete DELETE /channels/{channelId}/silence Stop playing silence to a channel.
ChannelsApi channels_channel_id_silence_post POST /channels/{channelId}/silence Play silence to a channel.
ChannelsApi channels_channel_id_snoop_post POST /channels/{channelId}/snoop Start snooping.
ChannelsApi channels_channel_id_snoop_snoop_id_post POST /channels/{channelId}/snoop/{snoopId} Start snooping.
ChannelsApi channels_channel_id_variable_get GET /channels/{channelId}/variable Get the value of a channel variable or function.
ChannelsApi channels_channel_id_variable_post POST /channels/{channelId}/variable Set the value of a channel variable or function.
ChannelsApi channels_create_post POST /channels/create Create channel.
ChannelsApi channels_external_media_post POST /channels/externalMedia Start an External Media session.
ChannelsApi channels_get GET /channels List all active channels in Asterisk.
ChannelsApi channels_post POST /channels Create a new channel (originate).
DeviceStatesApi device_states_device_name_delete DELETE /deviceStates/{deviceName} Destroy a device-state controlled by ARI.
DeviceStatesApi device_states_device_name_get GET /deviceStates/{deviceName} Retrieve the current state of a device.
DeviceStatesApi device_states_device_name_put PUT /deviceStates/{deviceName} Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
DeviceStatesApi device_states_get GET /deviceStates List all ARI controlled device states.
EndpointsApi endpoints_get GET /endpoints List all endpoints.
EndpointsApi endpoints_send_message_put PUT /endpoints/sendMessage Send a message to some technology URI or endpoint.
EndpointsApi endpoints_tech_get GET /endpoints/{tech} List available endoints for a given endpoint technology.
EndpointsApi endpoints_tech_resource_get GET /endpoints/{tech}/{resource} Details for an endpoint.
EndpointsApi endpoints_tech_resource_send_message_put PUT /endpoints/{tech}/{resource}/sendMessage Send a message to some endpoint in a technology.
EventsApi events_get GET /events WebSocket connection for events.
EventsApi events_user_event_name_post POST /events/user/{eventName} Generate a user event.
MailboxesApi mailboxes_get GET /mailboxes List all mailboxes.
MailboxesApi mailboxes_mailbox_name_delete DELETE /mailboxes/{mailboxName} Destroy a mailbox.
MailboxesApi mailboxes_mailbox_name_get GET /mailboxes/{mailboxName} Retrieve the current state of a mailbox.
MailboxesApi mailboxes_mailbox_name_put PUT /mailboxes/{mailboxName} Change the state of a mailbox. (Note - implicitly creates the mailbox).
PlaybacksApi playbacks_playback_id_control_post POST /playbacks/{playbackId}/control Control a playback.
PlaybacksApi playbacks_playback_id_delete DELETE /playbacks/{playbackId} Stop a playback.
PlaybacksApi playbacks_playback_id_get GET /playbacks/{playbackId} Get a playback's details.
RecordingsApi recordings_live_recording_name_delete DELETE /recordings/live/{recordingName} Stop a live recording and discard it.
RecordingsApi recordings_live_recording_name_get GET /recordings/live/{recordingName} List live recordings.
RecordingsApi recordings_live_recording_name_mute_delete DELETE /recordings/live/{recordingName}/mute Unmute a live recording.
RecordingsApi recordings_live_recording_name_mute_post POST /recordings/live/{recordingName}/mute Mute a live recording.
RecordingsApi recordings_live_recording_name_pause_delete DELETE /recordings/live/{recordingName}/pause Unpause a live recording.
RecordingsApi recordings_live_recording_name_pause_post POST /recordings/live/{recordingName}/pause Pause a live recording.
RecordingsApi recordings_live_recording_name_stop_post POST /recordings/live/{recordingName}/stop Stop a live recording and store it.
RecordingsApi recordings_stored_get GET /recordings/stored List recordings that are complete.
RecordingsApi recordings_stored_recording_name_copy_post POST /recordings/stored/{recordingName}/copy Copy a stored recording.
RecordingsApi recordings_stored_recording_name_delete DELETE /recordings/stored/{recordingName} Delete a stored recording.
RecordingsApi recordings_stored_recording_name_file_get GET /recordings/stored/{recordingName}/file Get the file associated with the stored recording.
RecordingsApi recordings_stored_recording_name_get GET /recordings/stored/{recordingName} Get a stored recording's details.
SoundsApi sounds_get GET /sounds List all sounds.
SoundsApi sounds_sound_id_get GET /sounds/{soundId} Get a sound's details.

Documentation For Models

Documentation For Authorization

basicAuth

  • Type: HTTP basic authentication

Author

About

Asyncio Asterisk ARI Library

Resources

Readme
Activity

Stars

3 stars

Watchers

1 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages