Download: TEAMSPEAK 3 SERVERQUERY MANUAL (2013‐09‐20) COPYRIGHT ©2009‐2013 TEAMSPEAK SYSTEMS GMBH CONTENT

TEAMSPEAK 3 SERVERQUERY MANUAL (2013‐09‐20) COPYRIGHT ©2009‐2013 TEAMSPEAK SYSTEMS GMBH  CONTENT

Content _1  Introduction _4  How to Establish a ServerQuery Connection_4Command Syntax _4  Summary of Command Syntax_4Examples of Command Syntax_4Escaping_5  Whitelisting and Blacklisting _6  How to Use the Whitelist_6How to Use the Blacklist_6Command Reference _7  help_ 7  quit_7login_7logout_7version_8hostinfo_8instanceinfo_ 8  instanceedit_ 8  bindinglist_9use_ 9  serverlist_9serveridgetbyport _ 10  serverdelete _ 10  servercreate _ 10  serverstart _ 10  serverstop _ 11  serverprocessstop_ 11  serverinfo _ 11  serverrequestconnectioninfo_ 11  servertemppasswordadd _ 12  servertemppassworddel_ 12  servertemppasswordlist_ 12  serveredit _ 13  servergrouplist _ 13  servergroupadd _ 14  servergroupdel _ 14  servergroupcopy _ 14  servergrouprename_ 14  servergrouppermlist _ 15  servergroupaddperm _ 15  servergroupdelperm _ 15  servergroupaddclient _ 16  ~ 1 ~, servergroupdelclient_ 16  servergroupclientlist_ 16  servergroupsbyclientid _ 16  servergroupautoaddperm _ 17  servergroupautodelperm_ 17  serversnapshotcreate _ 18  serversnapshotdeploy _ 18  servernotifyregister_ 18  servernotifyunregister_ 18  sendtextmessage _ 19  logview_ 19  logadd _ 19  gm _ 19  channellist _ 20  channelinfo _ 20  channelfind _ 20  channelmove _ 20  channelcreate_ 21  channeldelete_ 21  channeledit _ 22  channelgrouplist _ 22  channelgroupadd_ 23  channelgroupdel _ 23  channelgroupcopy _ 23  channelgrouprename _ 23  channelgroupaddperm_ 24  channelgrouppermlist _ 24  channelgroupdelperm _ 24  channelgroupclientlist _ 24  setclientchannelgroup _ 25  channelpermlist _ 25  channeladdperm _ 25  channeldelperm _ 25  clientlist _ 26  clientinfo _ 26  clientfind_ 26  clientedit _ 26  clientdblist _ 27  clientdbinfo _ 27  clientdbfind _ 27  clientdbedit _ 27  clientdbdelete _ 28  clientgetids _ 28  clientgetdbidfromuid _ 28  clientgetnamefromuid _ 28  clientgetnamefromdbid_ 28  clientsetserverquerylogin _ 29  clientupdate _ 29  clientmove _ 29  clientkick_ 29  clientpoke_ 30  clientpermlist_ 30  clientaddperm _ 30  clientdelperm_ 30  channelclientpermlist_ 31  channelclientaddperm _ 31  channelclientdelperm_ 31  permissionlist _ 31  ~ 2 ~, permidgetbyname_ 32  permoverview _ 32  permget _ 32  permfind _ 32  permreset _ 33  privilegekeylist _ 33  privilegekeyadd _ 33  privilegekeydelete_ 34  privilegekeyuse_ 34  messagelist _ 34  messageadd_ 34  messagedel _ 34  messageget _ 35  messageupdateflag _ 35  complainlist_ 35  complainadd _ 35  complaindelall _ 35  complaindel_ 36  banclient _ 36  banlist _ 36  banadd _ 36  bandel _ 37  bandelall _ 37  ftinitupload _ 37  ftinitdownload_ 37  ftlist_ 38  ftgetfilelist _ 38  ftgetfileinfo _ 38  ftstop _ 38  ftdeletefile _ 39  ftcreatedir_ 39  ftrenamefile_ 39  customsearch _ 39  custominfo _ 40  whoami_ 40  Server Instance Properties_ 41  Virtual Server Properties _ 42  Channel Properties _ 45  Client Properties _ 46  Definitions _ 48  ~ 3 ~,

INTRODUCTION

ServerQuery is a command‐line interface built into the TeamSpeak 3 Server which allows powerful scripting and automation tools to be built based on the exact same instruction set and functionality provided by the TeamSpeak 3 Client. For example, you can use scripts to automate the management of virtual servers or nightly backups. In short, you can perform operations more efficiently by using ServerQuery scripts than you can by using a user interface. This manual describes the general ServerQuery usage and syntax and provides examples for all commands available on a TeamSpeak 3 Server running version >= 3.0.5.

HOW TO ESTABLISH A SERVERQUERY CONNECTION

Connecting to a ServerQuery interface can be done by using a character‐mode terminal client such as Telnet or PuTTY. Basically, a ServerQuery client is acting like a real client, except it's unable to send or receive voice data. Per default, the TeamSpeak 3 Server is waiting for incoming ServerQuery connections on port 10011 (TCP). On success, the server should welcome you with a TS3 prompt.

COMMAND SYNTAX

This section describes the syntax of all ServerQuery commands.

SUMMARY OF COMMAND SYNTAX

ServerQuery commands follow the general syntax of: command [parameter…] [option…] The command is a single word which may contain lowercase letters, digits and underscore symbols (a‐z 0‐9 _) followed by a whitespace. A parameter block is made up of one or more key‐value pairs separated by a whitespace. In addition, various commands support options which are specified with a leading minus. For example: command key1=value1 key2=value2 -option1 -option2 Some commands accept grouped or nested parameters, therefore allowing you to apply an action on more than one object. Those parameters are separated by a pipe symbol (|). For example: command key1=value1|key1=value2|key1=value3 The pipe symbol (|) is also used to separate list items (e.g. multiple clients in a virtual servers clientlist).

EXAMPLES OF COMMAND SYNTAX

The following provides some common ServerQuery syntax examples: serverlist clientlist –uid –away –groups clientdbfind pattern=ScP clientdbfind pattern=FPMPSC6MXqXq751dX7BKV0JniSo= –uid clientkick reasonid=5 reasonmsg=Go\saway! clid=1|clid=2|clid=3 channelmove cid=16 cpid=1 order=0 sendtextmessage targetmode=2 target=12 msg=Hello\sWorld! ~ 4 ~,

ESCAPING

You cannot use whitespaces or any special characters in parameters. Instead, the TeamSpeak 3 Server supports the use of escape patterns which can be used to insert newlines, tabs or other special characters into a parameter string. The same escape patterns are used to clean up the servers output and prevent parsing issues. Here's an example on how to escape a parameter string correctly. RIGHT: serveredit virtualserver_name=TeamSpeak\s]\p[\sServer WRONG: serveredit virtualserver_name=TeamSpeak ]|[ Server The following characters need to be escaped if they are to be used: NAME CHAR ASCII REPLACE CHAR REPLACE ASCII Backslash \ 92 \\ 92 92 Slash / 47 \/ 92 47 Whitespace " " 32 \s 92 115 Pipe | 124 \p 92 112 Bell \a 7 \a 92 97 Backspace \b 8 \b 92 98 Formfeed \f 12 \f 92 102 Newline \n 10 \n 92 110 Carriage Return \r 13 \r 92 114 Horizontal Tab \t 9 \t 92 116 Vertical Tab \v 11 \v 92 118 ~ 5 ~,

WHITELISTING AND BLACKLISTING

The TeamSpeak 3 Server includes flood protection technology for the ServerQuery interface which means that a ServerQuery client can only execute a finite number of commands per time unit. These limits are controlled by the following server instance properties: SERVERINSTANCE_SERVERQUERY_FLOOD_COMMANDS SERVERINSTANCE_SERVERQUERY_FLOOD_TIME Per default, the TeamSpeak 3 Server will not allow more than 10 commands within 3 seconds from the same source. You can use the following command to modify these settings: instanceedit serverinstance_serverquery_flood_commands=10 serverinstance_serverquery_flood_time=3 If you're using automated scripts or web applications to manage your servers, it's most likely possible that you'll exceed those limits. Therefore, the TeamSpeak 3 Server provides whitelisting and blacklisting features for the ServerQuery interface.

HOW TO USE THE WHITELIST

The whitelist is a list of approved hosts that are allowed to ignore the flood protection settings on a TeamSpeak 3 Server. For example, if you're using a web administration interface, we strongly recommend that you add the IP address of your web server to the whitelist file. In a new installation of the TeamSpeak 3 Server, this file is called query_ip_whitelist.txt and it contains the loopback IP address of your server (127.0.0.1). You can enter an infinite number of IP addresses to the whitelist, one IP address per line. 85.25.120.233 80.190.225.233 75.125.142.2 194.97.114.2 79.218.0.0/16 127.0.0.1 The TeamSpeak 3 Server also supports Classless Inter‐Domain Routing (CIDR) notation so you can easily add an entire network to your whitelists. CIDR notation uses a syntax of specifying IP addresses using the base address of the network followed by a slash and the size of the routing prefix, e.g., 192.168.0.0/16 (IPv4) and 2001:db8::/32 (IPv6).

HOW TO USE THE BLACKLIST

The blacklist is a list of hosts that, for one reason or another, are being denied access to the ServerQuery interface. In a new installation of the TeamSpeak 3 Server, this file is called query_ip_blacklist.txt and is empty. The syntax of this file is equal to the whitelist, e.g. 0.0.0.0/0 will refuse all incoming connections. ~ 6 ~,

COMMAND REFERENCE

This is a list of the commands available when using the TeamSpeak 3 ServerQuery interface.

HELP

