Ts3AudioBot API (1.0.0)

Download OpenAPI specification:Download

The Ts3AudioBot api interface.

Authentication

default_basic

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

unsubscribe

Only lets you hear the music in active channels ag

Only lets you hear the music in active channels again.

Authorizations:

default_basic

Responses

Removes your current channel from the music playba

Removes your current channel from the music playback.

Authorizations:

default_basic

path Parameters

channels

required

Array of ChannelId[ items ]

useful help

Responses

Clears all temporary targets.

Authorizations:

default_basic

Responses

Unsubscribes the specified client to listen from a

Unsubscribes the specified client to listen from anywhere.

Authorizations:

default_basic

path Parameters

client

required

ClientId

useful help

Responses

Gets the current build version.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Sets the volume level of the music.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

0

Sets the volume level of the music.

Authorizations:

default_basic

path Parameters

volume

required

string

useful help

Responses

Evaluates all parameter.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Plays the next song in the playlist.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

path Parameters

index

required

integer <int32>

useful help

Responses

Response samples

200

Content type

application/json

null

Well, pauses the song. Undo with !play.

Authorizations:

default_basic

Responses

Automatically tries to decide whether the link is

Automatically tries to decide whether the link is a special resource (like youtube) or a direct resource (like ./hello.mp3) and starts it.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Automatically tries to decide whether the link is

Automatically tries to decide whether the link is a special resource (like youtube) or a direct resource (like ./hello.mp3) and starts it.

Authorizations:

default_basic

path Parameters

url required	string useful help
attributes required	Array of strings useful help

Responses

Response samples

200

Content type

application/json

null

Automatically tries to decide whether the link is

Automatically tries to decide whether the link is a special resource (like youtube) or a direct resource (like ./hello.mp3) and starts it.

Authorizations:

default_basic

path Parameters

rsc required	IAudioResourceResult useful help
attributes required	Array of strings useful help

Responses

Response samples

200

Content type

application/json

null

Plays the previous song in the playlist.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Lets you format multiple parameter to one.

Authorizations:

default_basic

path Parameters

parameter

required

Array of strings

useful help

Responses

Response samples

200

Content type

application/json

"string"

Gets a random number.

Authorizations:

default_basic

path Parameters

first required	integer <int32> useful help
second required	integer <int32> useful help

Responses

Response samples

200

Content type

application/json

0

Jumps to a timemark within the current song.

Authorizations:

default_basic

path Parameters

position

required

string <duration>

useful help

Responses

Response samples

200

Content type

application/json

null

Tells you the name of the current song.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Stops the current song.

Authorizations:

default_basic

Responses

Take a substring from a string.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Adds a new song to the queue.

Authorizations:

default_basic

path Parameters

url required	string useful help
attributes required	Array of strings useful help

Responses

Response samples

200

Content type

application/json

null

Adds a new song to the queue.

Authorizations:

default_basic

path Parameters

rsc required	IAudioResourceResult useful help
attributes required	Array of strings useful help

Responses

Response samples

200

Content type

application/json

null

Removes all songs from the current playlist.

Authorizations:

default_basic

Responses

Executes a given command or string

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

path Parameters

factoryName required	string useful help
url required	string useful help

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

path Parameters

index required	integer <uint32> useful help
list required	IEnumerable useful help

Responses

Response samples

200

Content type

application/json

{ }

Conditionally executes subcommands.

Authorizations:

default_basic

path Parameters

arg0 required	string useful help
cmp required	string useful help
arg1 required	string useful help
then required	λ useful help
other required	λ useful help

Responses

Response samples

200

Content type

application/json

null

Show's a small summary of the current playlist and

Show's a small summary of the current playlist and queue status.

Authorizations:

default_basic

path Parameters

offset required	string useful help
count required	integer <int32> useful help

Responses

Response samples

200

Content type

application/json

null

Jumps to the requested index in the current queue

