Parameter DBID_ACTIONURL_HOLD_STOP
Description It configures the action URL the phone sends when resuming a hold call.
Example: DBID_ACTIONURL_HOLD_STOP = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Off-hook
Parameter DBID_ACTIONURL_HOOKON
Description It configures the action URL the phone sends when on hook.
Example: DBID_ACTIONURL_HOOKON = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > On-hook
Parameter DBID_ACTIONURL_DIALING
Description It configures the action URL the phone sends when placing a call.
Example: DBID_ACTIONURL_DIALING = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Outgoing Call
Parameter DBID_ACTIONURL_RING
Description It configures the action URL the phone sends when receiving an incoming call.
Example: DBID_ACTIONURL_RING = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Incoming Call
Parameter DBID_ACTIONURL_CONNECTED
Description It configures the action URL the phone sends when establishing a call.
Example: DBID_ACTIONURL_CONNECTED = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Established
Parameter DBID_ACTIONURL_DISCONNECTED
Description It configures the action URL the phone sends when terminating a call.
Example: DBID_ACTIONURL_DISCONNECTED = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Terminated
Parameter DBID_ACTIONURL_MISSREMIND
Description It configures the action URL the phone sends when missing a call.
Example: DBID_ACTIONURL_MISSREMIND = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Missed Call
Parameter DBID_ACTIONURL_DND_ENABLE
Description It configures the action URL the phone sends when DND feature is activated.
Example: DBID_ACTIONURL_DND_ENABLE = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Activate DND
Parameter DBID_ACTIONURL_DND_DISABLE
Description It configures the action URL the phone sends when DND feature is deactivated.
Example: DBID_ACTIONURL_DND_DISABLE = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > De-activate DND
Parameter DBID_ACTIONURL_CFWD_ALL_ENABLE
Description It configures the action URL the phone sends when the always forward feature is activated.
Example: DBID_ACTIONURL_CFWD_ALL_ENABLE = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Activate Always Forward
Parameter DBID_ACTIONURL_CFWD_ALL_DISABLE
Description It configures the action URL the phone sends when the always forward feature is deactivated.
Example: DBID_ACTIONURL_CFWD_ALL_DISABLE = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > De-activate Always Forward
Parameter DBID_ACTIONURL_CFWD_BUSY_ENABLE
Description It configures the action URL the phone sends when the busy forward feature is activated.
Example: DBID_ACTIONURL_CFWD_BUSY_ENABLE = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Activate Busy Forward
Parameter DBID_ACTIONURL_CFWD_BUSY_DISABLE
Description It configures the action URL the phone sends when the busy forward feature is deactivated.
Example: DBID_ACTIONURL_CFWD_BUSY_DISABLE = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > De-activate Busy Forward
Parameter DBID_ACTIONURL_CFWD_NO_ANS_ENABLE
Description It configures the action URL the phone sends when the no answer forward feature is activated.
Example: DBID_ACTIONURL_CFWD_NO_ANS_ENABLE = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Activate No Answer Forward
Parameter DBID_ACTIONURL_CFWD_NO_ANS_DISABLE
Description It configures the action URL the phone sends when the no answer forward feature is deactivated.
Example: DBID_ACTIONURL_CFWD_NO_ANS_DISABLE = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > De-activate Busy Forward
Parameter DBID_ACTIONURL_HOLD_START
Description It configures the action URL the phone sends when placing a call on hold.
Example: DBID_ACTIONURL_HOLD_START = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Hold
Parameter DBID_ACTIONURL_HOLD_STOP
Description It configures the action URL the phone sends when resuming a hold call.
Example: DBID_ACTIONURL_HOLD_STOP = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Unhold
Parameter DBID_ACTIONURL_REGISTERED
Description It configures the action URL the phone sends after an account is registered.
Example: DBID_ACTIONURL_REGISTERED = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Registered
Parameter DBID_ACTIONURL_UNREGISTERED
Description It configures the action URL the phone sends after an account is unregistered.
Example: DBID_ACTIONURL_UNREGISTERED = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Registration Failed
Parameter DBID_ACTIONURL_DISABLEREGISTERED
Description It configures the action URL the phone sends after a register failed.
Example: DBID_ACTIONURL_DISABLEREGISTERED = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Unregistered
Parameter DBID_ACTIONURL_TRANSFER
Description It configures the action URL the phone sends when performing a transfer.
Example: DBID_ACTIONURL_TRANSFER = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Transfer Call
Parameter DBID_ACTIONURL_BLIND_TRANSFER
Description It configures the action URL the phone sends when performing a blind transfer.
Example: DBID_ACTIONURL_BLIND_TRANSFER = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Blind Transfer
Parameter DBID_ACTIONURL_ATTENDED_TRANSFER
Description It configures the action URL the phone sends when performing an attended/semi-attended transfer.
Example: DBID_ACTIONURL_ATTENDED_TRANSFER = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Attended Transfer
Parameter DBID_ACTIONURL_IDLE_TO_BUSY
Description It configures the action URL the phone sends when changing the state of the phone from idle to busy.
Example: DBID_ACTIONURL_IDLE_TO_BUSY = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Idle to Busy
Parameter DBID_ACTIONURL_BUSY_TO_IDLE
Description It configures the action URL the phone sends when changing the state of the IP phone from busy to
idle.
Example: DBID_ACTIONURL_BUSY_TO_IDLE = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Busy to Idle
Parameter DBID_ACTIONURL_SETUP_COMPLETED
Description It configures the action URL the phone sends after startup.
Example: DBID_ACTIONURL_SETUP_COMPLETED = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > Setup Completed
Parameter DBID_ACTIONURL_IP_CHANGE
Description It configures the action URL the phone sends when changing the IP address of the phone.
Example: DBID_ACTIONURL_IP_CHANGE = http://192.168.20.76/help.xml?IP=$ip
Permitted Values URL
Default Blank
Web UI Phone > Action URL > URL Config > IP Changed
Parameter ACTIONURL_ALLOW_IP
Description It configures server address from which the phone receives the action URI requests.
Permitted Values IP Address
Default Blank
Web UI Phone > Action URL > Remote Control > Action URL allow IP List

