Skip to main content

How To: Remotely Control a Yealink Device (Action URI)

Cam
  • Updated

Jump To Section

Information

Yealink phones support a combination of the variable values entered via an HTTP GET request that in turn can control the phone remotely.

 

Enablement

The following table lists the parameters you can use to configure action URI.

Parameter features.action_uri.enable
Description It enables or disables the phone to receive the action URI requests.
Permitted Values

0 - Disabled

1 - Enabled
Default 1

 

Parameter features.show_action_uri_option
Description

It enables or disables the phone to pop-up the "Allow Remote Control" prompt when receiving action URI requests.

Note: It works only if features.action_uri.enable is set to 1.
Permitted Values

0 - Disabled

1 - Enabled
Default 1

 

Parameter features.action_uri_limit_ip
Description

It configures server address from which the phone receives the action URI requests.

Multiple addresses are separated by commas. (for example, 10.1.4.3,10.1.4.23); asterisks represents a wildcard in the IP address (10.10.*.* represents 10.10.0.0 to 10.10.255.255).

Note: It works only if features.action_uri.enable is set to 1.
Permitted Values

IP address(es)

Blank - the phone will reject any HTTP GET request.

any - the phone will accept and handle HTTP GET requests from any IP address.
Default Blank
Web UI Features > Remote Control > Action URI Allow IP List

 

Usage

The valid URI format is:

 http(s)://PHONEIPADDRESS/servlet?key=VARIABLEVALUE;VARIABLEVALUE

Variable values are separated by a semicolon from each other. This method is not applicable to touch-screen phones (T57W/T48U/T48S/T48G).

 

Note: The variable values may not applicable to all events. For example, the variable value MUTE is only applicable when the IP phone is active on a call.

 

When/if authentication is required, you can use the following URI format: 

http(s)://username:password@PHONEIPADDRESS/servlet?key=VARIABLEVALUE;VARIABLEVALUE

 

Variable Values

