When one has multiple clients at different locations logged in simultaneously, it is often desirable to control these clients from the client you are currently using. There are a number of common tasks one might want to perform remotely on clients: change the status of the client, forward all received unread messages to this client, and so on. Therefore, it makes sense to define a protocol for performing these tasks.
This document describes a protocol to perform a set of common tasks on a remote client, by specifying a profile of Ad-Hoc Commands (XEP-0050) [1].
This document addresses the following requirements:
A client MUST advertise any remote controlling commands it supports via Service Discovery (XEP-0030) [2] (as described in XEP-0050: Ad-Hoc Commands). Entity Capabilities (XEP-0115) [3] can be used to query capability of remote controlling commands in a client.
This document defines a profile of XEP-0050: Ad-Hoc Commands that enables a user to perform the following tasks on a remote client:
Although this document aims to define common use cases for remote controlling clients, an implementation or deployment MAY support any subset and MAY support additional commands not defined herein.
Note: The text that follows assumes that implementors have read and understood XEP-0050: Ad-Hoc Commands.
It is common to forget changing the status of a resource when leaving the client for a longer period. When realizing this while at another location, it might be desirable to change the status from there, to avoid contacts thinking that resource is attended and sending it messages.
<iq from='juliet@example.com/chamber'
to='juliet@example.com/balcony'
type='set'
id='set-status-1'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
action='execute'
node='http://jabber.org/protocol/rc#set-status'/>
</iq>
Unless an error occurs (see the Error Handling section below), the service SHOULD return the appropriate form.
<iq from='juliet@example.com/balcony'
to='juliet@example.com/chamber'
type='result'
id='set-status-1'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#set-status'
sessionid='set-status:20040727T0337Z'
status='executing'>
<x xmlns='jabber:x:data' type='form'>
<title>Change Status</title>
<instructions>Choose the status and status message</instructions>
<field type='hidden' var='FORM_TYPE'>
<value>http://jabber.org/protocol/rc</value>
</field>
<field label='Status'
type='list-single'
var='status'>
<required/>
<value>online</value>
<option label='Chat'>
<value>chat</value>
</option>
<option label='Online'>
<value>online</value>
</option>
<option label='Away'>
<value>away</value>
</option>
<option label='Extended Away'>
<value>xa</value>
</option>
<option label='Do Not Disturb'>
<value>dnd</value>
</option>
<option label='Invisible'>
<value>invisible</value>
</option>
<option label='Offline'>
<value>offline</value>
</option>
</field>
<field label='Priority'
type='text-single'
var='status-priority'>
<value>5</value>
</field>
<field label='Message'
type='text-multi'
var='status-message'/>
</x>
</command>
</iq>
<iq from='juliet@example.com/chamber'
to='juliet@example.com/balcony'
type='set'
id='set-status-2'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#set-status'
sessionid='set-status:20040727T0337Z'>
<x xmlns='jabber:x:data' type='form'>
<field type='hidden' var='FORM_TYPE'>
<value>http://jabber.org/protocol/rc</value>
</field>
<field type='list-single' var='status'>
<value>xa</value>
</field>
<field type='text-single' var='status-priority'>
<value>-1</value>
</field>
<field type='text-multi' var='status-message'>
<value>In my chamber.</value>
</field>
</x>
</command>
</iq>
If the 'status-priority' variable is omitted, the client SHOULD NOT change the priority of the client
<iq from='juliet@example.com/balcony'
to='juliet@example.com/chamber'
type='result'
id='set-status-2'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#set-status'
sessionid='set-status:20040727T0337Z'
status='completed'/>
</iq>
Notification of completion MAY include the processed data in a data form of type 'result'.
A user might want to forward all the unread messages residing at the remote client to the local client (e.g. when the remote client was accidentally left on-line, and has received messages in the meantime).
For example, suppose Romeo sends a message to Juliet, thinking she is still on her balcony. The balcony client receives the message:
<message from='romeo@example.com/orchard'
to='juliet@example.com/balcony'>
<subject>Just saying hi</subject>
<body>Hello Juliet!</body>
</message>However, Juliet is in her chamber, so she doesn't know about the message (yet). Realizing she left her balcony client unattended, she sends a request to the remote client to forward all unread messages.
<iq from='juliet@example.com/chamber'
to='juliet@example.com/balcony'
type='set'
id='forward-1'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
action='execute'
node='http://jabber.org/protocol/rc#forward'
sessionid='forward:20040727T0337Z'/>
</iq>The client forwards all unread messages to the local client, adding information about the origin of the message (using the 'ofrom' Extended Stanza Addressing (XEP-0033) [4] address, and the Delayed Delivery (XEP-0203) [5] timestamp of the original message). The chamber client receives both these messages and a confirmation that the command was completed.
<message from='juliet@example.com/balcony'
to='juliet@example.com/chamber'>
<subject>Just saying hi</subject>
<body>Hello Juliet!</body>
<addresses xmlns='http://jabber.org/protocol/address'>
<address type='ofrom' jid='romeo@example.com/orchard'/>
</addresses>
<delay xmlns='urn:xmpp:delay'
from='juliet@capulet.com/balcony'
stamp='2002-09-10T23:41:07Z'/>
</message>
<iq from='juliet@example.com/balcony'
to='juliet@example.com/chamber'
type='result'
id='forward-1'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#forward'
sessionid='forward:20040727T0337Z'
status='completed'/>
</iq>A client MAY provide a more fine-grained implementation, e.g. by presenting the requester an extra form to select which messages have to be forwarded.
It might be desirable to remotely set some run-time options of a client. For example, when neighbours complain about the sounds your client makes while you're at another location, you could turn the sounds off at the remote client.
<iq from='juliet@example.com/chamber'
to='juliet@example.com/balcony'
type='set'
id='set-options-1'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
action='execute'
node='http://jabber.org/protocol/rc#set-options'/>
</iq>Unless an error occurs (see the Error Handling section below), the service SHOULD return the appropriate form.
<iq from='juliet@example.com/balcony'
to='juliet@example.com/chamber'
type='result'
id='set-options-1'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#set-options'
sessionid='set-options:20040727T0337Z'
status='executing'>
<x xmlns='jabber:x:data' type='form'>
<title>Set Options</title>
<instructions>Set the desired options</instructions>
<field type='hidden' var='FORM_TYPE'>
<value>http://jabber.org/protocol/rc</value>
</field>
<field label='Play sounds'
type='boolean'
var='sounds'>
<value>1</value>
</field>
<field label='Automatically Go Offline when Idle'
type='boolean'
var='auto-offline'>
<value>0</value>
</field>
<field label='Automatically Open New Messages'
type='boolean'
var='auto-msg'>
<value>0</value>
</field>
<field label='Automatically Accept File Transfers'
type='boolean'
var='auto-files'>
<value>0</value>
</field>
<field label='Automatically Authorize Contacts'
type='boolean'
var='auto-auth'>
<value>0</value>
</field>
</x>
</command>
</iq>
<iq from='juliet@example.com/chamber'
to='juliet@example.com/balcony'
type='set'
id='set-options-2'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#set-options'
sessionid='set-options:20040727T0337Z'>
<x xmlns='jabber:x:data' type='form'>
<field type='hidden' var='FORM_TYPE'>
<value>http://jabber.org/protocol/rc</value>
</field>
<field type='boolean' var='sounds'>
<value>0</value>
</field>
<field type='boolean' var='auto-offline'>
<value>0</value>
</field>
<field type='boolean' var='auto-msg'>
<value>0</value>
</field>
<field type='boolean' var='auto-files'>
<value>0</value>
</field>
<field type='boolean' var='auto-auth'>
<value>0</value>
</field>
</x>
</command>
</iq>
The remote client sets the values of the options to their requested value. If a variable is omitted, the client SHOULD NOT change the value of the corresponding option.
<iq from='juliet@example.com/balcony'
to='juliet@example.com/chamber'
type='result'
id='set-options-2'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#set-options'
sessionid='set-options:20040727T0337Z'
status='completed'/>
</iq>Notification of completion MAY include the processed data in a data form of type 'result'.
<iq from='juliet@example.com/chamber'
to='juliet@example.com/balcony'
type='set'
id='accept-files-1'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
action='execute'
node='http://jabber.org/protocol/rc#accept-files'/>
</iq>Unless an error occurs (see the Error Handling section below), the service SHOULD return the appropriate form.
<iq from='juliet@example.com/balcony'
to='juliet@example.com/chamber'
type='result'
id='accept-files-1'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#accept-files'
sessionid='set-status:20040727T0337Z'
status='executing'>
<x xmlns='jabber:x:data' type='form'>
<title>Pending File Transfers</title>
<instructions>Select the pending file transfers to accept</instructions>
<field type='hidden' var='FORM_TYPE'>
<value>http://jabber.org/protocol/rc</value>
</field>
<field label='Files'
type='list-multi'
var='files'>
<required/>
<option label='ballad.ogg (romeo@example.com)'>
<value>romeo@example.com/orchard:1</value>
</option>
<option label='picture.jpg (romeo@example.com)'>
<value>romeo@example.com/orchard:2</value>
</option>
<option label='challenge.txt (mercutio@example.com)'>
<value>mercutio@example.com/orchard:1</value>
</option>
</field>
</x>
</command>
</iq>
<iq from='juliet@example.com/chamber'
to='juliet@example.com/balcony'
type='set'
id='accept-files-2'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#accept-files'
sessionid='accept-files:20040727T0337Z'>
<x xmlns='jabber:x:data' type='form'>
<field type='hidden' var='FORM_TYPE'>
<value>http://jabber.org/protocol/rc</value>
</field>
<field type='list-multi' var='files'>
<value>romeo@example.com/orchard:2</value>
</field>
</x>
</command>
</iq>The remote client accepts the selected file transfers, and informs the local client of completion.
<iq from='juliet@example.com/balcony'
to='juliet@example.com/chamber'
type='result'
id='accept-files-2'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#accept-files'
sessionid='accept-files:20040727T0337Z'
status='completed'/>
</iq>
<iq from='juliet@example.com/chamber'
to='juliet@example.com/balcony'
type='set'
id='leave-groupchats-1'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
action='execute'
node='http://jabber.org/protocol/rc#leave-groupchats'/>
</iq>
<iq from='juliet@example.com/balcony'
to='juliet@example.com/chamber'
type='result'
id='leave-groupchats-1'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#leave-groupchats'
sessionid='leave-groupchats:20040727T0337Z'
status='executing'>
<x xmlns='jabber:x:data' type='form'>
<title>Leave Groupchats</title>
<instructions>Choose the groupchats you want to leave</instructions>
<field type='hidden' var='FORM_TYPE'>
<value>http://jabber.org/protocol/rc</value>
</field>
<field label='Groupchats'
type='list-multi'
var='groupchats'>
<required/>
<option label='juliet on jdev@conference.jabber.org'>
<value>jdev@conference.jabber.org/juliet</value>
</option>
<option label='juliette on jdev@conference.jabber.org'>
<value>jdev@conference.jabber.org/juliette</value>
</option>
<option label='juliet on girlsonly@jabber.com'>
<value>girlsonly@jabber.com/juliet</value>
</option>
</field>
</x>
</command>
</iq>
<iq from='juliet@example.com/chamber'
to='juliet@example.com/balcony'
type='set'
id='leave-groupchats-2'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#leave-groupchats'
sessionid='leave-groupchats:20040727T0337Z'>
<x xmlns='jabber:x:data' type='form'>
<field type='hidden' var='FORM_TYPE'>
<value>http://jabber.org/protocol/rc</value>
</field>
<field type='list-multi' var='groupchats'>
<value>jdev@conference.jabber.org/juliet</value>
<value>girlsonly@jabber.com/juliet</value>
</field>
</x>
</command>
</iq>
The remote client leaves the requested groupchats, and informs the local client of completion.
<iq from='juliet@example.com/balcony'
to='juliet@example.com/chamber'
type='result'
id='leave-groupchats-2'
xml:lang='en'>
<command xmlns='http://jabber.org/protocol/commands'
node='http://jabber.org/protocol/rc#leave-groupchats'
sessionid='leave-groupchats:20040727T0337Z'
status='completed'/>
</iq>
Several error conditions are possible when an entity sends a command request to the service, as defined in the following table. If one of these errors occurs, the service MUST return an error stanza to the requesting entity.
| Condition | Cause |
|---|---|
| <feature-not-implemented/> | The specific command is not supported (even though the ad-hoc commands protocol is) |
| <forbidden/> | The requesting entity does not have sufficient privileges to perform the command |
| <service-unavailable/> | The ad-hoc commands protocol is not supported |
For the syntax of these errors, see Error Condition Mappings (XEP-0086) [6]. Naturally, other errors may be returned as well.
Implementations of this protocol MAY add or remove fields to forms as they see fit. For example, when setting the status of a remote client that supports multiple accounts, the client may choose to add a boolean field to allow the user to specify whether the status change should be applied globally or only to the receiving account.
Implementations MAY also introduce extra forms for commands. For example, when forwarding unread messages, a client could return a form containing a list of short descriptions of unread messages, allowing the user to select the messages he wants to forward.
The ability to complete the tasks specified herein MUST NOT be granted to users who lack privileges to control a client. A sensible access policy is to only allow remote controlling by other resources of the same account used by the client. If other accounts are to be able to remote control the client, the client needs more complex access right management.
This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [7].
The XMPP Registrar includes 'http://jabber.org/protocol/rc' in its registry of protocol namespaces (see <https://xmpp.org/registrar/namespaces.html>).
Field Standardization for Data Forms (XEP-0068) [8] defines a process for standardizing the fields used within Data Forms scoped by a particular namespace (see also <https://xmpp.org/registrar/formtypes.html>). The reserved fields for the 'http://jabber.org/protocol/rc' namespace are specified below.
<form_type>
<name>http://jabber.org/protocol/rc</name>
<doc>XEP-0146</doc>
<desc>Forms used for remote controlling clients</desc>
<field var='auto-auth'
type='boolean'
label='Whether to automatically authorize subscription requests'/>
<field var='auto-files'
type='boolean'
label='Whether to automatically accept file transfers'/>
<field var='auto-msg'
type='boolean'
label='Whether to automatically open new messages'/>
<field var='auto-offline'
type='boolean'
label='Whether to automatically go offline when idle'/>
<field var='sounds'
type='boolean'
label='Whether to play sounds'/>
<field var='files'
type='list-multi'
label='A list of pending file transfers'/>
<field var='groupchats'
type='list-multi'
label='A list of joined groupchat rooms'/>
<field var='status'
type='list-single'
label='A presence or availability status'>
<option label='Chat'>
<value>chat</value>
</option>
<option label='Online'>
<value>online</value>
</option>
<option label='Away'>
<value>away</value>
</option>
<option label='Extended Away'>
<value>xa</value>
</option>
<option label='Do Not Disturb'>
<value>dnd</value>
</option>
<option label='Invisible'>
<value>invisible</value>
</option>
<option label='Offline'>
<value>offline</value>
</option>
</field>
<field var='status-message'
type='text-multi'
label='The status message text'/>
<field var='status-priority'
type='text-single'
label='The new priority for the client'/>
</form_type>
Because the protocol defined here is a profile of XEP-0050: Ad-Hoc Commands, no schema definition is needed.
This document in other formats: XML PDF
This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF).
Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.
## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##
In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.
This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).
The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.
The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.
The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.
Discussion on other xmpp.org discussion lists might also be appropriate; see <https://xmpp.org/community/> for a complete list.
Errata can be sent to <editor@xmpp.org>.
The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".
1. XEP-0050: Ad-Hoc Commands <https://xmpp.org/extensions/xep-0050.html>.
2. XEP-0030: Service Discovery <https://xmpp.org/extensions/xep-0030.html>.
3. XEP-0115: Entity Capabilities <https://xmpp.org/extensions/xep-0115.html>.
4. XEP-0033: Extended Stanza Addressing <https://xmpp.org/extensions/xep-0033.html>.
5. XEP-0203: Delayed Delivery <https://xmpp.org/extensions/xep-0203.html>.
6. XEP-0086: Error Condition Mappings <https://xmpp.org/extensions/xep-0086.html>.
7. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.
8. XEP-0068: Field Data Standardization for Data Forms <https://xmpp.org/extensions/xep-0068.html>.
Note: Older versions of this specification might be available at https://xmpp.org/extensions/attic/
Per a vote of the XMPP Council, advanced to Obsolete.
Per a vote of the Jabber Council, advanced to Active.
@report{tronçon2004rc,
title = {Remote Controlling Clients},
author = {Tronçon, Remko and Saint-Andre, Peter},
type = {XEP},
number = {0146},
version = {1.1},
institution = {XMPP Standards Foundation},
url = {https://xmpp.org/extensions/xep-0146.html},
date = {2004-11-12/2017-11-07},
}END