Jumps to the requested index in the current queue and starts playing.

Authorizations:

default_basic

path Parameters

offset

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

whisper

Set how to send music.

Authorizations:

default_basic

Responses

Set a specific teamspeak whisper group.

Authorizations:

default_basic

path Parameters

type required	GroupWhisperType useful help
target required	GroupWhisperTarget useful help
targetId required	integer <uint64> useful help

Responses

Set how to send music.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

{ }

Enables normal voice mode.

Authorizations:

default_basic

Responses

Enables default whisper subscription mode.

Authorizations:

default_basic

Responses

list

Clears a playlist.

Authorizations:

default_basic

path Parameters

listId

required

string

useful help

Responses

This feature is not documented.

Authorizations:

default_basic

path Parameters

listId required	string useful help
title required	string useful help

Responses

<name> Deletes the playlist with the name <name>.

Deletes the playlist with the name . You can only delete playlists which you also have created. Admins can delete every playlist.

Authorizations:

default_basic

path Parameters

listId

required

string

useful help

Responses

This feature is not documented.

Authorizations:

default_basic

path Parameters

resolverName required	string useful help
listId required	string useful help
url required	string useful help

Responses

Response samples

200

Content type

application/json

null

<link> Imports a playlist form an other platform l

Imports a playlist form an other platform like youtube etc.

Authorizations:

default_basic

path Parameters

listId required	string useful help
link required	string useful help

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

path Parameters

listId required	string useful help
index required	integer <int32> useful help
link required	string useful help

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

path Parameters

name required	string useful help
index required	integer <int32> useful help

Responses

Response samples

200

Content type

application/json

null

<from> <to> Moves a item in a playlist <from> <to>

Moves a item in a playlist position.

Authorizations:

default_basic

path Parameters

listId required	string useful help
from required	integer <int32> useful help
to required	integer <int32> useful help

Responses

<index> Removes the item at <index>.

Removes the item at .

Authorizations:

default_basic

path Parameters

listId required	string useful help
index required	integer <int32> useful help

Responses

Renames an item.

Authorizations:

default_basic

path Parameters

listId required	string useful help
index required	integer <int32> useful help
title required	string useful help

Responses

Displays all available playlists from all users.

Authorizations:

default_basic

path Parameters

pattern

required

string

useful help

Responses

Response samples

200

Content type

application/json

[null
]

Appends another playlist to yours.

Authorizations:

default_basic

path Parameters

baseListId required	string useful help
mergeListId required	string useful help

Responses

Displays the name of the playlist you are currentl

Displays the name of the playlist you are currently working on.

Authorizations:

default_basic

path Parameters

listId required	string useful help
title required	string useful help

Responses

Replaces the current freelist with your workinglis

Replaces the current freelist with your workinglist and plays from the beginning.

Authorizations:

default_basic

path Parameters

listId required	string useful help
index required	integer <int32> useful help

Responses

Response samples

200

Content type

application/json

null

Appends your playlist to the freelist.

Authorizations:

default_basic

path Parameters

listId

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

<name> Displays all songs currently in the playlis

Displays all songs currently in the playlists with the name

Authorizations:

default_basic

path Parameters

listId required	string useful help
offset required	integer <int32> useful help
count required	integer <int32> useful help

Responses

Response samples

200

Content type

application/json

null

<id> Adds a link to your private playlist from the

Adds a link to your private playlist from the history by .

Authorizations:

default_basic

path Parameters

listId required	string useful help
link required	string useful help

Responses

Response samples

200

Content type

application/json

null

pm

Requests a private session with the ServerBot so y

Requests a private session with the ServerBot so you can be intimate.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

"string"

This feature is not documented.

Authorizations:

default_basic

path Parameters

message

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

path Parameters

message

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Writes a message to a particular user.

Authorizations:

default_basic

path Parameters

clientId required	integer <uint16> useful help
message required	string useful help

Responses

Response samples

200

