Awesome Open Source
Awesome Open Source

================= Python AMI Client

.. image:: https://travis-ci.org/ettoreleandrotognoli/python-ami.svg?branch=master :target: https://travis-ci.org/ettoreleandrotognoli/python-ami

.. image:: https://codecov.io/gh/ettoreleandrotognoli/python-ami/branch/master/graph/badge.svg :target: https://codecov.io/gh/ettoreleandrotognoli/python-ami

.. image:: https://badge.fury.io/py/asterisk-ami.svg :target: https://badge.fury.io/py/asterisk-ami

.. image:: https://img.shields.io/pypi/dm/asterisk-ami.svg :target: https://pypi.python.org/pypi/asterisk-ami#downloads

.. image:: https://api.codeclimate.com/v1/badges/429cda25d75ab470d7f6/maintainability :target: https://codeclimate.com/github/ettoreleandrotognoli/python-ami/maintainability :alt: Maintainability

.. image:: https://api.codeclimate.com/v1/badges/429cda25d75ab470d7f6/test_coverage :target: https://codeclimate.com/github/ettoreleandrotognoli/python-ami/test_coverage :alt: Test Coverage

.. image:: https://www.codefactor.io/repository/github/ettoreleandrotognoli/python-ami/badge :target: https://www.codefactor.io/repository/github/ettoreleandrotognoli/python-ami :alt: CodeFactor

A simple Python AMI client http://programandonoaquario.blogspot.com.br

See the code of conduct <CODE_OF_CONDUCT.md>_.

Install

Install asterisk-ami

.. code-block:: shell

pip install asterisk-ami

Install latest asterisk-ami

.. code-block:: shell

pip install git+https://github.com/ettoreleandrotognoli/python-ami

Usage

Connect


.. code-block:: python

    from asterisk.ami import AMIClient
    
    client = AMIClient(address='127.0.0.1',port=5038)
    client.login(username='username',secret='password')
    
Disconnect

.. code-block:: python

client.logoff()

Send an action


.. code-block:: python

    from asterisk.ami import SimpleAction
    
    action = SimpleAction(
        'Originate',
        Channel='SIP/2010',
        Exten='2010',
        Priority=1,
        Context='default',
        CallerID='python',
    )
    client.send_action(action)


Send an action with adapter

.. code-block:: python

from asterisk.ami import AMIClientAdapter

adapter = AMIClientAdapter(client)
adapter.Originate(
    Channel='SIP/2010',
    Exten='2010',
    Priority=1,
    Context='default',
    CallerID='python',
)

Synchronous Response


.. code-block:: python

    #without adapter
    future = client.send_action(action)
    response = future.response
    
    #with adapter
    future = adapter.Originate(...)
    response = future.response
    

Asynchronous Response

.. code-block:: python

def callback_response(response):
    print(response)

#without adapter
future = client.send_action(action,callback=callback_response)

#with adapter
future = adapter.Originate(...,_callback=callback_response)

#you can use the future to wait the callback execute
reponse = future.response

Listen Events


.. code-block:: python

    def event_listener(event,**kwargs):
        print(event)

    client.add_event_listener(event_listener)
    

Filter Events

With a custom class

.. code-block:: python

from asterisk.ami import EventListener

class RegistryEventListener(EventListener):

    def on_Registry(event,**kwargs):
        print('Registry Event',event)
        
client.add_event_listener(RegistryEventListener())

class AllEventListener(EventListener):

    def on_event(event,**kwargs):
        print('Event',event)

client.add_event_listener(AllEventListener())

With black or white list

.. code-block:: python

def event_listener(event,**kwargs):
    print(event)
    
client.add_event_listener(
    event_listener, white_list=['Registry','PeerStatus']
)

client.add_event_listener(
    event_listener, black_list=['VarSet']
)

Like a custom class

.. code-block:: python

def event_listener(event,**kwargs):
    print(event)
    
client.add_event_listener(
    on_VarSet=event_listener,
    on_ExtensionStatus=event_listener
)

client.add_event_listener(
    on_event=event_listener
)

Filter Event Value


.. code-block:: python

    def event_listener(event,**kwargs):
        print('Ringing',event)
        
    
    client.add_event_listener(
        event_listener,
        white_list='Newstate',
        ChannelStateDesc='Ringing',
        ConnectedLineNum='2004',
    )
    
Filter with regex
~~~~~~~~~~~~~~~~~

.. code-block:: python

    import re
    
    def event_listener(event,**kwargs):
        print(event)
        
    client.add_event_listener(
        on_Newstate=event_listener,
        white_list=re.compile('.*'),
        ChannelStateDesc=re.compile('^Ring.*'),
    )
    
    

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
python (49,729
asterisk (28
ami (15

Find Open Source By Browsing 7,000 Topics Across 59 Categories