Skip to content

RPC interface

Eana Hufwe edited this page Feb 10, 2019 · 1 revision

Written for EFB Telegram Master 2.0.0b18

A standard Python XML RPC server is implemented in ETM 2.x. It can be enabled by adding a rpc section in ETM's config.yml file.

rpc:
    server: 127.0.0.1
    port: 8000

Warning: The xmlrpc module is not secure against maliciously constructed data. Do not expose the interface to untrusted parties or the public internet, and turn off after use.

Exposed functions

Functions in the db (database manager) class and the RPCUtilities class are exposed. Refer to the source code for their documentations.

How to use

Set up a SimpleXMLRPCClient in any Python script and call any of the exposed functions directly. For details, please consult Python documentation on xmlrpc.