Content type

application/json

null

plugin

Lists all found plugins.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

[null
]

Unloads a plugin.

Authorizations:

default_basic

path Parameters

identifier

required

string

useful help

Responses

Unloads a plugin.

Authorizations:

default_basic

path Parameters

identifier

required

string

useful help

Responses

quiz

Shows the quizmode status.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

true

Enable to hide the songnames and let your friends

Enable to hide the songnames and let your friends guess the title.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Disable to show the songnames again.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

random

Gets whether or not to play playlists in random or

Gets whether or not to play playlists in random order.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

true

Enables random playlist playback

Authorizations:

default_basic

Responses

Disables random playlist playback

Authorizations:

default_basic

Responses

Gets the unique seed for a certain playback order

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

"string"

Sets the unique seed for a certain playback order

Authorizations:

default_basic

path Parameters

newSeed

required

string

useful help

Responses

repeat

Gets the current repeat mode.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Disables repeating.

Authorizations:

default_basic

Responses

Repeats a single song.

Authorizations:

default_basic

Responses

Repeats the entire playlist.

Authorizations:

default_basic

Responses

rights

Returns the subset of allowed commands the caller

Returns the subset of allowed commands the caller (you) can execute.

Authorizations:

default_basic

path Parameters

rights

required

Array of strings

useful help

Responses

Response samples

200

Content type

application/json

null

Reloads the rights configuration from file.

Authorizations:

default_basic

Responses

search

This feature is not documented.

Authorizations:

default_basic

path Parameters

index

required

integer <int32>

useful help

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

path Parameters

resolverName required	string useful help
query required	string useful help

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

path Parameters

index

required

integer <int32>

useful help

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

path Parameters

index

required

integer <int32>

useful help

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

[null
]

server

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

settings

Provides get/set methods to change the settings.

Authorizations:

default_basic

Responses

Duplicates a bot template with a new name.

Authorizations:

default_basic

path Parameters

from required	string useful help
to required	string useful help

Responses

Creates a new bot template.

Authorizations:

default_basic

path Parameters

name

required

string

useful help

Responses

Deletes a bot template.

Authorizations:

default_basic

path Parameters

name

required

string

useful help

Responses

Gets a value from the bot settings.

Authorizations:

default_basic

path Parameters

path

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Sets a value from the bot settings.

Authorizations:

default_basic

path Parameters

path required	string useful help
value required	string useful help

Responses

Gets a value from the bot settings.

Authorizations:

default_basic

path Parameters

botName required	string useful help
path required	string useful help

Responses

Response samples

200

Content type

application/json

null

Sets a value from the bot settings.

Authorizations:

default_basic

path Parameters

botName required	string useful help
path required	string useful help
value required	string useful help

Responses

Response samples

200

Content type

application/json

null

Reloads the bot template configuration from the fi

Reloads the bot template configuration from the file.

Authorizations:

default_basic

path Parameters

name

required

string

useful help

Responses

Gets a value from the core settings.

Authorizations:

default_basic

path Parameters

path

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Set a value from the core settings.

Authorizations:

default_basic

path Parameters

path required	string useful help
value required	string useful help

Responses

Get the desciption for a setting.

Authorizations:

default_basic

path Parameters

path

required

string

useful help

Responses

Response samples

200

Content type

application/json

"string"

subscribe

Lets you hear the music independent from the chann

Lets you hear the music independent from the channel you are in.

Authorizations:

default_basic

Responses

Adds your current channel to the music playback.

Authorizations:

default_basic

path Parameters

channel

required

ChannelId

useful help

Responses

Adds your current channel to the music playback.

Authorizations:

default_basic

path Parameters

channels

required

Array of ChannelId[ items ]

useful help

Responses

Subscribes the specified client to listen from any

Subscribes the specified client to listen from anywhere

Authorizations:

default_basic

path Parameters

client

required

ClientId

useful help

Responses