Variable Value Phone Action 
OK
Press the OK/√/ key. (not applicable to T57W/CP925/CP935W phones) 
ENTER
Press the Enter soft key. (not applicable to T57W/T48U/T48S/T48G phones) 
SPEAKER
Press the Speakerphone key. (not applicable to CP920/CP925/CP935W phones) 
F_TRANSFER
Transfer a call to another party. 
VOLUME_UP
Increase the volume. 
VOLUME_DOWN
Decrease volume. 
MUTE
Mute a call. 
F_HOLD/HOLD
Place an active call on hold. 
F_CONFERENCE
Press the Conf/Conference soft key. 
Cancel/CANCEL
Cancel actions, reject incoming calls or end a call. 
X
Cancel actions, reject incoming calls or mute or un-mute calls. (not applicable to T57W phones) 
0-9/*/#
 Press the keypad (0-9, * or #)(not applicable to CP925/CP935W phones). 
L1-LX

Press the line keys

for T57W/T48U/T48S/T48G, X=29

for T54W/T46U/T46S/T46G/T29G, X=27

for T42U/T42G/T42S/T41P/T41S, X=15

for T53W/T53/T53C/T43U/T27G, X=21

for T33P/T33G, X=12

for T40P/T40G/T23P/T23G, X=3

for T31P/T31G/T31/T21(P) E2, X=2

for CP925/CP935W, X=30

 
LX_LONGPRESS
Perform a corresponding action when long pressing line key X. 
BACK_IDLE
Return idle screen directly. 
F1-F4
Press the soft keys. 
MSG
Press the MESSAGE key. (not applicable to CP920/CP925/CP935W phones) 
HEADSET
Press the HEADSET key. (not applicable to CP920/CP925/CP935W phones) 
RD
Press the RD/Redial key (not applicable to CP920/CP925/CP935W phones) 
UP/DOWN/LEFT/RIGHT
Press the navigation keys. (not applicable to T57W phones) 
Reboot
Reboot the phone. 
AutoP
Perform auto provisioning. 
DNDOn
 Activate the DND feature.Note: It works only if “features.dnd.allow” is set to 1 (Enabled). 
DNDOff
 Deactivate the DND feature.Note: It works only if “features.dnd.allow” is set to 1 (Enabled). 
number=xxx&outgoing_uri=y

Place a call to xxx from SIP URI y.

Example:

http://10.3.20.10/servlet?key=number=1234&outgoing_urii=1006@10.2.1.48 (1234 means the number you dial out; 1006@10.2.1.48 means the SIP URL you dial from.)

 
OFFHOOK
 Pick up the handset. (not applicable to CP920/CP925/CP935W phones)Press the off-hook key. (only applicable to CP920 phones) 
ONHOOK
 Hang up the handset (not applicable to CP920/CP925/CP935W phones).Press the on-hook key. (only applicable to CP920 phones) 
ANSWER/ASW/Asw
Answer a call. 
Reset
Reset a phone. 
ATrans=xxx
Perform a semi-attended/attended transfer to xxx. 
ATrans=callid_A@callid_B

Join any two call parties together on the phone using the call-id. After the call is set up, the two parties disconnect with the phone.Scene:A and D are in a call, the call is active;B and D are in a call, the call is placed on hold;C and D are in a call, the call is placed on hold;callid_A: 32775callid_B: 32776

Example:

http://10.10.20.10/servlet?key=ATrans=32775@32776It means A and B join together and then disconnect with D. But the call between C and D is still in a hold state.Note: To get the call-id of the active call, configure the action URL: http(s)://<serverIPAddress>/help.xml?CallId=$call_id. For more information, refer to Action URL.

 
BTrans=xxx
Perform a blind transfer to xxx. 
phonecfg=get[&accounts=x][&dnd=x][&fw=x]

Get firmware version, registration, DND or forward configuration information.


The valid value of “x” is 0 or 1, 0 means you do not need to get configuration information. 1 means you want to get configuration information.


Note: The valid URI is:

http(s)://<phoneIPAddress > /servlet?phonecfg=get[&accounts=x][&dnd=x][&fw=x].


Example:

http://10.3.20.10/servlet?phonecfg=get[&accounts=1][&dnd=0] [&fw=1]

 
phonecfg=set[&configuration parameter=value]

Set the valid value for the specified configuration parameter.Note: The valid URI is: http(s)://<- phoneIPAddress>/servlet?phonecfg=set[&configuration parameter=value]...[&configuration parameter=value]. It can contain up to 10 configuration parameters.

Example:

http://10.3.20.10/servlet?phone cfg=set[&account.1.enable=1][&features.dnd.enable=1]

 
phonecfg=get[&configuration parameter]

Get the specified configuration information.Note: The valid URI is: http(s)://<- phoneIPAddress>/servlet?phonecfg=get[&configuration parameter]... [&configuration parameter]. It can contain up to 10 configuration parameters.

Example:

http://10.3.20.10/servlet?phonecfg= get[&account.1.enable][&features.dnd.enable]

 
CallWaitingOn
Activate the call waiting feature. 
CallWaitingOff
Deactivate the call waiting feature. 
AlwaysFwdOn/BusyFwdOn/NoAnswFwdOn=xxx=n

Activate an always/busy/no answer forward feature to xxx for the IP phone (“xxx” means the destination number)

The valid value of “n” means the duration time (seconds) before forwarding incoming calls (n is the times of 6, for example, 24). It is only applicable to no answer forward feature.

Note: For Yealink phones, it works only if “features.fwd.allow” is set to 1 (Enabled) and call forward mode is Phone, the always/busy/no answer forward feature will apply to all the accounts on the phone.

Example:

http://10.10.20.10/servlet?key=NoAnswFwdOn=1001=24

 
AlwaysFwdOff/BusyFwdOff/NoAnswFwdOff

Deactivate the always/busy/no answer forward feature for the IP phone.

Note: For Yealink phones, it works only if “features.fwd.allow” is set to 1 (Enabled) and call forward mode is Phone, the always/busy/no answer forward feature will apply to all the accounts on the phone.

Example:

http://10.10.20.10/servlet?key=NoAnswFwdOff

 
CALLEND/CallEnd
End a call. 
ASW/CANCEL/HOLD/UNHOLD:xxx

Answer/end/hold/unhold a call (xxx refers to the call-id of the active call).

Example:

http://10.10.20.10/servlet?key=ASW:33093

Note: To get the call-id of the active call, configure the action URL: http(s)://<serverIPAddress>/help.xml?CallId=$call_id. For more information, refer to Action URL.

 
SWAP
Swap to the held call when there is an active call and a held call on the phone. 
SPLIT
 Split the local conference call into individual calls. After the split, the conference call ends, and other parties are held.Note: It is not available for network conference. 
xxx&Duration=yyy&Hide=n

The server sends a specific DTMF command to the phone during the call.

Example:

1. https://10.10.20.10/servlet?Key=1234&Duration=600&Hide=1

It means that DTMF digits 1234 are transmitted in 600ms and displayed as * on the phone.

2. https://10.10.20.10/servlet?Key=1234&Hide=0

It means that DTMF digits 1234 are transmitted with the current duration (configured by "features.dtmf.duration") and displayed on the phone.

3. https://10.10.20.10/servlet?Key=1234&Duration=800

It means that DTMF digits 1234 are transmitted in 800ms, and whether they are displayed on the phone is determined by "features.dtmf.hide".

4. https://10.10.20.10/servlet?Key=1234

It means that DTMF digits 1234 are transmitted with the current duration (configured by "features.dtmf.duration"), and whether they are displayed on the phone is determined by "features.dtmf.hide".

 

Example

The following shows an example where the admin user is commanding the phone to navigate to the call history and delete all entries:

https://admin:admin@10.20.20.10/servlet?key=F1;F3;DOWN;DOWN;DOWN;OK;OK

Related to

Related articles