Matt Jordan
Matt Jordan is an Engineering Manager for the Open Source Software team at Digium, working on Asterisk. Matt joined the...
Read Full Bio >>

Matt Jordan | October 30, 2013 |


Asterisk REST Interface: Providing a Complete Toolkit for Building Business Communications Apps

Asterisk REST Interface: Providing a Complete Toolkit for Building Business Communications Apps The new interface opens Asterisk up not only to the existing community of users and developers, but also to a much wider audience of business app developers.

The new interface opens Asterisk up not only to the existing community of users and developers, but also to a much wider audience of business app developers.

At this year's 10th-anniversary AstriCon, developers, business leaders and Asterisk users from around the world converged on Atlanta for three days of communications and VoIP discussions. Although many exciting announcements were made at AstriCon, the one generating the most interest from conference-goers involved a new API, the Asterisk REST Interface (ARI), which was made available in the first beta release of Asterisk 12.

What is ARI? And why did Asterisk need a new API?

Asterisk has traditionally had two interfaces: the Asterisk Manager Interface (AMI) and Asterisk Gateway Interface (AGI). AMI is typically used for call control and system inspection; AGI is typically used to control execution of a single channel in Asterisk.

Both are great at manipulating channels to execute the existing dialplan applications in Asterisk, and can be used to customize and control Asterisk. However, actually replacing an existing dialplan application using either--or both--interfaces can be challenging. With the existing interfaces, you can control how a channel enters into a dialplan application such as Queue or Voice Mail, but it is far more challenging to replace those dialplan applications with an externally-controlled version.

This is where ARI enters the API space in Asterisk. It is not a replacement for either AMI or AGI. It does not control how a channel enters into a dialplan application; rather, it allows a developer to replace that dialplan application with a custom, externally controlled application that they've developed. ARI simplifies development for business application developers who use Asterisk as a communications platform.

ARI does this by giving developers a high-level REST interface that permits them to control Asterisk's fundamental operations. This includes channel and bridge manipulation, endpoint inspection, asynchronous media control, media recording, and much more. Information about these entities being controlled by the developer is conveyed asynchronously via JSON events over a WebSocket.

The asynchronous events provide a developer who is using ARI with up-to-date information about those parts of Asterisk that they want to control. The REST interface provides an intuitive interface to enact that control. This gives developers a complete toolkit for building custom communications applications.

Previously, the level of control enabled by ARI had been reserved for C programmers who built dialplan application modules that were directly linked into Asterisk. Using ARI, powerful communications applications can now be quickly and easily built using common development languages such as Python, Ruby, PHP and JavaScript.

We in the Asterisk Developer Community are excited about the new capabilities in Asterisk 12 afforded by ARI. The new interface opens Asterisk up not only to the existing Asterisk community of users and developers, but also to a much wider audience of business application developers. It promises to be an exciting year of application development using Asterisk, and we will be thrilled to see what people build using Asterisk and ARI over the months to come!

Comments shared on Twitter from community members at AstriCon:

Steve Davies
Asterisk 12 ARI: Asterisk REST Interface. How nice is that? A well designed REST interface for 3rd party call control and app development!

Ben Klang
The best news out of #Astricon: @Asterisk 12 with ARI. Can't wait to get @Adhearsion talking to this.


Enterprise Connect Orlando 2018
March 12-15 | Orlando, FL

Connect with the Entire Enterprise Communications & Collaboration Ecosystem

Stay Up-to-Date: Hear industry visionaries in Keynotes and General Sessions delivering the latest insight on UC, mobility, collaboration and cloud

Grow Your Network: Connect with the largest gathering of enterprise IT and business leaders and influencers

Learn From Industry Leaders: Attend a full range of Conference Sessions, Free Programs and Special Events

Evaluate All Your Options: Engage with 190+ of the leading equipment, software and service providers

Have Fun! Mingle with sponsors, exhibitors, attendees, guest speakers and industry players during evening receptions

Register now with code NOJITTEREB to save $200 Off Advance Rates or get a FREE Expo Pass!

December 13, 2017

The two major vendors in the Unified Communications space, Cisco and Microsoft, are both strongly promoting their cloud UC deployments. If cloud UC is on your enterprises roadmap, but you dont want

November 29, 2017

As video conferencing use rises in the enterprise, businesses are looking for ways to bring this technology out of traditional conference room and make it more broadly accessible. That's made the h

November 1, 2017

Your customers (internal and external) demand that you offer them the ability to connect by any means. With the adoption of cloud communications tools you now have access to an expanded portfolio o

