• FAQs /
  • Do you have an API? Where do I find your API documentation?

Do you have an API? Where do I find your API documentation?

Yes, we have a REST API.

API Documentation

API Key

You can find and reset your API key by logging into your account and then viewing your profile

Every API request must contain your API key. You provide your API key with the "token" parameter.

EG: https://www.mumbleboxes.com/api.xml?token=(your_API_key)

*IMPORTANT NOTE*

Do not give your API key to anyone, or put it in a public location (even in javascript source code) because it allows users to edit your server settings.

Output Format

We support both json and xml formats. The URL should contain either a .xml or a .json extension.

API Commands

List Servers

Returns a list of all of your servers.

https://www.mumbleboxes.com/api.(format)?token=(key)

Single Server Details

Returns details on a single server. Server ID found inside the server list output.

https://www.mumbleboxes.com/api/(server_id).(format)?token=(key)

List Channels

Returns list of all channels. Server ID found inside the server list output.

https://www.mumbleboxes.com/api/(server_id)/channels.(format)?token=(key)

List Users

Returns list of all users. Server ID found inside the server list output.

https://www.mumbleboxes.com/api/(server_id)/users.(format)?token=(key)

Start a Server

Starts a server if its stopped, returns the server details. Server ID found inside the server list output.

https://www.mumbleboxes.com/api/(server_id)/start.(format)?token=(key)

Stop a Server

Stops a server if its started, returns the server details. Server ID found inside the server list output.

https://www.mumbleboxes.com/api/(server_id)/stop.(format)?token=(key)

Send a Message

Sends a message to all channels on the server:

https://www.mumbleboxes.com/api/(server_id)/message.(format)?token=(key)&message=(message)

Sends a message to specific channels - User channel API call to get channel ID:

https://www.mumbleboxes.com/api/(server_id)/message.(format)?token=(key)&message=(message)&channelid=(channel id)

Sends a message to specific users - User Userlist API call to get session ID:

https://www.mumbleboxes.com/api/(server_id)/message.(format)?token=(key)&message=(message)&sessionid=(user session id)

Update Settings

You can update any of the following setting using the API:

  • allowhtml
  • password
  • welcometext
  • defaultchannel
  • textmessagelength
  • timeout
  • rememberchannel

https://www.mumbleboxes.com/api/(server_id)/update.(format)?token=(key)&server[(setting)]=(value)&server[(setting)]=(value)

For example:

https://www.mumbleboxes.com/api/1/update.xml?token=tokenhere&server[welcometext]=Welcome+to+our+server&server[allowhtml]=true

Are we missing something?

Are you we missing a feature you would like to see? Simply open a support ticket and tell us what it is and we will do everything we can do to accommodate you.

Back