system

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Closes the TS3AudioBot application.

Authorizations:

default_basic

path Parameters

param

required

string

useful help

Responses

alias

Creates a new command alias.

Authorizations:

default_basic

path Parameters

commandName required	string useful help
command required	string useful help

Responses

Removes an existing alias.

Authorizations:

default_basic

path Parameters

commandName

required

string

useful help

Responses

Lists all currently registered alias.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

["string"
]

Shows the implementation of the alias.

Authorizations:

default_basic

path Parameters

commandName

required

string

useful help

Responses

Response samples

200

Content type

application/json

"string"

api

Generates an api token.

Authorizations:

default_basic

path Parameters

validHours

required

number <double>

useful help

Responses

Response samples

200

Content type

application/json

"string"

bot

Sets an avatar for the bot

Authorizations:

default_basic

path Parameters

url

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Clears the avatar of the bot.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Set your bot a badge. The badges string starts wit

Set your bot a badge. The badges string starts with 'overwolf=0:badges='

Authorizations:

default_basic

path Parameters

badges

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Sets the description of the bot.

Authorizations:

default_basic

path Parameters

description

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Stop this bot instance.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Gets the status of the channel commander mode.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Enables channel commander.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Disables channel commander.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Moves the bot to your channel.

Authorizations:

default_basic

path Parameters

password

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Connects a new bot with the settings from the temp

Connects a new bot with the settings from the template name.

Authorizations:

default_basic

path Parameters

name

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Connects a new bot to the given address.

Authorizations:

default_basic

path Parameters

address required	string useful help
password required	string useful help

Responses

Response samples

200

Content type

application/json

null

Gets various information about the bot.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Gets various information about the bot.

Authorizations:

default_basic

path Parameters

name

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Gets a list of all active bots.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

[null
]

Moves the bot to you or a specified channel.

Authorizations:

default_basic

path Parameters

channel required	integer <uint64> useful help
password required	string useful help

Responses

Response samples

200

Content type

application/json

null

Gives the bot a new name.

Authorizations:

default_basic

path Parameters

name

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Saves the configuration for the newly connected bo

Saves the configuration for the newly connected bot.

Authorizations:

default_basic

path Parameters

name

required

string

useful help

Responses

Sets all teamspeak rights for the bot to be fully

Sets all teamspeak rights for the bot to be fully functional.

Authorizations:

default_basic

path Parameters

adminToken

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Switches the context to the requested bot.

Authorizations:

default_basic

path Parameters

botName required	string useful help
cmd required	λ useful help

Responses

Response samples

200

Content type

application/json

null

Switches the context to the requested bot.

Authorizations:

default_basic

path Parameters

botId required	integer <int32> useful help
cmd required	λ useful help

Responses

Response samples

200

Content type

application/json

null

command

Displays the AST of the requested command.

Authorizations:

default_basic

path Parameters

parameter

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

"string"

data

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

getmy

Gets your id.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

0

Gets your unique id.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

"string"

Gets your nickname.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

"string"

Gets your database id.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

0

Gets your channel id you are currently in.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

0

Gets all information about you.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

getuser

Gets the unique id of a user, searching with his i

Gets the unique id of a user, searching with his id.

Authorizations:

default_basic

path Parameters

id

required

integer <uint16>

useful help

Responses

Response samples

200

Content type

application/json

null

Gets the nickname of a user, searching with his id

Gets the nickname of a user, searching with his id.

Authorizations:

default_basic

path Parameters

id

required

integer <uint16>

useful help

Responses

Response samples

200

Content type

application/json

null

Gets the database id of a user, searching with his

Gets the database id of a user, searching with his id.

Authorizations:

default_basic

path Parameters

id

required

integer <uint16>

useful help

Responses

Response samples

200

Content type

application/json

null

Gets the channel id a user is currently in, search

Gets the channel id a user is currently in, searching with his id.

Authorizations:

default_basic