Provides information about ServerQuery commands. Used without parameters, help lists and briefly describes every command. b_serverinstance_help_view help [{command}] help serverinfo Usage: serverinfo Displays detailed configuration information about a virtual server including ID, number of clients online, configuration, etc.

QUIT

Closes the ServerQuery connection to the TeamSpeak 3 Server instance. quit quit

LOGIN

Authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials. Related Permissions: b_serverquery_login login client_login_name={username} client_login_password={password} login {username} {password} login client_login_name=xyz client_login_password=xyz

LOGOUT

Deselects the active virtual server and logs out from the server instance. b_serverquery_login logout Example: logout ~ 7 ~,

VERSION

Displays the servers version information including platform and build number. b_serverinstance_version_view version version version=3.0.0-alpha4 build=9155 platform=Linux

HOSTINFO

Displays detailed connection information about the server instance including uptime, number of virtual servers online, traffic information, etc. For detailed information, see Server Instance Properties. b_serverinstance_info_view hostinfo hostinfo instance_uptime=1903203 host_timestamp_utc=1259337246 virtualservers_running_total=1 connection_filetransfer_bandwidth_sent=0 …

INSTANCEINFO

Displays the server instance configuration including database revision number, the file transfer port, default group IDs, etc. For detailed information, see Server Instance Properties. Permissions: b_serverinstance_info_view instanceinfo instanceinfo serverinstance_database_version=11 serverinstance_filetransfer_port=30033 serverinstance_template_guest_serverquery_group=1 serverinstance_template_serveradmin_group=3 …

INSTANCEEDIT

Changes the server instance configuration using given properties. For detailed information, see Server Instance Properties. Permissions: b_serverinstance_modify_settings Syntax: instanceedit [instance_properties…] Example: instanceedit serverinstance_filetransfer_port=1337 ~ 8 ~,

BINDINGLIST

Displays a list of IP addresses used by the server instance on multi‐homed machines. b_serverinstance_binding_list bindinglist bindinglist ip=0.0.0.0

USE

Selects the virtual server specified with sid or port to allow further interaction. The ServerQuery client will appear on the virtual server and acts like a real TeamSpeak 3 Client, except it's unable to send or receive voice data. If your database contains multiple virtual servers using the same UDP port, use will select a random virtual server using the specified port. b_virtualserver_select use [sid={serverID}] [port={serverPort}] [-virtual] use {serverID} [-virtual] use sid=1

SERVERLIST

Displays a list of virtual servers including their ID, status, number of clients online, etc. If you're using the -all option, the server will list all virtual servers stored in the database. This can be useful when multiple server instances with different machine IDs are using the same database. The machine ID is used to identify the server instance a virtual server is associated with. The status of a virtual server can be either online, offline, deploy running, booting up, shutting down and virtual online. While most of them are self‐explanatory, virtual online is a bit more complicated. Please note that whenever you select a virtual server which is currently stopped, it will be started in virtual mode which means you are able to change its configuration, create channels or change permissions, but no regular TeamSpeak 3 Client can connect. As soon as the last ServerQuery client deselects the virtual server, its status will be changed back to offline. b_serverinstance_virtualserver_list serverlist [-uid] [-short] [-all] [-onlyoffline] Example: serverlist virtualserver_id=1 virtualserver_port=9987 virtualserver_status=online virtualserver_clientsonline=6 … ~ 9 ~,

SERVERIDGETBYPORT

Displays the database ID of the virtual server running on the UDP port specified by virtualserver_port. b_serverinstance_virtualserver_list serveridgetbyport virtualserver_port={serverPort} serveridgetbyport virtualserver_port=9987 server_id=1

SERVERDELETE

Deletes the virtual server specified with sid. Please note that only virtual servers in stopped state can be deleted. b_virtualserver_delete serverdelete sid={serverID} serverdelete sid=1

SERVERCREATE

