Advanced Features
476
Action URI
Yealink phones can perform the specified action by receiving and handling an HTTP or HTTPS GET request or
accept a SIP NOTIFY message with the “Event: ACTION-URI” header from a SIP proxy server.
Topics
Supported HTTP/HTTPS GET Request
Supported SIP Notify Message
Variable Values List
Action URI Configuration
Example: Capturing the Current Screen of the Phone
Example: Placing a Call via Web User Interface
Supported HTTP/HTTPS GET Request
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. When receiving a GET request, the phone will perform the specified
action and respond with a 200 OK message.
A GET request may contain a variable named as “key” and a variable value, which are separated by “=”. The valid
URI format is: http(s)://<phoneIPAddress>/servlet?key=variable value. For example
http://10.3.20.10/ser-
vlet?key=OK
.
Note
: Yealink phones are compatible with other two old valid URI formats: http(s)://<phoneIPAddress>/cgi-bin/Con-
figManApp.com?key=variable value and http(s)://<phoneIPAddress>/cgi-bin/cgiServer.exx?key=variable value.
For security reasons, the phones do not handle HTTP/HTTPS GET requests by default. You need to specify the trus-
ted IP address for action URI. When the IP phone receives a GET request from the trusted IP address for the first
time, the phone screen prompts the message “Allow remote control?”. Select the OK soft key on the phone to allow
remote control. You can specify one or more trusted IP addresses on the IP phone, or configure the IP phone to
receive and handle the URI from any IP address.
Supported SIP Notify Message
In addition, Yealink phones can perform the specified action immediately by accepting a SIP NOTIFY message with
the “Event: ACTION-URI” header from a SIP proxy server. The message body of the SIP NOTIFY message may con-
tain a variable named as “key” and a variable value, which are separated by “=”.
This method is especially useful for users who always work in the small office/home office where a secure firewall
may prevent the HTTP or HTTPS GET request from the external network.
Note
: If you want to only accept the SIP NOTIFY message from your SIP server and outbound proxy server, you have to
enable the Accept SIP Trust Server Only feature. For more information, refer to
If you use SIP NOTIFY message method, you do not need to specify the trusted IP address for action URI. However,
you should enable the IP phone to receive the action URI requests. When the IP phone receives a SIP NOTIFY mes-
sage with the “Event: ACTION-URI” header from a SIP proxy server for the first time, the LCD screen also prompts
the message “Allow remote control?”. Select the OK soft key on the phone to allow remote control.
Example of a SIP Notify with the variable value (OK):
Message Header
NOTIFY sip:[email protected]:5062 SIP/2.0
Via: SIP/2.0/UDP 10.2.40.27:5063;branch=z9hG4bK4163876675
From: <sip:[email protected] > ;tag=2900480538
To: "3583" <sip:[email protected] > ;tag=490600926
Call-ID: [email protected]
CSeq: 4 NOTIFY