path Parameters

id

required

integer <uint16>

useful help

Responses

Response samples

200

Content type

application/json

null

Gets all information about a user, searching with

Gets all information about a user, searching with his id.

Authorizations:

default_basic

path Parameters

id

required

integer <uint16>

useful help

Responses

Response samples

200

Content type

application/json

null

Gets the id of a user, searching with his name.

Authorizations:

default_basic

path Parameters

username

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Gets all information of a user, searching with his

Gets all information of a user, searching with his name.

Authorizations:

default_basic

path Parameters

username

required

string

useful help

Responses

Response samples

200

Content type

application/json

null

Gets the user name by dbid, searching with his dat

Gets the user name by dbid, searching with his database id.

Authorizations:

default_basic

path Parameters

dbId

required

integer <uint64>

useful help

Responses

Response samples

200

Content type

application/json

null

Gets the unique id of a user, searching with his d

Gets the unique id of a user, searching with his database id.

Authorizations:

default_basic

path Parameters

dbId

required

integer <uint64>

useful help

Responses

Response samples

200

Content type

application/json

null

help

Shows all commands or detailed help about a specif

Shows all commands or detailed help about a specific command.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

"string"

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

["string"
]

This feature is not documented.

Authorizations:

default_basic

path Parameters

command

required

Array of strings

useful help

Responses

Response samples

200

Content type

application/json

{ }

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

"string"

history

<id> Adds the song with <id> to the queue

Adds the song with to the queue

Authorizations:

default_basic

path Parameters

hid

required

integer <uint32>

useful help

Responses

Response samples

200

Content type

application/json

null

Cleans up the history file for better startup perf

Cleans up the history file for better startup performance.

Authorizations:

default_basic

Responses

Checks for all links in the history which cannot b

Checks for all links in the history which cannot be opened anymore and removes them.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

<id> Removes the entry with <id> from the history

Removes the entry with from the history

Authorizations:

default_basic

path Parameters

id

required

integer <uint32>

useful help

Responses

Gets the last <count> songs from the user with the

Gets the last songs from the user with the given

Authorizations:

default_basic

path Parameters

userUid required	string useful help
amount required	integer <int32> useful help

Responses

Response samples

200

Content type

application/json

[null
]

<id> Displays all saved informations about the son

Displays all saved informations about the song with

Authorizations:

default_basic

path Parameters

id

required

integer <uint32>

useful help

Responses

Response samples

200

Content type

application/json

null

(last|next) Gets the highest|next song id

Authorizations:

default_basic

path Parameters

special

required

string

useful help

Responses

Response samples

200

Content type

application/json

0

<count> Gets the last <count> played songs.

Gets the last played songs.

Authorizations:

default_basic

path Parameters

amount

required

integer <int32>

useful help

Responses

Response samples

200

Content type

application/json

[null
]

Plays the last song again

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

<id> Playes the song with <id>

Playes the song with

Authorizations:

default_basic

path Parameters

hid

required

integer <uint32>

useful help

Responses

Response samples

200

Content type

application/json

null

<id> <name> Sets the name of the song with <id> to

Sets the name of the song with to

Authorizations:

default_basic

path Parameters

id required	integer <uint32> useful help
newName required	string useful help

Responses

<date> Gets all songs played until <date>.

Gets all songs played until .

Authorizations:

default_basic

path Parameters

time

required

string <date-time>

useful help

Responses

Response samples

200

Content type

application/json

[null
]

Gets all songs which title contains <string>

Gets all songs which title contains

Authorizations:

default_basic

path Parameters

part

required

string

useful help

Responses

Response samples

200

Content type

application/json

[null
]

json

Allows you to combine multiple JsonResults into on

Allows you to combine multiple JsonResults into one

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

This feature is not documented.

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

{ }

kickme

Guess what?

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null

Guess what?

Authorizations:

default_basic

Responses

Response samples

200

Content type

application/json

null