beautypg.com

Introduction – Grandstream UCM6100 Asterisk Manager Interface (AMI) Guide User Manual

Page 4

background image

UCM6100 Asterisk Manager Interface (AMI) Guide Page 3 of 14

INTRODUCTION

Asterisk Manager Interface (AMI) allows a client program to connect to an Asterisk instance and issue

commands or read events over a TCP/IP stream. This is particularly useful when the integrators try to track

the state of a telephony client inside Asterisk.


A simple “key: value” line-based protocol is utilized for communication between the connecting client and

the Asterisk PBX. Lines are terminated by using CR/LF. In this document, we will use the term "packet" to

describe a set of "key: value" lines that are terminated by an extra CR/LF.

Some useful Asterisk Manager Interface information can be found in the following links:

http://www.voip-info.org/wiki/view/Asterisk+manager+API

https://wiki.asterisk.org/wiki/pages/viewpage.action?pageId=4817239

The UCM6100 provides restricted AMI access for users. In order to connect to Asterisk Manager Interface

on UCM6100, please follow the steps below.

1. Create new AMI user.

2. Configure AMI ports for connection.

3. Establish connection and authenticate the user.

This document introduces each step and necessary configurations in the following sections.

Warning:

Please do not enable AMI on the UCM6100 if it is placed on a public or untrusted network unless you have

taken steps to protect the device from unauthorized access. It is crucial to understand that AMI access can

allow AMI user to originate calls and the data exchanged via AMI is often very sensitive and private for your

UCM6100 system. Please be cautious when enabling AMI access on the UCM6100 and restrict the

permission granted to the AMI user. By using AMI on UCM6100 you agree you understand and

acknowledge the risks associated with this.