November 30, 2017
With a ruling on the FCC's proposed order to dismantle the Open Internet Order expected this month, communications technology attorney Martha Buyer walks us through what's at stake.
October 23, 2017
Wondering which Office 365 collaboration tool to use when? Get quick pointers from CBT Nuggets instructor Simona Millham.
September 22, 2017
In this podcast, we explore the future of work with Robert Brown, AVP of the Cognizant Center for the Future of Work, who helps us answer the question, "What do we do when machines do everything?"
September 8, 2017
Greg Collins, a technology analyst and strategist with Exact Ventures, delivers a status report on 5G implementation plans and tells enterprises why they shouldn't wait to move ahead on potential use ....
August 25, 2017
Find out what business considerations are driving the SIP trunking market today, and learn a bit about how satisfied enterprises are with their providers. We talk with John Malone, president of The Ea....
August 16, 2017
World Vision U.S. is finding lots of goodness in RingCentral's cloud communications service, but as Randy Boyd, infrastructure architect at the global humanitarian nonprofit, tells us, he and his team....
August 11, 2017
Alicia Gee, director of unified communications at Sutter Physician Services, oversees the technical team supporting a 1,000-agent contact center running on Genesys PureConnect. She catches us up on th....
August 4, 2017
Andrew Prokop, communications evangelist with Arrow Systems Integration, has lately been working on integrating enterprise communications into Internet of Things ecosystems. He shares examples and off....
July 27, 2017
Industry watcher Elka Popova, a Frost & Sullivan program director, shares her perspective on this acquisition, discussing Mitel's market positioning, why the move makes sense, and more.
July 14, 2017
Lantre Barr, founder and CEO of Blacc Spot Media, urges any enterprise that's been on the fence about integrating real-time communications into business workflows to jump off and get started. Tune and....
June 28, 2017
Communications expert Tsahi Levent-Levi, author of the popular blog, keeps a running tally and comprehensive overview of communications platform-as-a-service offerings in his "Choosing a W....
June 9, 2017
If you think telecom expense management applies to nothing more than business phone lines, think again. Hyoun Park, founder and principal investigator with technology advisory Amalgam Insights, tells ....
June 2, 2017
Enterprises strategizing on mobility today, including for internal collaboration, don't have the luxury of learning as they go. Tony Rizzo, enterprise mobility specialist with Blue Hill Research, expl....
May 24, 2017
Mark Winther, head of IDC's global telecom consulting practice, gives us his take on how CPaaS providers evolve beyond the basic building blocks and address maturing enterprise needs.
May 18, 2017
Diane Myers, senior research director at IHS Markit, walks us through her 2017 UC-as-a-service report... and shares what might be to come in 2018.
April 28, 2017
Change isn't easy, but it is necessary. Tune in for advice and perspective from Zeus Kerravala, co-author of a "Digital Transformation for Dummies" special edition.
April 20, 2017
Robin Gareiss, president of Nemertes Research, shares insight gleaned from the firm's 12th annual UCC Total Cost of Operations study.
March 23, 2017
Tim Banting, of Current Analysis, gives us a peek into what the next three years will bring in advance of his Enterprise Connect session exploring the question: Will there be a new model for enterpris....
March 15, 2017
Andrew Prokop, communications evangelist with Arrow Systems Integration, discusses the evolving role of the all-important session border controller.
March 9, 2017
Organizer Alan Quayle gives us the lowdown on programmable communications and all you need to know about participating in this pre-Enterprise Connect hackathon.
March 3, 2017
From protecting against new vulnerabilities to keeping security assessments up to date, security consultant Mark Collier shares tips on how best to protect your UC systems.
February 24, 2017
UC analyst Blair Pleasant sorts through the myriad cloud architectural models underlying UCaaS and CCaaS offerings, and explains why knowing the differences matter.
February 17, 2017
From the most basics of basics to the hidden gotchas, UC consultant Melissa Swartz helps demystify the complex world of SIP trunking.
February 7, 2017
UC&C consultant Kevin Kieller, a partner at enableUC, shares pointers for making the right architectural choices for your Skype for Business deployment.
February 1, 2017
Elka Popova, a Frost & Sullivan program director, shares a status report on the UCaaS market today and offers her perspective on what large enterprises need before committing to UC in the cloud.
January 26, 2017
Andrew Davis, co-founder of Wainhouse Research and chair of the Video track at Enterprise Connect 2017, sorts through the myriad cloud video service options and shares how to tell if your choice is en....
January 23, 2017
Sheila McGee-Smith, Contact Center/Customer Experience track chair for Enterprise Connect 2017, tells us what we need to know about the role cloud software is playing in contact centers today.