Public API

The public API allows things such as getting BLF status, the current directory, and more.

BLF

You can view the status of every extension on the system using BLFs. BLFs are posted in XML format and are updated every 5-10 seconds.

Format

<blfStatus>
 <extension number="1000" status="Offline"/>
 <extension number="1001" status="Ready"/>
 <extension number="1002" status="Do not disturb"/>
 <extension number="1003" status="Off hook"/>
 <extension number="1004" status="On the phone"/>
 <extension number="1005" status="On hold"/>
 <extension number="1006" status="Ringing"/>
 <extension number="1007" status="ChanSpy"/>
</blfStatus>

            

There are more BLF status messages possible then the ones above, however, these are the most common. Make sure your application has the ablity to parse any status to prevent errors.

XML Format: https://communitypbx.captainchris.me/blf.xml

Directory

The directory API shows every single extension vissible on /directory and is automaticly updated and posted in XML format. Please note the directory API XML format is not desgined to be directly put onto a phone. Please see Directory on Phones.