Action URL & URI

Owned by HTEK_admin (Unlicensed)
Last updated: Dec 13, 2024 by HTEK
3 min read

This paper is mainly introduce how to make a call by URL command.

1. Action URL

Record the operation of phone, send these corresponding information to server; action
1.1 To configure Action URL via web interface:
1) Choose Setting->Action URL
2) Enter the Corresponding contents.
3) Click SaveSet to save the changes.

1.2 The Action URL variables supported are:
$mac --> current MAC address of the phone
$ip --> current IP address of the phone
$model --> the phone model
$firmware --> current firmware version of the phone
$active_url --> the SIP URI of the active outgoing identity
$active_user --> the user part of the SIP URI for the active outgoing identity
$active_host --> the host part of the SIP URI for the active outgoing identity
$local --> the SIP URI of the local identity (your phone's number)
$remote --> the SIP URI of the remote identity (the other party's phone number)
$display_local --> used to display your phone's display name
$display_remote --> used to display the other party's display name
$call_id --> the call-id of the active call
For example:
The action URL format is http://server ip address/variable value…
When set the following Action URL to the IP Phone(UC860, MAC-001FC11A8B6C, IP-192.168.0.157) incoming call:
192.168.0.252/$mac/$ip
When other phone call the ip phone then
192.168.0.252/ 001fc11a8b6c/192.168.0.157

2. URI: Remote control phone for corresponding operation

2.1 Dial out & Hang up

Please use the following URL to dial out or hang up a call.
http://admin:password@IP_Address/Phone_ActionURL&Command=%command%&Number=%number%&Account=%account%
For example:
When use the phone which IP address is 192.168.0.124 to call the number 206 via the account 1, the action URI is:
http://admin:admin@192.168.0.124/Phone_ActionURL&Command=1&Number=206&Account=1

Notes:
1. By default the password for admin is admin, you can use also user: 1234 to dial out a call.
2. Command=1 means dial out ; Command=2 means hang up
3. Number: the number which you want to dial out
4. Account: the account which you want to user for dial out, pay attention:
account=1, it match the account 1;
account=2, it match the account2;
account=3, it match the account3;
account=4, it match the account4;
If do not mentioned one specific Account or not match the value above, it will choose an avalible account automatically.

2.2 The other actions:

2.2.1 The URI format is as follow:
http://admin:password@IP_Address/Phone_ActionURL&Command=%command%&key=%key_vaule%

Notes:
1. Command=3 means the other actions;

2. You also can input the URI as follows for this action fuction: http://admin:password@IP_Address/Phone_ActionURL&key=%key_vaule%


2.2.2 the current support key
To answer the call:          key=OK/key=ENTER
To turn on speaker mode:    key=SPEAKER
Press transfer button:       key=F_TRANSFER
Increasing the volume:      key=VOLUME_UP
Reduce the volume:        key=VOLUME_DOWN
To mute the call:           key=MUTE
To hold the call:           key=F_HOLD
To end the call:            key=X
To enter the DTMF number(include Numeric, * or # keys):  key=0-9 * POUND
Press a line key:            key=L1-L4
Press a DSS key:            key=D1-D10
Press Conference button:    key=F_CONFERENCE
Press a soft key:            key=F1-F4
Press Message button:       key=MSG
Press Headset button:       key=HEADSET
Press RD button:            key=RD
Press navigation key:        key=UP/ DOWN/ LEFT/ RIGHT
To reboot the phone:        key=Reboot
To check the Auto provision:  key=AutoP
To enable DND:              key=DNDOn
To disable DND:             key=DNDOff
For example:
When use the "action URI" to mute the call, you can send the action URI as follows:
http://admin:password@IP_Address/Phone_ActionURL&key=MUTE

Notes:
1. The URI is case sensitive
2. In IDLE status, if you input the URI with key=OK or key = ENTER, the effect is the same as you press "ok" button in the idle status (access to the Status page).
3. In IDLE status, if you input the URI for key=X, the phone will prompt if you want to reboot since it is the same as long press the X or C button. Then you need to input key=OK or ENTER to confirm the warning.