Skip to main content

A Python client for the Ejabberd XMLRPC API

Project description

docs Documentation Status
CircleCI Build Status
Coverage Status Scrtinizer Status
package PyPI Package latest release PyPI Package monthly downloads PyPI Wheel
compatibility Supported python versions Supported imlementations Supported ejabberd versions

A Python client for the Ejabberd XMLRPC API

  • Free software: MIT license


pip install pyejabberd


from pyejabberd import EjabberdAPIClient

# Create a client and authenticate with elevated user ''
client = EjabberdAPIClient(host='localhost', port=5222, username='bob', password='p@$$wd', user_domain='',

# Test the connection by sending an echo request to the server
sentence = 'some random data'
result = client.echo(sentence)
assert result == sentence

# Get a list of users that are on the server
registered_users = client.registered_users('')
# result is in the format [{'username': 'bob', ...}]

# Register a new user
client.register(user='alice', host='', password='@l1cepwd')

# Change a password
client.change_password(user='alice', host='', newpass='newpwd')

# Verify password
assert client.check_password_hash(user='bob', host='', password='newpwd') is True

# Set nickname
client.set_nickname(user='bob', host='', nickname='Bob the builder')

# Get list of *all* connected users

# Get list of *all* connected users and information about their sessions

# Get number of connected users

# Get information for all sessions for a user
client.user_sessions_info(user="jim", host=""):

# Get muc rooms
muc_online_rooms = client.muc_online_rooms()
# result is in the format ['room1@conference', ...] where 'conference' is the muc service name

# Create a muc room
client.create_room(name='room1', service='conference', host='')

# Get room options
room_options = client.get_room_options(name='room1', service='conference')

# Set room option
from pyejabberd.muc.enums import MUCRoomOption
client.change_room_option(name='room1', service='conference', option=MUCRoomOption.public, value=False)
client.change_room_option(name='room1', service='conference', option=MUCRoomOption.members_only, value=True)

# Set room affiliation
from pyejabberd.muc.enums import Affiliation
client.set_room_affiliation(name='room1', service='conference', jid='', affiliation=Affiliation.member)

# Get room affiliations
affiliations = client.get_room_affiliations(name='room1', service='conference')

# Destroy a muc room
client.destroy_room(name='room1', service='conference', host='')

# Unregister a user
client.unregister(user='alice', host='')


To run the all tests run:



0.2.8 (2015-08-03)

  • Added testing against Ejabberd 15.07

0.2.7 (2015-07-28)

  • Added API: connected_users
  • Added API: connected_users_info
  • Added API: connected_users_number
  • Added API: user_sessions_info

0.2.6 (2015-07-14)

  • Added API: set_room_affiliation
  • Added API: get_room_affiliations

0.2.5 (2015-07-07)

  • Python 2/3 compatibility
  • Fixed failing build

0.2.4 (2015-07-06)

  • Made constructor more strict (no more kwargs)
  • Added optional function to create a client instance from a service url, compliant with the ‘12factor app’ idea

0.2.3 (2015-06-18)

  • Improved test suite
  • Made some enums more explicit
  • Aligned MUC room options with currently supported options in Ejabberd, build from master branch

0.2.2 (2015-05-25)

  • Cleanup and more tests

0.2.1 (2015-05-25)

  • Refactored method validator/serializer system

0.2.0 (2015-05-20)

  • Big refactor, interface changed to better match the ejabberdctl interface.

0.1.2 (2015-05-16)

  • Fixed build scripts.

0.1.1 (2015-05-16)

  • Some bugfixes.

0.1.0 (2015-05-16)

  • First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyejabberd, version 0.2.8
Filename, size File type Python version Upload date Hashes
Filename, size pyejabberd-0.2.8-py2.py3-none-any.whl (17.5 kB) File type Wheel Python version 3.4 Upload date Hashes View
Filename, size pyejabberd-0.2.8.tar.gz (22.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page