MongooseIM's REST API for backend administration
Commands used by the REST API are provided by modules:
mod_commands - provides general purpose commands: both user-like (e.g. sending a message and retrieving messages from the archive) and administration-like (e.g. create/delete a user and change the password).
mod_muc_commands - commands related to Multi-user Chat rooms: create a room, invite users, send a message etc.
mod_muc_light_commands - same but for rooms based on the muc-light protocol.
To activate those commands, put the modules you need into the
1 2 3 4 5
To get a list of commands, you can use
jq utility for pretty-printing JSON.
Each command has the fields:
path- URL path for this command
method- HTTP method to use for this command
args- arguments to provide inside a path or as POST arguments
category- a name used for grouping similar commands
name- a command name
desc- description text
action- a type of a command, corresponding to
args are useful to figuring out how the request should
look like (you can use Swagger instead).
category are used just as metadata (they are not part of
action is used internally.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
Read the beautiful Swagger documentation for more information.