Creates a new virtual server using the given properties and displays its ID, port and initial administrator privilege key. If virtualserver_port is not specified, the server will test for the first unused UDP port. The first virtual server will be running on UDP port 9987 by default. Subsequently started virtual servers will be running on increasing UDP port numbers. For detailed information, see Virtual Server Properties. Permissions: b_virtualserver_create servercreate virtualserver_name={serverName} [virtualserver_properties…] servercreate virtualserver_name=TeamSpeak\s]\p[\sServer virtualserver_port=9988 virtualserver_maxclients=32 sid=2 virtualserver_port=9988 token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW

SERVERSTART

Starts the virtual server specified with sid. Depending on your permissions, you're able to start either your own virtual server only or all virtual servers in the server instance. b_virtualserver_start_any b_virtualserver_start Syntax: serverstart sid={serverID} Example: serverstart sid=1 ~ 10 ~,

SERVERSTOP

Stops the virtual server specified with sid. Depending on your permissions, you're able to stop either your own virtual server only or all virtual servers in the server instance. b_virtualserver_stop_any b_virtualserver_stop serverstop sid={serverID} serverstop sid=1

SERVERPROCESSSTOP

Stops the entire TeamSpeak 3 Server instance by shutting down the process. b_serverinstance_stop serverprocessstop serverprocessstop

SERVERINFO

Displays detailed configuration information about the selected virtual server including unique ID, number of clients online, configuration, etc. For detailed information, see Virtual Server Properties. Permissions: b_virtualserver_info_view serverinfo serverinfo virtualserver_port=9987 virtualserver_unique_identifier=zrPkjznB1tMnRwj01xx7RxXjqeY= virtualserver_name=TeamSpeak\s]I[\sServer …

SERVERREQUESTCONNECTIONINFO

Displays detailed connection information about the selected virtual server including uptime, traffic information, etc. b_virtualserver_connectioninfo_view serverrequestconnectioninfo Example: serverrequestconnectioninfo connection_filetransfer_bandwidth_sent=0 connection_filetransfer_bandwidth_received=0 connection_packets_sent_total=241454 … ~ 11 ~,

SERVERTEMPPASSWORDADD

Sets a new temporary server password specified with pw. The temporary password will be valid for the number of seconds specified with duration. The client connecting with this password will automatically join the channel specified with tcid. If tcid is set to 0, the client will join the default channel. b_virtualserver_modify_password servertemppasswordadd pw={password} desc={description} duration={seconds} tcid={channelID} tcpw={channelPW} servertemppasswordadd pw=secret desc=none duration=3600 tcid=117535 tcpw=secret

SERVERTEMPPASSWORDDEL

Deletes the temporary server password specified with pw. b_virtualserver_modify_password servertemppassworddel pw={password} servertemppassworddel pw=secret

SERVERTEMPPASSWORDLIST

Returns a list of active temporary server passwords. The output contains the clear‐text password, the nickname and unique identifier of the creating client. Permissions: b_virtualserver_modify_password servertemppasswordlist servertemppasswordlist nickname=serveradmin uid=serveradmin desc=none pw_clear=secret start=1331496494 end=1331500094 tcid=117535 ~ 12 ~,

SERVEREDIT

Changes the selected virtual servers configuration using given properties. Note that this command accepts multiple properties which means that you're able to change all settings of the selected virtual server at once. For detailed information, see Virtual Server Properties. b_virtualserver_modify_name b_virtualserver_modify_welcomemessage b_virtualserver_modify_maxclients b_virtualserver_modify_reserved_slots b_virtualserver_modify_password b_virtualserver_modify_default_servergroup b_virtualserver_modify_default_channelgroup b_virtualserver_modify_default_channeladmingroup b_virtualserver_modify_ft_settings b_virtualserver_modify_ft_quotas b_virtualserver_modify_channel_forced_silence b_virtualserver_modify_complain b_virtualserver_modify_antiflood b_virtualserver_modify_hostmessage b_virtualserver_modify_hostbanner b_virtualserver_modify_hostbutton b_virtualserver_modify_port b_virtualserver_modify_autostart b_virtualserver_modify_needed_identity_security_level b_virtualserver_modify_priority_speaker_dimm_modificator b_virtualserver_modify_log_settings b_virtualserver_modify_icon_id b_virtualserver_modify_weblist b_virtualserver_modify_min_client_version b_virtualserver_modify_codec_encryption_mode serveredit [virtualserver_properties…] serveredit virtualserver_name=TeamSpeak\s]\p[\sServer virtualserver_maxclients=32

SERVERGROUPLIST

Displays a list of server groups available. Depending on your permissions, the output may also contain global ServerQuery groups and template groups. b_serverinstance_modify_querygroup b_serverinstance_modify_templates b_virtualserver_servergroup_list servergrouplist servergrouplist sgid=9 name=Server\sAdmin type=1 iconid=300 savedb=1|sgid=10 name=Normal type=1 iconid=0 savedb=1|sgid=11 … ~ 13 ~,

SERVERGROUPADD

Creates a new server group using the name specified with name and displays its ID. The optional type parameter can be used to create ServerQuery groups and template groups. For detailed information, see Definitions. b_virtualserver_servergroup_create servergroupadd name={groupName} [type={groupDbType}] servergroupadd name=Server\sAdmin sgid=13

SERVERGROUPDEL

Deletes the server group specified with sgid. If force is set to 1, the server group will be deleted even if there are clients within. b_virtualserver_servergroup_delete servergroupdel sgid={groupID} force={1|0} servergroupdel sgid=13

SERVERGROUPCOPY

Creates a copy of the server group specified with ssgid. If tsgid is set to 0, the server will create a new group. To overwrite an existing group, simply set tsgid to the ID of a designated target group. If a target group is set, the name parameter will be ignored. The type parameter can be used to create ServerQuery groups and template groups. For detailed information, see Definitions. b_virtualserver_servergroup_create i_group_modify_power i_group_needed_modify_power servergroupcopy ssgid={sourceGroupID} tsgid={targetGroupID} name={groupName} type={groupDbType} servergroupcopy ssgid=6 tsgid=0 name=My\sGroup\s(Copy) type=1 sgid=21

SERVERGROUPRENAME

Changes the name of the server group specified with sgid. Permissions: i_group_modify_power i_group_needed_modify_power Syntax: servergrouprename sgid={groupID} name={groupName} Example: servergrouprename sgid=13 name=New\sName ~ 14 ~,

SERVERGROUPPERMLIST

Displays a list of permissions assigned to the server group specified with sgid. If the –permsid option is specified, the output will contain the permission names instead of the internal IDs. b_virtualserver_servergroup_permission_list servergrouppermlist sgid={groupID} [-permsid] servergrouppermlist sgid=13 permid=8470 permvalue=1 permnegated=0 permskip=0|permid=8475 permvalue=1 …

SERVERGROUPADDPERM

Adds a set of specified permissions to the server group specified with sgid. Multiple permissions can be added by providing the four parameters of each permission. A permission can be specified by permid or permsid. i_group_modify_power i_group_needed_modify_power i_permission_modify_power servergroupaddperm sgid={groupID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}… permnegated={1|0}… permskip={1|0}… Examples: servergroupaddperm sgid=13 permid=17276 permvalue=50 permnegated=0 permskip=0|permid=21415 permvalue=20 permnegated=0 servergroupaddperm sgid=3 permsid=b_virtualserver_modify_maxclients permvalue=1 permnegated=0 permskip=0

SERVERGROUPDELPERM

Removes a set of specified permissions from the server group specified with sgid. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. i_group_modify_power i_group_needed_modify_power i_permission_modify_power servergroupdelperm sgid={groupID} [permid={permID}…] [permsid={permName}…] Examples: servergroupdelperm sgid=16 permid=17276|permid=21415 servergroupdelperm sgid=3 permsid=b_virtualserver_modify_maxclients ~ 15 ~,

SERVERGROUPADDCLIENT

Adds a client to the server group specified with sgid. Please note that a client cannot be added to default groups or template groups. i_group_member_add_power i_group_needed_member_add_power servergroupaddclient sgid={groupID} cldbid={clientDBID} servergroupaddclient sgid=16 cldbid=3

SERVERGROUPDELCLIENT

Removes a client specified with cldbid from the server group specified with sgid. i_group_member_remove_power i_group_needed_member_remove_power servergroupdelclient sgid={groupID} cldbid={clientDBID} servergroupdelclient sgid=16 cldbid=3

SERVERGROUPCLIENTLIST

Displays the IDs of all clients currently residing in the server group specified with sgid. If you're using the optional -names option, the output will also contain the last known nickname and the unique identifier of the clients. Permissions: b_virtualserver_servergroup_client_list servergroupclientlist sgid={groupID} [-names] servergroupclientlist sgid=16 cldbid=7|cldbid=8|cldbid=9|cldbid=11|cldbid=13|cldbid=16|cldbid=18|cldbid=29|cldbid=32|cldbid=34|cldbid=37|cldbid=4 0|cldbid=47|cldbid=53

SERVERGROUPSBYCLIENTID

Displays all server groups the client specified with cldbid is currently residing in. servergroupsbyclientid cldbid={clientDBID} servergroupsbyclientid cldbid=18 name=Server\sAdmin sgid=6 cldbid=18 ~ 16 ~,

SERVERGROUPAUTOADDPERM

Adds a set of specified permissions to *ALL* regular server groups on all virtual servers. The target groups will be identified by the value of their i_group_auto_update_type permission specified with sgtype. Multiple permissions can be added at once. A permission can be specified by permid or permsid. The known values for sgtype are: 10: Channel Guest 15: Server Guest 20: Query Guest 25: Channel Voice 30: Server Normal 35: Channel Operator 40: Channel Admin 45: Server Admin 50: Query Admin b_permission_modify_power_ignore servergroupautoaddperm sgtype={groupID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}… permnegated={1|0}… permskip={1|0}… servergroupautoaddperm sgtype=45 permsid=b_virtualserver_start permvalue=1 permskip=0 permnegated=0

SERVERGROUPAUTODELPERM

Removes a set of specified permissions from *ALL* regular server groups on all virtual servers. The target groups will be identified by the value of their i_group_auto_update_type permission specified with sgtype. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. The known values for sgtype are: 10: Channel Guest 15: Server Guest 20: Query Guest 25: Channel Voice 30: Server Normal 35: Channel Operator 40: Channel Admin 45: Server Admin 50: Query Admin b_permission_modify_power_ignore servergroupautoaddperm sgtype={groupID} [permid={permID}…] [permsid={permName}…] servergroupautoaddperm sgtype=45 permsid=b_virtualserver_start ~ 17 ~,

SERVERSNAPSHOTCREATE

Displays a snapshot of the selected virtual server containing all settings, groups and known client identities. The data from a server snapshot can be used to restore a virtual servers configuration, channels and permissions using the serversnapshotdeploy command. b_virtualserver_snapshot_create serversnapshotcreate serversnapshotcreate hash=bnTd2E1kNITHjJYRCFjgbKKO5P8=|virtualserver_unique_identifier=zrPkjznB1tMnRwj01xx7RxXjqeY= virtualserver_name=TeamSpeak\s]I[\sServer …

SERVERSNAPSHOTDEPLOY

Restores the selected virtual servers configuration using the data from a previously created server snapshot. Please note that the TeamSpeak 3 Server does NOT check for necessary permissions while deploying a snapshot so the command could be abused to gain additional privileges. b_virtualserver_snapshot_deploy serversnapshotdeploy virtualserver_snapshot serversnapshotdeploy hash=bnTd2E1kNITHjJYRCFjgbKKO5P8=|virtualserver_unique_identifier=zrPkjznB1tMnRwj01xx7RxXjq= … error id=0 msg=ok

SERVERNOTIFYREGISTER

Registers for a specified category of events on a virtual server to receive notification messages. Depending on the notifications you've registered for, the server will send you a message on every event in the view of your ServerQuery client (e.g. clients joining your channel, incoming text messages, server configuration changes, etc). The event source is declared by the event parameter while id can be used to limit the notifications to a specific channel. b_virtualserver_notify_register servernotifyregister event={server|channel|textserver|textchannel|textprivate} [id={channelID}] servernotifyregister event=server

SERVERNOTIFYUNREGISTER

Unregisters all events previously registered with servernotifyregister so you will no longer receive notification messages. Permissions: b_virtualserver_notify_unregister Syntax: servernotifyunregister Example: servernotifyunregister ~ 18 ~,

SENDTEXTMESSAGE

Sends a text message a specified target. The type of the target is determined by targetmode while target specifies the ID of the recipient, whether it be a virtual server, a channel or a client. For detailed information, see Definitions. i_client_private_textmessage_power i_client_needed_private_textmessage_power b_client_server_textmessage_send b_client_channel_textmessage_send sendtextmessage targetmode={1-3} target={serverID|channelID|clientID} msg={text} sendtextmessage targetmode=2 target=1 msg=Hello\sWorld!

LOGVIEW

Displays a specified number of entries from the servers log. If instance is set to 1, the server will return lines from the master logfile (ts3server_0.log) instead of the selected virtual server logfile. b_serverinstance_log_view b_virtualserver_log_view logview [lines={1-100}] [reverse={1|0}] [instance={1|0}] [begin_pos={n}] logview lines=30 last_pos=403788 file_size=411980 l=\p\slistening\son\s0.0.0.0:9987 …

LOGADD

Writes a custom entry into the servers log. Depending on your permissions, you'll be able to add entries into the server instance log and/or your virtual servers log. The loglevel parameter specifies the type of the entry. For detailed information, see Definitions. b_serverinstance_log_add b_virtualserver_log_add logadd loglevel={1-4} logmsg={text} logadd loglevel=4 logmsg=Informational\smessage!

GM

Sends a text message to all clients on all virtual servers in the TeamSpeak 3 Server instance. Permissions: b_serverinstance_textmessage_send Syntax: gm msg={text} Example: gm msg=Hello\sWorld! ~ 19 ~,

CHANNELLIST

Displays a list of channels created on a virtual server including their ID, order, name, etc. The output can be modified using several command options. b_virtualserver_channel_list channellist [-topic] [-flags] [-voice] [-limits] [-icon] [-secondsempty] channellist -topic cid=15 pid=0 channel_order=0 channel_name=Default\sChannel channel_topic=Default\sChannel\shas\sno\s[b]topic[\/b] total_clients=2|cid=16 …

CHANNELINFO

Displays detailed configuration information about a channel including ID, topic, description, etc. For detailed information, see Channel Properties. b_channel_info_view channelinfo cid={channelID} channelinfo cid=1 channel_name=Default\sChannel channel_topic=Default\sChannel\shas\sno\s[b]topic[\/b] channel_description=This\sis\sthe\sdefault\schannel …

CHANNELFIND

Displays a list of channels matching a given name pattern. Permissions: b_virtualserver_channel_search channelfind [pattern={channelName}] channelfind pattern=default cid=15 channel_name=Default\sChannel

CHANNELMOVE

Moves a channel to a new parent channel with the ID cpid. If order is specified, the channel will be sorted right under the channel with the specified ID. If order is set to 0, the channel will be sorted right below the new parent. i_channel_min_depth i_channel_max_depth b_channel_modify_parent b_channel_modify_sortorder Syntax: channelmove cid={channelID} cpid={channelParentID} [order={channelSortOrder}] Example: channelmove cid=16 cpid=1 order=0 ~ 20 ~,

CHANNELCREATE

Creates a new channel using the given properties and displays its ID. Note that this command accepts multiple properties which means that you're able to specifiy all settings of the new channel at once. For detailed information, see Channel Properties. i_channel_min_depth i_channel_max_depth b_channel_create_child b_channel_create_permanent b_channel_create_semi_permanent b_channel_create_temporary b_channel_create_with_topic b_channel_create_with_description b_channel_create_with_password b_channel_create_modify_with_codec_speex8 b_channel_create_modify_with_codec_speex16 b_channel_create_modify_with_codec_speex32 b_channel_create_modify_with_codec_celtmono48 i_channel_create_modify_with_codec_maxquality i_channel_create_modify_with_codec_latency_factor_min b_channel_create_with_maxclients b_channel_create_with_maxfamilyclients b_channel_create_with_sortorder b_channel_create_with_default b_channel_create_with_needed_talk_power channelcreate channel_name={channelName} [channel_properties…] channelcreate channel_name=My\sChannel channel_topic=My\sTopic cid=16

CHANNELDELETE

Deletes an existing channel by ID. If force is set to 1, the channel will be deleted even if there are clients within. The clients will be kicked to the default channel with an appropriate reason message. b_channel_delete_permanent b_channel_delete_semi_permanent b_channel_delete_temporary b_channel_delete_flag_force channeldelete cid={channelID} force={1|0} channeldelete cid=16 force=1 ~ 21 ~,

CHANNELEDIT

Changes a channels configuration using given properties. Note that this command accepts multiple properties which means that you're able to change all settings of the channel specified with cid at once. For detailed information, see Channel Properties. i_channel_min_depth i_channel_max_depth b_channel_modify_parent b_channel_modify_make_default b_channel_modify_make_permanent b_channel_modify_make_semi_permanent b_channel_modify_make_temporary b_channel_modify_name b_channel_modify_topic b_channel_modify_description b_channel_modify_password b_channel_modify_codec b_channel_create_modify_with_codec_speex8 b_channel_create_modify_with_codec_speex16 b_channel_create_modify_with_codec_speex32 b_channel_create_modify_with_codec_celtmono48 b_channel_modify_codec_quality b_channel_create_modify_with_codec_maxquality b_channel_modify_codec_latency_factor b_channel_modify_make_codec_encrypted b_channel_modify_maxclients b_channel_modify_maxfamilyclients b_channel_modify_sortorder b_channel_modify_needed_talk_power i_channel_modify_power i_channel_needed_modify_power channeledit cid={channelID} [channel_properties…] channeledit cid=15 channel_codec_quality=3 channel_description=My\sDescription

CHANNELGROUPLIST

Displays a list of channel groups available on the selected virtual server. b_virtualserver_channelgroup_list b_serverinstance_modify_templates channelgrouplist channelgrouplist cgid=1 name=Channel\sAdmin type=2 iconid=100 savedb=1|cgid=2 … ~ 22 ~,

CHANNELGROUPADD

Creates a new channel group using a given name and displays its ID. The optional type parameter can be used to create ServerQuery groups and template groups. For detailed information, see Definitions. b_virtualserver_channelgroup_create channelgroupadd name={groupName} [type={groupDbType}] channelgroupadd name=Channel\sAdmin cgid=13

CHANNELGROUPDEL

Deletes a channel group by ID. If force is set to 1, the channel group will be deleted even if there are clients within. b_virtualserver_channelgroup_delete channelgroupdel cgid={groupID} force={1|0} channelgroupdel cgid=13

CHANNELGROUPCOPY

Creates a copy of the channel group specified with scgid. If tcgid is set to 0, the server will create a new group. To overwrite an existing group, simply set tcgid to the ID of a designated target group. If a target group is set, the name parameter will be ignored. The type parameter can be used to create ServerQuery groups and template groups. For detailed information, see Definitions. b_virtualserver_channelgroup_create i_group_modify_power i_group_needed_modify_power channelgroupcopy scgid={sourceGroupID} tsgid={targetGroupID} name={groupName} type={groupDbType} channelgroupcopy scgid=4 tcgid=0 name=My\sGroup\s(Copy) type=1 cgid=33

CHANNELGROUPRENAME

Changes the name of a specified channel group. Permissions: i_group_modify_power i_group_needed_modify_power Syntax: channelgrouprename cgid={groupID} name={groupName} Example: channelgrouprename cgid=13 name=New\sName ~ 23 ~,

CHANNELGROUPADDPERM

Adds a set of specified permissions to a channel group. Multiple permissions can be added by providing the two parameters of each permission. A permission can be specified by permid or permsid. i_group_modify_power i_group_needed_modify_power i_permission_modify_power channelgroupaddperm cgid={groupID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}… channelgroupaddperm cgid=13 permid=17276 permvalue=50|permid=21415 permvalue=20

CHANNELGROUPPERMLIST

Displays a list of permissions assigned to the channel group specified with cgid. If the –permsid option is specified, the output will contain the permission names instead of the internal IDs. b_virtualserver_channelgroup_permission_list channelgrouppermlist cgid={groupID} [-permsid] channelgrouppermlist cgid=13 permid=8470 permvalue=1 permnegated=0 permskip=0|permid=8475 permvalue=1 …

CHANNELGROUPDELPERM

Removes a set of specified permissions from the channel group. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. Permissions: i_group_modify_power i_group_needed_modify_power i_permission_modify_power channelgroupdelperm cgid={groupID} [permid={permID}…] [permsid={permName}…] channelgroupdelperm cgid=16 permid=17276|permid=21415

CHANNELGROUPCLIENTLIST

Displays all the client and/or channel IDs currently assigned to channel groups. All three parameters are optional so you're free to choose the most suitable combination for your requirements. b_virtualserver_channelgroup_client_list Syntax: channelgroupclientlist [cid={channelID}] [cldbid={clientDBID}] [cgid={groupID}] Example: channelgroupclientlist cid=2 cgid=9 cid=2 cldbid=9 cgid=9|cid=2 cldbid=24 cgid=9|cid=2 cldbid=47 cgid=9 ~ 24 ~,

SETCLIENTCHANNELGROUP

Sets the channel group of a client to the ID specified with cgid. i_group_member_add_power i_group_needed_member_add_power i_group_member_remove_power i_group_needed_member_remove_power setclientchannelgroup cgid={groupID} cid={channelID} cldbid={clientDBID} setclientchannelgroup cgid=13 cid=15 cldbid=20

CHANNELPERMLIST

Displays a list of permissions defined for a channel. b_virtualserver_channel_permission_list channelpermlist cid={channelID} [-permsid] channelpermlist cid=2 cid=2 permid=4353 permvalue=1 permnegated=0 permskip=0|permid=17276 permvalue=50 …

CHANNELADDPERM

Adds a set of specified permissions to a channel. Multiple permissions can be added by providing the two parameters of each permission. A permission can be specified by permid or permsid. Permissions: i_group_modify_power i_group_needed_modify_power i_permission_modify_power channeladdperm cid={channelID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}… channeladdperm cid=16 permid=17276 permvalue=50|permid=21415 permvalue=20

CHANNELDELPERM

Removes a set of specified permissions from a channel. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. i_group_modify_power i_group_needed_modify_power i_permission_modify_power Syntax: channeldelperm cid=123 [permid={permID}…] [permsid={permName}…] Example: channeldelperm cid=16 permid=17276|permid=21415 ~ 25 ~,

CLIENTLIST

Displays a list of clients online on a virtual server including their ID, nickname, status flags, etc. The output can be modified using several command options. Please note that the output will only contain clients which are currently in channels you're able to subscribe to. b_virtualserver_client_list i_channel_subscribe_power i_channel_needed_subscribe_power clientlist [-uid] [-away] [-voice] [-times] [-groups] [-info] [-icon] [-country] [-ip] clientlist -away clid=5 cid=7 client_database_id=40 client_nickname=ScP client_type=0 client_away=1 client_away_message=not\shere|clid=6 …

CLIENTINFO

Displays detailed configuration information about a client including unique ID, nickname, client version, etc. b_client_info_view clientinfo clid={clientID} clientinfo clid=6 client_unique_identifier=P5H2hrN6+gpQI4n\/dXp3p17vtY0= client_nickname=Rabe85 client_version=3.0.0- alpha24\s[Build:\s8785]\s(UI:\s8785) …

CLIENTFIND

Displays a list of clients matching a given name pattern. Permissions: b_virtualserver_client_search clientfind pattern={clientName} clientfind pattern=sven clid=7 client_nickname=Sven

CLIENTEDIT

Changes a clients settings using given properties. For detailed information, see Client Properties. b_client_modify_description b_client_set_talk_power Syntax: clientedit clid={clientID} [client_properties…] Example: clientedit clid=10 client_description=Best\sguy\sever! ~ 26 ~,

CLIENTDBLIST

Displays a list of client identities known by the server including their database ID, last nickname, etc. b_virtualserver_client_dblist clientdblist [start={offset}] [duration={limit}] [-count] clientdblist cldbid=7 client_unique_identifier=DZhdQU58qyooEK4Fr8Ly738hEmc= client_nickname=MuhChy client_created=1259147468 client_lastconnected=1259421233 error id=0 msg=ok

CLIENTDBINFO

Displays detailed database information about a client including unique ID, creation date, etc. b_virtualserver_client_dbinfo clientdbinfo cldbid={clientDBID} clientdbfind cldbid=4 client_unique_identifier=FPMPSC6MXqXq751dX7BKV0JniSo= client_nickname=ScP client_created=1265411019

CLIENTDBFIND

Displays a list of client database IDs matching a given pattern. You can either search for a clients last known nickname or his unique identity by using the -uid option. Permissions: b_virtualserver_client_dbsearch clientdbfind pattern={clientName|clientUID} [-uid] clientdbfind pattern=sven cldbid=56

CLIENTDBEDIT

Changes a clients settings using given properties. For detailed information, see Client Properties. b_client_modify_dbproperties b_client_modify_description b_client_set_talk_power clientdbedit cldbid={clientDBID} [client_properties…] Example: clientdbedit cldbid=56 client_description=Best\sguy\sever! ~ 27 ~,

CLIENTDBDELETE Deletes a clients properties from the database.

b_client_delete_dbproperties clientdbdelete cldbid={clientDBID} clientdbdelete cldbid=56

CLIENTGETIDS Displays all client IDs matching the unique identifier specified by cluid.

clientgetids cluid={clientUID} clientgetids cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= clid=1 name=Janko

CLIENTGETDBIDFROMUID Displays the database ID matching the unique identifier specified by cluid.

clientgetdbidfromuid cluid={clientUID} clientgetdbidfromuid cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= cldbid=32

CLIENTGETNAMEFROMUID Displays the database ID and nickname matching the unique identifier specified by cluid.

clientgetnamefromuid cluid={clientUID} clientgetnamefromuid cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= cldbid=32 name=Janko

CLIENTGETNAMEFROMDBID Displays the unique identifier and nickname matching the database ID specified by cldbid.

clientgetnamefromdbid cldbid={clientDBID} clientgetnamefromdbid cldbid=32 cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= cldbid=32 name=Janko ~ 28 ~,

CLIENTSETSERVERQUERYLOGIN

Updates your own ServerQuery login credentials using a specified username. The password will be auto‐ generated. b_client_create_modify_serverquery_login clientsetserverquerylogin client_login_name={username} clientsetserverquerylogin client_login_name=admin client_login_password=+r\/TQqvR

CLIENTUPDATE

Change your ServerQuery clients settings using given properties. For detailed information, see Client Properties. clientupdate [client_properties…] clientupdate client_nickname=ScP\s(query)

CLIENTMOVE

Moves one or more clients specified with clid to the channel with ID cid. If the target channel has a password, it needs to be specified with cpw. If the channel has no password, the parameter can be omitted. Permissions: i_client_move_power i_client_needed_move_power clientmove clid={clientID}… cid={channelID} [cpw={channelPassword}] clientmove clid=5|clid=6 cid=3

CLIENTKICK

Kicks one or more clients specified with clid from their currently joined channel or from the server, depending on reasonid. The reasonmsg parameter specifies a text message sent to the kicked clients. This parameter is optional and may only have a maximum of 40 characters. For detailed information, see Definitions. i_client_kick_from_server_power i_client_kick_from_channel_power i_client_needed_kick_from_server_power i_client_needed_kick_from_channel_power Syntax: clientkick clid={clientID}… reasonid={4|5} [reasonmsg={text}] Example: clientkick clid=5|clid=6 reasonid=4 reasonmsg=Go\saway! ~ 29 ~,

CLIENTPOKE

Sends a poke message to the client specified with clid. i_client_poke_power i_client_needed_poke_power clientpoke clid={clientID}… msg={text} clientpoke clid=5 msg=Wake\sup!

CLIENTPERMLIST

Displays a list of permissions defined for a client. b_virtualserver_client_permission_list clientpermlist cldbid={clientDBID} [-permsid] clientpermlist cldbid=2 cldbid=2 permid=4353 permvalue=1 permnegated=0 permskip=0|permid=17276 permvalue=50 permnegated=0 permskip=0|permid=21415 …

CLIENTADDPERM

Adds a set of specified permissions to a client. Multiple permissions can be added by providing the three parameters of each permission. A permission can be specified by permid or permsid. Permissions: i_group_modify_power i_group_needed_modify_power i_permission_modify_power clientaddperm cldbid={clientDBID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}… permskip={1|0}… clientaddperm cldbid=16 permid=17276 permvalue=50 permskip=1|permid=21415 permvalue=20 permskip=0

CLIENTDELPERM

Removes a set of specified permissions from a client. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. i_group_modify_power i_group_needed_modify_power i_permission_modify_power Syntax: channeldelperm cldbid={clientDBID} [permid={permID}…] [permsid={permName}…] Example: clientdelperm cldbid=16 permid=17276|permid=21415 ~ 30 ~,

CHANNELCLIENTPERMLIST

Displays a list of permissions defined for a client in a specific channel. b_virtualserver_channelclient_permission_list channelclientpermlist cid={channelID} cldbid={clientDBID} [-permsid] channelclientpermlist cid=12 cldbid=3 cid=12 cldbid=3 permid=4353 permvalue=1 permnegated=0 permskip=0|permid=17276 permvalue=50 permnegated=0 permskip=0|permid=21415 …

CHANNELCLIENTADDPERM

Adds a set of specified permissions to a client in a specific channel. Multiple permissions can be added by providing the three parameters of each permission. A permission can be specified by permid or permsid. i_group_modify_power i_group_needed_modify_power i_permission_modify_power channelclientaddperm cid={channelID} cldbid={clientDBID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}… channelclientaddperm cid=12 cldbid=3 permid=17276 permvalue=50|permid=21415 permvalue=20

CHANNELCLIENTDELPERM

Removes a set of specified permissions from a client in a specific channel. Multiple permissions can be removed at once. A permission can be specified by permid or permsid. Permissions: i_group_modify_power i_group_needed_modify_power i_permission_modify_power channelclientdelperm cid={channelID} cldbid={clientDBID} [permid={permID}…] [permsid={permName}…] channelclientdelperm cid=12 cldbid=3 permid=17276|permid=21415

PERMISSIONLIST

Displays a list of permissions available on the server instance including ID, name and description. b_serverinstance_permission_list Syntax: permissionlist Example: permissionlist permid=21413 permname=b_client_channel_textmessage_send permdesc=Send\stext\smessages\sto\schannel|permid=21414 permname=i_client_talk_power … ~ 31 ~,

PERMIDGETBYNAME

Displays the database ID of one or more permissions specified by permsid. b_serverinstance_permission_list permidgetbyname permsid={permName}… permidgetbyname permsid=b_serverinstance_help_view|permsid=b_serverinstance_info_view permsid=b_serverinstance_help_view permid=4353|permsid=b_serverinstance_info_view permid=4355

PERMOVERVIEW

Displays all permissions assigned to a client for the channel specified with cid. If permid is set to 0, all permissions will be displayed. A permission can be specified by permid or permsid. b_client_permissionoverview_view permoverview cid={channelID} cldbid={clientDBID} [permid={permID}…] [permsid={permName}…] permoverview cldbid=57 cid=74 permid=0 t=0 id1=5 id2=0 p=37 v=1 n=0 s=0|t=0 id1=5 id2=0 p=38 v=1 n=0 s=0 …

PERMGET

Displays the current value of the permission specified with permid or permsid for your own connection. This can be useful when you need to check your own privileges. Permissions: b_client_permissionoverview_own permget permid={permID} permget permsid={permName} permget permid=21174 permsid=i_client_move_power permid=21174 permvalue=100 permget permsid=i_client_move_power permsid=i_client_move_power permid=21174 permvalue=100

PERMFIND

Displays detailed information about all assignments of the permission specified with permid. The output is similar to permoverview which includes the type and the ID of the client, channel or group associated with the permission. A permission can be specified by permid or permsid. b_virtualserver_permission_find b_serverinstance_permission_find Syntax: permfind [permid={permID}…] [permsid={permName}…] Example: permfind permid=4353 t=0 id1=1 id2=0 p=4353|t=0 id1=2 id2=0 p=4353 ~ 32 ~,

PERMRESET

Restores the default permission settings on the selected virtual server and creates a new initial administrator token. Please note that in case of an error during the permreset call ‐ e.g. when the database has been modified or corrupted ‐ the virtual server will be deleted from the database. b_virtualserver_permission_reset permreset permreset token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW

PRIVILEGEKEYLIST

Displays a list of privilege keys available including their type and group IDs. Tokens can be used to gain access to specified server or channel groups. A privilege key is similar to a client with administrator privileges that adds you to a certain permission group, but without the necessity of a such a client with administrator privileges to actually exist. It is a long (random looking) string that can be used as a ticket into a specific server group. Permissions: b_virtualserver_token_list privilegekeylist privilegekeylist token=88CVUg\/zkujt+y+WfHdko79UcM4R6uyCL6nEfy3B token_type=0 token_id1=9 token_id2=0 …

PRIVILEGEKEYADD

Create a new token. If tokentype is set to 0, the ID specified with tokenid1 will be a server group ID. Otherwise, tokenid1 is used as a channel group ID and you need to provide a valid channel ID using tokenid2. The tokencustomset parameter allows you to specify a set of custom client properties. This feature can be used when generating tokens to combine a website account database with a TeamSpeak user. The syntax of the value needs to be escaped using the ServerQuery escape patterns and has to follow the general syntax of: ident=ident1 value=value1|ident=ident2 value=value2|ident=ident3 value=value3 b_virtualserver_token_add privilegekeyadd tokentype={1|0} tokenid1={groupID} tokenid2={channelID} [tokendescription={description}] [tokencustomset={customFieldSet}] tokenadd tokentype=0 tokenid1=6 tokenid2=0 tokendescription=Test\stoken\swith\scustom\sset tokencustomset=ident=forum_user\svalue=Sven\sPaulsen\pident=forum_id\svalue=123 token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW ~ 33 ~,

PRIVILEGEKEYDELETE

Deletes an existing token matching the token key specified with token. b_virtualserver_token_delete privilegekeydelete token={tokenKey} privilegekeydelete token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW

PRIVILEGEKEYUSE

Use a token key gain access to a server or channel group. Please note that the server will automatically delete the token after it has been used. b_virtualserver_token_use privilegekeyuse token={tokenKey} privilegekeyuse token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW

MESSAGELIST

Displays a list of offline messages you've received. The output contains the senders unique identifier, the messages subject, etc. messagelist messagelist msgid=4 cluid=xwEzb5ENOaglVHu9oelK++reUyE= subject=Test timestamp=1259439465 flag_read=0 …

MESSAGEADD

Sends an offline message to the client specified by cluid. messageadd cluid={clientUID} subject={subject} message={text} messageadd cluid=oHhi9WzXLNEFQOwAu4JYKGU+C+c= subject=Hi! message=Where\aare\syou?!?

MESSAGEDEL

Deletes an existing offline message with ID msgid from your inbox. messagedel msgid={messageID} Example: messagedel msgid=4 ~ 34 ~,

MESSAGEGET

Displays an existing offline message with ID msgid from your inbox. Please note that this does not automatically set the flag_read property of the message. messageget msgid={messageID} Example: messageget msgid=4 msgid=4 cluid=xwEzb5ENOaglVHu9oelK++reUyE= subject=Hi! message=Where\aare\syou?!?

MESSAGEUPDATEFLAG

Updates the flag_read property of the offline message specified with msgid. If flag is set to 1, the message will be marked as read. messageupdateflag msgid={messageID} flag={1|0} messageupdateflag msgid=4 flag=1

COMPLAINLIST

Displays a list of complaints on the selected virtual server. If tcldbid is specified, only complaints about the targeted client will be shown. Permissions: b_client_complain_list complainlist [tcldbid={targetClientDBID}] complainlist tcldbid=3 tcldbid=3 tname=Julian fcldbid=56 fname=Sven message=Bad\sguy! timestamp=1259440948 …

COMPLAINADD

Submits a complaint about the client with database ID tcldbid to the server. i_client_complain_power i_client_needed_complain_power complainadd tcldbid={targetClientDBID} message={text} complainadd tcldbid=3 message=Bad\sguy!

COMPLAINDELALL

Deletes all complaints about the client with database ID tcldbid from the server. Permissions: b_client_complain_delete Syntax: complaindelall tcldbid={targetClientDBID} Example: complaindelall tcldbid=3 ~ 35 ~,

COMPLAINDEL

Deletes the complaint about the client with ID tcldbid submitted by the client with ID fcldbid from the server. b_client_complain_delete b_client_complain_delete_own complaindel tcldbid={targetClientDBID} fcldbid={fromClientDBID} complaindel tcldbid=3 fcldbid=4

BANCLIENT

Bans the client specified with ID clid from the server. Please note that this will create two separate ban rules for the targeted clients IP address and his unique identifier. i_client_ban_power i_client_needed_ban_power banclient clid={clientID} [time={timeInSeconds}] [banreason={text}] banclient clid=4 time=3600 banid=2 banid=3

BANLIST

Displays a list of active bans on the selected virtual server. Permissions: b_client_ban_list banlist banlist banid=7 ip=1.2.3.4 created=1259444002242 invokername=Sven invokercldbid=56 invokeruid=oHhi9WzXLNEFQOwAu4JYKGU+C+c= reason enforcements=0

BANADD

Adds a new ban rule on the selected virtual server. All parameters are optional but at least one of the following must be set: ip, name, or uid. b_client_ban_create banadd [ip={regexp}] [name={regexp}] [uid={clientUID}] [time={timeInSeconds}] [banreason={text}] Example: banadd ip=1.2.3.4 banreason=just\s4\sfun banid=1 ~ 36 ~,

BANDEL

Deletes the ban rule with ID banid from the server. b_client_ban_delete b_client_ban_delete_own bandel banid={banID} bandel banid=3

BANDELALL

Deletes all active ban rules from the server. b_client_ban_delete bandelall bandelall

FTINITUPLOAD

Initializes a file transfer upload. clientftfid is an arbitrary ID to identify the file transfer on client‐side. On success, the server generates a new ftkey which is required to start uploading the file through TeamSpeak 3's file transfer interface. Permissions: i_ft_file_upload_power i_ft_needed_file_ upload _power i_ft_quota_mb_upload_per_client ftinitupload clientftfid={clientFileTransferID} name={filePath} cid={channelID} cpw={channelPassword} size={fileSize} overwrite={1|0} resume={1|0} ftinitupload clientftfid=1 name=\/image.iso cid=5 cpw= size=673460224 overwrite=1 resume=0 clientftfid=1 serverftfid=6 ftkey=itRNdsIOvcBiBg\/Xj4Ge51ZSrsShHuid port=30033 seekpos=0

FTINITDOWNLOAD

Initializes a file transfer download. clientftfid is an arbitrary ID to identify the file transfer on client‐side. On success, the server generates a new ftkey which is required to start downloading the file through TeamSpeak 3's file transfer interface. i_ft_file_download_power i_ft_needed_file_ download _power i_ft_quota_mb_ download _per_client Syntax: ftinitdownload clientftfid={clientFileTransferID} name={filePath} cid={channelID} cpw={channelPassword} seekpos={seekPosition} Example: ftinitdownload clientftfid=1 name=\/image.iso cid=5 cpw= seekpos=0 clientftfid=1 serverftfid=7 ftkey=NrOga\/4d2GpYC5oKgxuclTO37X83ca\/1 port=30033 size=673460224 ~ 37 ~,

FTLIST Displays a list of running file transfers on the selected virtual server. The output contains the path to which a

file is uploaded to, the current transfer rate in bytes per second, etc. b_ft_transfer_list ftlist ftlist clid=2 path=files\/virtualserver_1\/channel_5 name=image.iso size=673460224 sizedone=450756 clientftfid=2 serverftfid=6 sender=0 status=1 current_speed=60872.8 …

FTGETFILELIST Displays a list of files and directories stored in the specified channels file repository.

i_ft_file_browse_power i_ft_needed_file_browse_power ftgetfilelist cid={channelID} cpw={channelPassword} path={filePath} ftgetfilelist cid=2 cpw= path=\/ cid=2 path=\/ name=Stuff size=0 datetime=1259415210 type=0|name=Pic1.PNG size=563783 datetime=1259425462 type=1|name=Pic2.PNG …

FTGETFILEINFO Displays detailed information about one or more specified files stored in a channels file repository. Permissions:

i_ft_file_browse_power i_ft_needed_file_browse_power ftgetfileinfo cid={channelID} cpw={channelPassword} name={filePath}… ftgetfileinfo cid=2 cpw= path=\/Pic1.PNG|cid=2 cpw= path=\/Pic2.PNG cid=2 path=\/ name=Stuff size=0 datetime=1259415210 type=0|name=Pic1.PNG size=563783 datetime=1259425462 type=1|name=Pic2.PNG …

FTSTOP Stops the running file transfer with server‐side ID serverftfid.

ftstop serverftfid={serverFileTransferID} delete={1|0} ftstop serverftfid=2 delete=1 ~ 38 ~,

FTDELETEFILE

Deletes one or more files stored in a channels file repository. i_ft_file_delete_power i_ft_needed_file_delete_power ftdeletefile cid={channelID} cpw={channelPassword} name={filePath}… ftdeletefile cid=2 cpw= name=\/Pic1.PNG|name=\/Pic2.PNG

FTCREATEDIR

Creates new directory in a channels file repository. i_ft_directory_create_power i_ft_needed_file_directory_create_power ftcreatedir cid={channelID} cpw={channelPassword} dirname={dirPath} ftcreatedir cid=2 cpw= dirname=\/My\sDirectory

FTRENAMEFILE

Renames a file in a channels file repository. If the two parameters tcid and tcpw are specified, the file will be moved into another channels file repository. Permissions: i_ft_file_rename_power i_ft_needed_file_rename_power ftrenamefile cid={channelID} cpw={channelPassword} [tcid={targetChannelID}] [tcpw={targetChannelPassword}] oldname={oldFilePath} newname={newFilePath} ftrenamefile cid=2 cpw= tcid=3 tcpw=secret oldname=\/Pic3.PNG newname=\/Pic3.PNG

CUSTOMSEARCH

Searches for custom client properties specified by ident and value. The value parameter can include regular characters and SQL wildcard characters (e.g. %). customsearch ident={ident} pattern={pattern} customsearch ident=forum_account pattern=%ScP% cldbid=2 ident=forum_account value=ScP ~ 39 ~,

CUSTOMINFO Displays a list of custom properties for the client specified with cldbid.

custominfo cldbid={clientDBID}

Example:

custominfo cldbid=3 cldbid=3 ident=forum_account value=ScP|ident=forum_id value=123 error id=0 msg=ok

WHOAMI Displays information about your current ServerQuery connection including your loginname, etc.

whoami whoami virtualserver_status=online virtualserver_id=1 virtualserver_unique_identifier=zrPkjznB1tMnRwj01xx7RxXjqeY= client_channel_id=2 … ~ 40 ~,

SERVER INSTANCE PROPERTIES

This is a list of properties available for the server instance: NAME CHANGABLE INSTANCE_UPTIME No Uptime in seconds HOST_TIMESTAMP_UTC No Current server date and time as UTC timestamp VIRTUALSERVERS_RUNNING_TOTAL No Number of virtual servers running CONNECTION_FILETRANSFER_BANDWIDTH_SENT No Current bandwidth used for outgoing file transfers (Bytes/s) CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED No Current bandwidth used for incoming file transfers (Bytes/s) CONNECTION_PACKETS_SENT_TOTAL No Total amount of packets sent CONNECTION_PACKETS_RECEIVED_TOTAL No Total amount of packets received CONNECTION_BYTES_SENT_TOTAL No Total amount of bytes sent CONNECTION_BYTES_RECEIVED_TOTAL No Total amount of bytes received CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL No Average bandwidth used for outgoing data in the last second (Bytes/s) CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL No Average bandwidth used for incoming data in the last second (Bytes/s) CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL No Average bandwidth used for outgoing data in the last minute (Bytes/s) CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL No Average bandwidth used for incoming data in the last minute (Bytes/s) SERVERINSTANCE_DATABASE_VERSION No Database revision number SERVERINSTANCE_ GUEST_SERVERQUERY_GROUP Yes Default ServerQuery group ID SERVERINSTANCE_TEMPLATE_SERVERADMIN_GROUP Yes Default template group ID for administrators on new virtual servers (used to create initial token) SERVERINSTANCE_FILETRANSFER_PORT Yes TCP port used for file transfers SERVERINSTANCE_MAX_DOWNLOAD_TOTAL_BANDWITDH Yes Max bandwidth available for outgoing file transfers (Bytes/s) SERVERINSTANCE_MAX_UPLOAD_TOTAL_BANDWITDH Yes Max bandwidth available for incoming file transfers (Bytes/s) SERVERINSTANCE_TEMPLATE_SERVERDEFAULT_GROUP Yes Default server group ID used in templates SERVERINSTANCE_TEMPLATE_CHANNELDEFAULT_GROUP Yes Default channel group ID used in templates SERVERINSTANCE_TEMPLATE_CHANNELADMIN_GROUP Yes Default channel administrator group ID used in templates VIRTUALSERVERS_TOTAL_MAXCLIENTS No Max number of clients for all virtual servers VIRTUALSERVERS_TOTAL_CLIENTS_ONLINE No Number of clients online on all virtual servers VIRTUALSERVERS_TOTAL_CHANNELS_ONLINE No Number of channels on all virtual servers SERVERINSTANCE_SERVERQUERY_FLOOD_COMMANDS Yes Max number of commands allowed in seconds SERVERINSTANCE_SERVERQUERY_FLOOD_TIME Yes Timeframe in seconds for commands SERVERINSTANCE_SERVERQUERY_FLOOD_BAN_TIME Yes Time in seconds used for automatic bans triggered by the ServerQuery flood protection ~ 41 ~,

VIRTUAL SERVER PROPERTIES

This is a list of properties available for virtual servers: NAME CHANGABLE VIRTUALSERVER_NAME Yes Name of the virtual server VIRTUALSERVER_WELCOMEMESSAGE Yes Welcome message of the virtual server VIRTUALSERVER_MAXCLIENTS Yes Number of slots available on the virtual server VIRTUALSERVER_PASSWORD Yes Password of the virtual server VIRTUALSERVER_FLAG_PASSWORD No Indicates whether the server has a password set or not VIRTUALSERVER_CLIENTSONLINE No Number of clients connected to the virtual server VIRTUALSERVER_QUERYCLIENTSONLINE No Number of ServerQuery clients connected to the virtual server VIRTUALSERVER_CHANNELSONLINE No Number of channels created on the virtual server VIRTUALSERVER_CREATED No Creation date and time of the virtual server as UTC timestamp VIRTUALSERVER_UPTIME No Uptime in seconds VIRTUALSERVER_HOSTMESSAGE Yes Host message of the virtual server VIRTUALSERVER_HOSTMESSAGE_MODE Yes Host message mode of the virtual server (see Definitions) VIRTUALSERVER_DEFAULT_SERVER_GROUP Yes Default server group ID VIRTUALSERVER_DEFAULT_CHANNEL_GROUP Yes Default channel group ID VIRTUALSERVER_DEFAULT_CHANNEL_ADMIN_GROUP Yes Default channel administrator group ID VIRTUALSERVER_PLATFORM No Operating system the server is running on VIRTUALSERVER_VERSION No Server version information including build number VIRTUALSERVER_MAX_DOWNLOAD_TOTAL_BANDWIDTH Yes Max bandwidth for outgoing file transfers on the virtual server (Bytes/s) VIRTUALSERVER_MAX_UPLOAD_TOTAL_BANDWIDTH Yes Max bandwidth for incoming file transfers on the virtual server (Bytes/s) VIRTUALSERVER_HOSTBANNER_URL Yes Host banner URL opened on click VIRTUALSERVER_HOSTBANNER_GFX_URL Yes Host banner URL used as image source VIRTUALSERVER_HOSTBANNER_GFX_INTERVAL Yes Interval for reloading the banner on client‐side VIRTUALSERVER_COMPLAIN_AUTOBAN_COUNT Yes Number of complaints needed to ban a client automatically VIRTUALSERVER_COMPLAIN_AUTOBAN_TIME Yes Time in seconds used for automatic bans triggered by complaints VIRTUALSERVER_COMPLAIN_REMOVE_TIME Yes Time in seconds before a complaint is deleted automatically VIRTUALSERVER_MIN_CLIENTS_IN_CHANNEL_BEFORE_FORCED_SILENCE Yes Number of clients in the same channel needed to force silence VIRTUALSERVER_PRIORITY_SPEAKER_DIMM_MODIFICATOR Yes Client volume lowered automatically while a priority speaker is talking VIRTUALSERVER_ANTIFLOOD_POINTS_TICK_REDUCE Yes Anti‐flood points removed from a client for being good ~ 42 ~,

NAME CHANGABLE VIRTUALSERVER_ANTIFLOOD_POINTS_NEEDED_COMMAND_BLOCK Yes

Anti‐flood points needed to block commands being executed by the client

VIRTUALSERVER_ANTIFLOOD_POINTS_NEEDED_IP_BLOCK Yes

Anti‐flood points needed to block incoming connections from the client

VIRTUALSERVER_HOSTBANNER_MODE Yes

The display mode for the virtual servers hostbanner (see Definitions)

VIRTUALSERVER_ASK_FOR_PRIVILEGEKEY No

Indicates whether the initial privilege key for the virtual server has been used or not

VIRTUALSERVER_CLIENT_CONNECTIONS No

Total number of clients connected to the virtual server since it was last started

VIRTUALSERVER_QUERY_CLIENT_CONNECTIONS No

Total number of ServerQuery clients connected to the virtual server since it was last started

VIRTUALSERVER_HOSTBUTTON_TOOLTIP Yes

Text used for the tooltip of the host button on client‐side

VIRTUALSERVER_HOSTBUTTON_GFX_URL Yes

Text used for the tooltip of the host button on client‐side

VIRTUALSERVER_HOSTBUTTON_URL Yes

URL opened on click on the host button

VIRTUALSERVER_DOWNLOAD_QUOTA Yes

Download quota for the virtual server (MByte)

VIRTUALSERVER_UPLOAD_QUOTA Yes

Download quota for the virtual server (MByte)

VIRTUALSERVER_MONTH_BYTES_DOWNLOADED No

Number of bytes downloaded from the virtual server on the current month

VIRTUALSERVER_MONTH_BYTES_UPLOADED No

Number of bytes uploaded to the virtual server on the current month

VIRTUALSERVER_TOTAL_BYTES_DOWNLOADED No

Number of bytes downloaded from the virtual server since it was last started

VIRTUALSERVER_ TOTAL_BYTES_UPLOADED No

Number of bytes uploaded to the virtual server since it was last started

VIRTUALSERVER_UNIQUE_IDENTIFER No

Unique ID of the virtual server

VIRTUALSERVER_ID No

Database ID of the virtual server

VIRTUALSERVER_MACHINE_ID Yes

Machine ID identifying the server instance associated with the virtual server in the database

VIRTUALSERVER_PORT Yes

UDP port the virtual server is listening on

VIRTUALSERVER_AUTOSTART Yes

Indicates whether the server starts automatically with the server instance or not

CONNECTION_FILETRANSFER_BANDWIDTH_SENT No

Current bandwidth used for outgoing file transfers (Bytes/s)

CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED No

Current bandwidth used for incoming file transfers (Bytes/s)

CONNECTION_PACKETS_SENT_TOTAL No

Total amount of packets sent

CONNECTION_PACKETS_RECEIVED_TOTAL No

Total amount of packets received

CONNECTION_BYTES_SENT_TOTAL No

Total amount of bytes sent

CONNECTION_BYTES_RECEIVED_TOTAL No

Total amount of bytes received

CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL No

Average bandwidth used for outgoing data in the last second (Bytes/s)

CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL No

Average bandwidth used for incoming data in the last second (Bytes/s)

CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL No

Average bandwidth used for outgoing data in the last minute (Bytes/s)

CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL No

Average bandwidth used for incoming data in the last minute (Bytes/s) ~ 43 ~,

NAME CHANGABLE VIRTUALSERVER_STATUS Yes

Status of the virtual server (online | virtual online | offline | booting up | shutting down | …)

VIRTUALSERVER_ LOG_CLIENT Yes

Indicates whether the server logs events related to clients or not

VIRTUALSERVER_ LOG_QUERY Yes

Indicates whether the server logs events related to ServerQuery clients or not

VIRTUALSERVER_ LOG_CHANNEL Yes

Indicates whether the server logs events related to channels or not

VIRTUALSERVER_ LOG_PERMISSIONS Yes

Indicates whether the server logs events related to permissions or not

VIRTUALSERVER_ LOG_SERVER Yes

Indicates whether the server logs events related to server changes or not

VIRTUALSERVER_ LOG_FILETRANSFER Yes

Indicates whether the server logs events related to file transfers or not

VIRTUALSERVER_MIN_CLIENT_VERSION Yes

Min client version required to connect

VIRTUALSERVER_NEEDED_IDENTITY_SECURITY_LEVEL Yes

Minimum client identity security level required to connect to the virtual server

VIRTUALSERVER_NAME_PHONETIC Yes

Phonetic name of the virtual server

VIRTUALSERVER_ICON_ID Yes

CRC32 checksum of the virtual server icon

VIRTUALSERVER_RESERVED_SLOTS Yes

Number of reserved slots available on the virtual server

VIRTUALSERVER_TOTAL_PACKETLOSS_SPEECH No

The average packet loss for speech data on the virtual server

VIRTUALSERVER_TOTAL_PACKETLOSS_KEEPALIVE No

The average packet loss for keepalive data on the virtual server

VIRTUALSERVER_TOTAL_PACKETLOSS_CONTROL No

The average packet loss for control data on the virtual server

VIRTUALSERVER_TOTAL_PACKETLOSS_TOTAL No

The average packet loss for all data on the virtual server

VIRTUALSERVER_TOTAL_PING No

The average ping of all clients connected to the virtual server

VIRTUALSERVER_IP No

The IPv4 address the virtual server is listening on

VIRTUALSERVER_WEBLIST_ENABLED Yes

Indicates whether the server appears in the global web server list or not

VIRTUALSERVER_CODEC_ENCRYPTION_MODE Yes

The global codec encryption mode of the virtual server

VIRTUALSERVER_FILEBASE No

The directory where the virtual servers filebase is located ~ 44 ~,

CHANNEL PROPERTIES This is a list of properties available for channels: NAME CHANGABLE CHANNEL_NAME Yes

Name of the channel

CHANNEL_TOPIC Yes

Topic of the channel

CHANNEL_DESCRIPTION Yes

Description of the channel

CHANNEL_PASSWORD Yes

Password of the channel

CHANNEL_FLAG_PASSWORD No

Indicates whether the channel has a password set or not

CHANNEL CODEC Yes

Codec used by the channel (see Definitions)

CHANNEL_CODEC_QUALITY Yes

Codec quality used by the channel

CHANNEL_MAXCLIENTS Yes

Individual max number of clients for the channel

CHANNEL_MAXFAMILYCLIENTS Yes

Individual max number of clients for the channel family

CHANNEL_ORDER Yes

ID of the channel below which the channel is positioned

CHANNEL_FLAG_PERMANENT Yes

Indicates whether the channel is permanent or not

CHANNEL_FLAG_SEMI_PERMANENT Yes

Indicates whether the channel is semi‐permanent or not

CHANNEL_FLAG_TEMPORARY Yes

Indicates whether the channel is temporary or not

CHANNEL_FLAG_DEFAULT Yes

Indicates whether the channel is the virtual servers default channel or not

CHANNEL_FLAG_MAXCLIENTS_UNLIMITED Yes

Indicates whether the channel has a max clients limit or not

CHANNEL_FLAG_MAXFAMILYCLIENTS_UNLIMITED Yes

Indicates whether the channel has a max family clients limit or not

CHANNEL_FLAG_MAXFAMILYCLIENTS_INHERITED Yes

Indicates whether the channel inherits the max family clients from his parent channel or not

CHANNEL_NEEDED_TALK_POWER Yes

Needed talk power for this channel

CHANNEL_NAME_PHONETIC Yes

Phonetic name of the channel

CHANNEL_FILEPATH No

Path of the channels file repository

CHANNEL_FORCED_SILENCE No

Indicates whether the channel is silenced or not

CHANNEL_ICON_ID Yes

CRC32 checksum of the channel icon

CHANNEL_CODEC_IS_UNENCRYPTED Yes

Indicates whether speech data transmitted in this channel is encrypted or not

CPID Yes

The channels parent ID

CID No

The channels ID ~ 45 ~,

CLIENT PROPERTIES This is a list of properties available for clients: NAME CHANGABLE CLIENT_UNIQUE_IDENTIFIER No

Unique ID of the client

CLIENT_NICKNAME Yes

Nickname of the client

CLIENT_VERSION No

Client version information including build number

CLIENT_PLATFORM No

Operating system the client is running on

CLIENT_INPUT_MUTED No

Indicates whether the client has their microphone muted or not

CLIENT_OUTPUT_MUTED No

Indicates whether the client has their speakers muted or not

CLIENT_INPUT_HARDWARE No

Indicates whether the client has enabled their capture device or not

CLIENT_OUTPUT_HARDWARE No

Indicates whether the client has enabled their playback device or not

CLIENT_DEFAULT_CHANNEL No

Default channel of the client

CLIENT_LOGIN_NAME No

Username of a ServerQuery client

CLIENT_DATABASE_ID No

Database ID of the client

CLIENT_CHANNEL_GROUP_ID No

Current channel group ID of the client

CLIENT_SERVER_GROUPS No

Current server group IDs of the client separated by a comma

CLIENT_CREATED No

Creation date and time of the clients first connection to the server as UTC timestamp

CLIENT_LASTCONNECTED No

Creation date and time of the clients last connection to the server as UTC timestamp

CLIENT_TOTALCONNECTIONS No

Total number of connections from this client since the server was started

CLIENT_AWAY No

Indicates whether the client is away or not

CLIENT_AWAY_MESSAGE No

Away message of the client

CLIENT_TYPE No

Indicates whether the client is a ServerQuery client or not

CLIENT_FLAG_AVATAR No

Indicates whether the client has set an avatar or not

CLIENT_TALK_POWER No

The clients current talk power

CLIENT_TALK_REQUEST No

Indicates whether the client is requesting talk power or not

CLIENT_TALK_REQUEST_MSG No

The clients current talk power request message

CLIENT_IS_TALKER Yes

Indicates whether the client is able to talk or not

CLIENT_MONTH_BYTES_DOWNLOADED No

Number of bytes downloaded by the client on the current month

CLIENT_MONTH_BYTES_UPLOADED No

Number of bytes uploaded by the client on the current month

CLIENT_TOTAL_BYTES_DOWNLOADED No

Number of bytes downloaded by the client since the server was started

CLIENT_TOTAL_BYTES_UPLOADED No

Number of bytes uploaded by the client since the server was started ~ 46 ~,

NAME CHANGABLE CLIENT_IS_PRIORITY_SPEAKER No

Indicates whether the client is a priority speaker or not

CLIENT_UNREAD_MESSAGES No

Number of unread offline messages in this clients inbox

CLIENT_NICKNAME_PHONETIC No

Phonetic name of the client

CLIENT_DESCRIPTION Yes

Brief description of the client

CLIENT_NEEDED_SERVERQUERY_VIEW_POWER No

The clients current ServerQuery view power

CONNECTION_FILETRANSFER_BANDWIDTH_SENT No

Current bandwidth used for outgoing file transfers (Bytes/s)

CONNECTION_FILETRANSFER_BANDWIDTH_RECEIVED No

Current bandwidth used for incoming file transfers (Bytes/s)

CONNECTION_PACKETS_SENT_TOTAL No

Total amount of packets sent

CONNECTION_PACKETS_RECEIVED_TOTAL No

Total amount of packets received

CONNECTION_BYTES_SENT_TOTAL No

Total amount of bytes sent

CONNECTION_BYTES_RECEIVED_TOTAL No

Total amount of bytes received

CONNECTION_BANDWIDTH_SENT_LAST_SECOND_TOTAL No

Average bandwidth used for outgoing data in the last second (Bytes/s)

CONNECTION_BANDWIDTH_RECEIVED_LAST_SECOND_TOTAL No

Average bandwidth used for incoming data in the last second (Bytes/s)

CONNECTION_BANDWIDTH_SENT_LAST_MINUTE_TOTAL No

Average bandwidth used for outgoing data in the last minute (Bytes/s)

CONNECTION_BANDWIDTH_RECEIVED_LAST_MINUTE_TOTAL No

Average bandwidth used for incoming data in the last minute (Bytes/s)

CONNECTION_CLIENT_IP No

The IPv4 address of the client

CLIENT_IS_CHANNEL_COMMANDER Yes

Indicates whether the client is a channel commander or not

CLIENT_ICON_ID Yes

CRC32 checksum of the client icon

CLIENT_COUNTRY No

The country identifier of the client (i.e. DE) ~ 47 ~,

DEFINITIONS The following enumerations can be used to change the behavior of various ServerQuery commands:

enum HostMessageMode { HostMessageMode_LOG = 1, // 1: display message in chatlog HostMessageMode_MODAL, // 2: display message in modal dialog HostMessageMode_MODALQUIT // 3: display message in modal dialog and close connection }; enum HostBannerMode { HostMessageMode_NOADJUST = 0, // 0: do not adjust HostMessageMode_IGNOREASPECT, // 1: adjust but ignore aspect ratio (like TeamSpeak 2) HostMessageMode_KEEPASPECT // 2: adjust and keep aspect ratio }; enum Codec { CODEC_SPEEX_NARROWBAND = 0, // 0: speex narrowband (mono, 16bit, 8kHz) CODEC_SPEEX_WIDEBAND, // 1: speex wideband (mono, 16bit, 16kHz) CODEC_SPEEX_ULTRAWIDEBAND, // 2: speex ultra-wideband (mono, 16bit, 32kHz) CODEC_CELT_MONO // 3: celt mono (mono, 16bit, 48kHz) }; enum CodecEncryptionMode { CODEC_CRYPT_INDIVIDUAL = 0, // 0: configure per channel CODEC_CRYPT_DISABLED, // 1: globally disabled CODEC_CRYPT_ENABLED // 2: globally enabled }; enum TextMessageTargetMode { TextMessageTarget_CLIENT = 1, // 1: target is a client TextMessageTarget_CHANNEL, // 2: target is a channel TextMessageTarget_SERVER // 3: target is a virtual server }; enum LogLevel { LogLevel_ERROR = 1, // 1: everything that is really bad LogLevel_WARNING, // 2: everything that might be bad LogLevel_DEBUG, // 3: output that might help find a problem LogLevel_INFO // 4: informational output }; enum ReasonIdentifier { REASON_KICK_CHANNEL = 4, // 4: kick client from channel REASON_KICK_SERVER // 5: kick client from server }; enum PermissionGroupDatabaseTypes { PermGroupDBTypeTemplate = 0, // 0: template group (used for new virtual servers) PermGroupDBTypeRegular, // 1: regular group (used for regular clients) PermGroupDBTypeQuery // 2: global query group (used for ServerQuery clients) }; enum PermissionGroupTypes { PermGroupTypeServerGroup = 0, // 0: server group permission PermGroupTypeGlobalClient, // 1: client specific permission PermGroupTypeChannel, // 2: channel specific permission PermGroupTypeChannelGroup, // 3: channel group permission PermGroupTypeChannelClient // 4: channel-client specific permission }; enum TokenType { TokenServerGroup = 0, // 0: server group token (id1={groupID} id2=0) TokenChannelGroup // 1: channel group token (id1={groupID} id2={channelID}) }; ~ 48 ~]

15