Action URL :

Action URL allows the phones to interact with web server applications by sending an HTTP or HTTPS GET request.
You can specify a URL that triggers a GET request when a specified event occurs. Action URL can only be triggered by the predefined events. The valid URL format is:http(s):///help.xml?.

Event list

Event Name Event description
Event description resume a hold call
On-hook On-hook
Outgoing Call place a call
Incoming Call receive an incoming call
Established establish a call
Terminated terminate a call
Missed Call miss a call
Activate DND enable DND
De-activate DND Diable DND
Activate Always Forward the always forward feature is activated
De-activate Always Forward the always forward feature is deactivated
Activate Busy Forward the busy forward feature is activated
De-activate Busy Forward the busy forward feature is deactivated
Activate No Answer Forward the no answer forward feature is activated
De-activate No Answer Forward the no answer forward feature is deactivated
Hold place a call on hold
Unhold resume a hold call
Registered account registered successfully
Registration Failed account register failed
Unregistered account registered unsuccessfully
Transfer Call perform a transfer
Blind Transfer perform a blind transfer
Attended Transfer perform an attended/semi-attended transfer
Idle to Busy change the state of the phone from idle to busy
Busy to Idle change the state of the IP phone from busy to idle
Setup Completed Perform Startup
IP Changed change the IP address of the phone

Variable list

name description
$mac The MAC address of the IP phone.
$ip The IP address of the IP phone.
$model The IP phone model.
$firmware The firmware version of the IP phone.
$active_url The SIP URI of the current account when the IP phone places a call, receives an incoming call or establishes a call.
$active_user The user part of the SIP URI for the current account when the IP phone places a call, receives an incoming call or establishes a call.
$active_host The SIP URI of the caller when the IP phone places a call.
The SIP URI of the callee when the IP phone receives an incoming call.
$local The SIP URI of the caller when the IP phone places a call.
The SIP URI of the callee when the IP phone receives an incoming call.
$remote The SIP URI of the callee when the IP phone places a call.
The SIP URI of the caller when the IP phone receives an incoming call.
$display_local The display name of the caller when the IP phone places a call.
The display name of the callee when the IP phone receives an incoming call.
$display_remote The display name of the callee when the IP phone places a call.
The display name of the caller when the IP phone receives an incoming call.
$call_id The call-id of the active call.

Active URI :

Active URI :The remote console controls various operations on the phone.
Opposite to action URL, action URI allows the phones to interact with a web server application by
receiving and handling an HTTP or HTTPS GET request.

1、Active URI description:

ActiveURI format:“http://192.168.1.190/cgi-bin/ConfigManApp.com?key=OK”
①“192.168.1.190”is the IP address of IP phone
②“/cgi-bin/ConfigManApp.com”is Active URI
③“?key=OK”is the type of command, which stands the performing action.(In general, this command is a keystroke event)。

For security purposes, when the URI function is used, the login page is displayed. In this case, you only need to enter the account and password to perform operations on the phone through the Active URI.(user/password: admin/admin)

Variable Value :

Variable name Phone Action
key=ok key=Enter
key=F_TRANSFER Transfer a call to another party.
key=VOLUME_UP Increase the volume.
key=VOLUME_DOWN Decrease volume.
key=MUTE Mute a call.
key=F_HOLD Place an active call on hold.
key=X Cancel actions, reject incoming calls or mute or un-mute calls.
key=F_CONFERENCE Press the Conf/Conference soft key.
key=F1 Press the softkey 1
key=F2 Press the softkey 2
key=F3 Press the softkey 3
key=F4 Press the softkey 4
key=MSG Press the MESSAGE key.
key=HEADSET Press the HEADSET key.
key=RD Press the RD/Redial key.
key=UP/DOWN/LEFT/RIGHT Press the navigation keys.
key=Reboot Reboot the phone.
key=AutoP Perform auto provisioning.
key=DNDOn Activate the DND feature.
key=DNDOff Deactivate the DND feature.
key=0-9 Press the number key.
key=* Press the * key.
key=POUND Press the # key.
key=L1-L8 Press the line keys.
key=D1-D10 Press the DSS key.

2、Active URI supports dialing numbers:

The Active URI command can send only one operation event to the phone at a time. For example, when entering a number, you need to enter one key at a time. Therefore, Active URIs also support the direct number filling in the URI call.
http://phoneIP/cgi-bin/ConfigManApp.com?number=xxx&outgoing_uri=xxx
The phoneIP is the IP address of the phone,number=xxx is the number you want to dial(8530),outgoing_uri=xxx is the account to dial(8532@192.168.1.199)。

For example:
3@192.168.20.22"target="_blank"">http://192.168.20.177/cgi-bin/ConfigManApp.com?number=2&outgoing_uri=3@192.168.20.22
number=2 indicates that the outgoing number is 2,3@192.168.20.22"">outgoing_uri=3@192.168.20.22: the used account number is 3 . @is the associator. 192.168.20.22 is the IP address of PBX

Author:admin  Create time:2023-09-19 10:13
Last editor:admin  Update time:2024-07-29 16:00