User Tools

Site Tools


api:mixpbxapi:external-url-api

External URL API

The MIXpbx has the ability to call a web URL at every incoming call. The web URL can return several parameters which the MIXpbx uses to change the callerID. This feature can be used to connect the MIXpbx to your CRM or to trigger external actions.

You can define the external URL in our web interface inside the configuration section.

Parameters provided by the MIXpbx

  • calleridnum
    • The number of the calling party
  • calleridname
    • The name of the calling part
  • extension
    • The called extension on the MIXpbx


Example:
http://www.yourdomain.com/cid.php?customparameter=2&calleridnum=&calleridname=MIXvoip&extension=20

Return options

The MIXpbx expects a simple text return with no mandatory parameters. Available parameters are:

  • CALLERIDNUM
  • CALLERIDNAME
  • HANGUP
    • Values can be TRUE or FALSE

Example:
CALLERIDNUM=
CALLERIDNAME=MIXVOIP
HANGUP=FALSE

api/mixpbxapi/external-url-api.txt · Last modified: 2016/11/25 08:50 by vbuclier