Asterisk Manager Interface (AMI) Overview

The Asterisk Manager Interface (AMI) is a system monitoring and management interface provided by Asterisk. Yeastar P-Series Cloud Edition supports AMI that allows you to connect an AMI client to Yeastar P-Series Cloud Edition.

What is Asterisk Manager Interface (AMI)

Asterisk Manager Interface (AMI) is a standard management interface into Asterisk server. It is a client/server model over TCP that allows a client program to connect to an Asterisk server and issue commands or read events over a TCP/IP stream. With the manager interface, you can control the PBX, originate calls, check mailbox status, monitor extensions and so on.

Connect to Yeastar P-Series Cloud Edition via AMI

  1. Enable AMI on PBX.
    1. Log in to PBX web portal, go to Integrations > AMI.
    2. Enable AMI.
    3. In the AMI section, configure the connection authentication.
      • Username: Enter the username that can be used by third party to access the AMI of PBX.
      • Password: Enter the password that can be used by third party to access the AMI of PBX.
    4. In the Permitted IP section, set which clients are allowed to access the AMI of PBX.
      1. In the IP Address field, click Add.
      2. Enter the IP address or IP section that is allowed to access the AMI of PBX.

        The input format should be XXX.XXX.XXX.XXX.

        For example: IP address 216.207.245.47 with subnet mask 255.255.255.255 means that only the device with IP address 216.207.245.47 is allowed to access the PBX via AMI.

        Note: You can add up to 4 permitted IP addresses.
    5. Click Save and Apply.

      The Server Address and Port of the PBX will be displayed on the web page and can NOT be modified.

  2. Configure AMI client with the authentication information provided on PBX, and connect client to PBX.