help

Provides information about ServerQuery commands. Used without parameters, help lists and briefly describes every command.

Permissions:

b_serverinstance_help_view

Syntax:

help [{command}]

Example:

help serverinfo

Usage: serverinfo Displays detailed configuration information about a virtual server including ID, number of clients online, configuration, etc. error id=0 msg=ok

quit

Closes the ServerQuery connection to the TeamSpeak 3 Server instance.

Syntax:

quit

Example:

quit

login

Authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials.

Permissions:

b_serverquery_login

Syntax:

login client_login_name={username} client_login_password={password} login {username} {password}

Example:

login client_login_name=xyz client_login_password=xyz

error id=0 msg=ok

logout

Deselects the active virtual server and logs out from the server instance.

Permissions:

b_serverquery_login

Syntax:

logout

Example:

logout

error id=0 msg=ok

version

Displays the servers version information including platform and build number.

Permissions:

b_serverinstance_version_view

Syntax:

version

Example:

version

version=3.0.0-alpha4 build=9155 platform=Linux error id=0 msg=ok

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.

Permissions:

b_serverinstance_info_view

Syntax:

hostinfo

Example:

hostinfo

instance_uptime=1903203 host_timestamp_utc=1259337246 virtualservers_running_total=1 connection_filetransfer_bandwidth_sent=0 … error id=0 msg=ok

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

Syntax:

instanceinfo

Example:

instanceinfo

serverinstance_database_version=11 serverinstance_filetransfer_port=30033 serverinstance_template_guest_serverquery_group=1 serverinstance_template_serveradmin_group=3 … error id=0 msg=ok

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

error id=0 msg=ok

bindinglist

Displays a list of IP addresses used by the server instance on multi-homed machines. If no subsystem is specified, "voice" is used by default.

Permissions:

b_serverinstance_binding_list

Syntax:

bindinglist [subsystem={voice|query|filetransfer}]

Example:

bindinglist

ip=0.0.0.0|ip=0::0 error id=0 msg=ok

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.

Permissions:

b_virtualserver_select

Syntax:

use [sid={serverID}] [port={serverPort}] [-virtual] use {serverID} [-virtual]

Example:

use sid=1

error id=0 msg=ok

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, booting up, shutting down or virtual online. While most of them are self-explanatory, virtual online is a bit more complicated. Whenever you select a virtual server which is currently stopped with the -virtual parameter, 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.

Permissions:

b_serverinstance_virtualserver_list

Syntax:

serverlist [-uid] [-short] [-all] [-onlyoffline]

Example:

serverlist

virtualserver_id=1 virtualserver_port=9987 virtualserver_status=online virtualserver_clientsonline=6 … error id=0 msg=ok

serveridgetbyport

Displays the database ID of the virtual server running on the UDP port specified by virtualserver_port.

Permissions:

b_serverinstance_virtualserver_list

Syntax:

serveridgetbyport virtualserver_port={serverPort}

Example:

serveridgetbyport virtualserver_port=9987

server_id=1 error id=0 msg=ok

serverdelete

Deletes the virtual server specified with sid. Please note that only virtual servers in stopped state can be deleted.

Permissions:

b_virtualserver_delete

Syntax:

serverdelete sid={serverID}

Example:

serverdelete sid=1

error id=0 msg=ok

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

Syntax:

servercreate virtualserver_name={serverName} [virtualserver_properties…]

Example:

servercreate virtualserver_name=TeamSpeak\s]\p[\sServer virtualserver_port=9988 virtualserver_maxclients=32

sid=2 virtualserver_port=9988 token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW error id=0 msg=ok

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.

Permissions:

b_virtualserver_start_any
b_virtualserver_start

Syntax:

serverstart sid={serverID}

Example:

serverstart sid=1

error id=0 msg=ok

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.

Permissions:

b_virtualserver_stop_any
b_virtualserver_stop

Syntax:

serverstop sid={serverID}

Example:

serverstop sid=1

error id=0 msg=ok

serverprocessstop

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

Permissions:

b_serverinstance_stop

Syntax:

serverprocessstop

Example:

serverprocessstop

error id=0 msg=ok

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

Syntax:

serverinfo

Example:

serverinfo

virtualserver_port=9987 virtualserver_unique_identifier=zrPkjznB1tMnRwj01xx7RxXjqeY= virtualserver_name=TeamSpeak\s]I[\sServer … error id=0 msg=ok

serverrequestconnectioninfo

Displays detailed connection information about the selected virtual server including uptime, traffic information, etc.

Permissions:

b_virtualserver_connectioninfo_view

Syntax:

serverrequestconnectioninfo

Example:

serverrequestconnectioninfo

connection_filetransfer_bandwidth_sent=0 connection_filetransfer_bandwidth_received=0 connection_packets_sent_total=241454 … error id=0 msg=ok

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.

Permissions:

b_virtualserver_modify_password

Syntax:

servertemppasswordadd pw={password} desc={description} duration={seconds} tcid={channelID} tcpw={channelPW}

Example:

servertemppasswordadd pw=secret desc=none duration=3600 tcid=117535 tcpw=secret

error id=0 msg=ok

servertemppassworddel

Deletes the temporary server password specified with pw.

Permissions:

b_virtualserver_modify_password

Syntax:

servertemppassworddel pw={password}

Example:

servertemppassworddel pw=secret

error id=0 msg=ok

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

Syntax:

servertemppasswordlist

Example:

servertemppasswordlist

nickname=serveradmin uid=serveradmin desc=none pw_clear=secret start=1331496494 end=1331500094 tcid=117535 error id=0 msg=ok

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.

Permissions:

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

Syntax:

serveredit [virtualserver_properties…]

Example:

serveredit virtualserver_name=TeamSpeak\s]\p[\sServer virtualserver_maxclients=32

error id=0 msg=ok

servergrouplist

Displays a list of server groups available. Depending on your permissions, the output may also contain global ServerQuery groups and template groups.

Permissions:

b_serverinstance_modify_querygroup
b_serverinstance_modify_templates
b_virtualserver_servergroup_list

Syntax:

servergrouplist

Example:

servergrouplist

sgid=9 name=Server\sAdmin type=1 iconid=300 savedb=1|sgid=10 name=Normal type=1 iconid=0 savedb=1|sgid=11 … error id=0 msg=ok

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.

Permissions:

b_virtualserver_servergroup_create

Syntax:

servergroupadd name={groupName} [type={groupDbType}]

Example:

servergroupadd name=Server\sAdmin

sgid=13 error id=0 msg=ok

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.

Permissions:

b_virtualserver_servergroup_delete

Syntax:

servergroupdel sgid={groupID} force={1|0}

Example:

servergroupdel sgid=13

error id=0 msg=ok

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.

Permissions:

b_virtualserver_servergroup_create
i_group_modify_power
i_group_needed_modify_power

Syntax:

servergroupcopy ssgid={sourceGroupID} tsgid={targetGroupID} name={groupName} type={groupDbType}

Example:

servergroupcopy ssgid=6 tsgid=0 name=My\sGroup\s(Copy) type=1

sgid=21 error id=0 msg=ok

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

error id=0 msg=ok

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.

Permissions:

b_virtualserver_servergroup_permission_list

Syntax:

servergrouppermlist sgid={groupID} [-permsid]

Example:

servergrouppermlist sgid=13

permid=8470 permvalue=1 permnegated=0 permskip=0|permid=8475 permvalue=1 … error id=0 msg=ok

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.

Permissions:

i_group_modify_power
i_group_needed_modify_power
i_permission_modify_power

Syntax:

servergroupaddperm sgid={groupID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}… permnegated={1|0}… permskip={1|0}…

Example:

servergroupaddperm sgid=13 permid=17276 permvalue=50 permnegated=0 permskip=0|permid=21415 permvalue=20 permnegated=0

error id=0 msg=ok

servergroupaddperm sgid=3 permsid=b_virtualserver_modify_maxclients permvalue=1 permnegated=0 permskip=0

error id=0 msg=ok

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.

Permissions:

i_group_modify_power
i_group_needed_modify_power
i_permission_modify_power

Syntax:

servergroupdelperm sgid={groupID} [permid={permID}…] [permsid={permName}…]

Example:

servergroupdelperm sgid=16 permid=17276|permid=21415

error id=0 msg=ok

servergroupdelperm sgid=3 permsid=b_virtualserver_modify_maxclients

error id=0 msg=ok

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.

Permissions:

i_group_member_add_power
i_group_needed_member_add_power

Syntax:

servergroupaddclient sgid={groupID} cldbid={clientDBID}

Example:

servergroupaddclient sgid=16 cldbid=3

error id=0 msg=ok

servergroupdelclient

Removes a client specified with cldbid from the server group specified with sgid.

Permissions:

i_group_member_remove_power
i_group_needed_member_remove_power

Syntax:

servergroupdelclient sgid={groupID} cldbid={clientDBID}

Example:

servergroupdelclient sgid=16 cldbid=3

error id=0 msg=ok

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

Syntax:

servergroupclientlist sgid={groupID} [-names]

Example:

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=40|cldbid=47|cldbid=53 error id=0 msg=ok

servergroupsbyclientid

Displays all server groups the client specified with cldbid is currently residing in.

Syntax:

servergroupsbyclientid cldbid={clientDBID}

Example:

servergroupsbyclientid cldbid=18

name=Server\sAdmin sgid=6 cldbid=18 error id=0 msg=ok

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

Permissions:

b_permission_modify_power_ignore

Syntax:

servergroupautoaddperm sgtype={groupID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}… permnegated={1|0}… permskip={1|0}…

Example:

servergroupautoaddperm sgtype=45 permsid=b_virtualserver_start permvalue=1 permskip=0 permnegated=0

error id=0 msg=ok

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

Permissions:

b_permission_modify_power_ignore

Syntax:

servergroupautodelperm sgtype={groupID} [permid={permID}…] [permsid={permName}…]

Example:

servergroupautodelperm sgtype=45 permsid=b_virtualserver_start

error id=0 msg=ok

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.

Permissions:

b_virtualserver_snapshot_create

Syntax:

serversnapshotcreate

Example:

serversnapshotcreate

hash=bnTd2E1kNITHjJYRCFjgbKKO5P8=|virtualserver_unique_identifier=zrPkjznB1tMnRwj01xx7RxXjqeY= virtualserver_name=TeamSpeak\s]I[\sServer … error id=0 msg=ok

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.

Permissions:

b_virtualserver_snapshot_deploy

Syntax:

serversnapshotdeploy [-mapping] virtualserver_snapshot

Example:

serversnapshotdeploy hash=bnTd2E1kNITHjJYRCFjgbKKO5P8=|virtualserver_unique_identifier=zrPkjznB1tMnRwj01xx7RxXjq= …

error id=0 msg=ok

serversnapshotdeploy -mapping hash=bnTd2E1kNITHjJYRCFjgbKKO5P8=|virtualserver_…

ocid=36 ncid=40|ocid=37 ncid=41|ocid=38 ncid=42|ocid=39 ncid=43 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.

Permissions:

b_virtualserver_notify_register

Syntax:

servernotifyregister event={server|channel|textserver|textchannel|textprivate} [id={channelID}]

Example:

servernotifyregister event=server

error id=0 msg=ok

servernotifyregister event=channel id=123

error id=0 msg=ok

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

error id=0 msg=ok

sendtextmessage

Sends a text message to a specified target. If targetmode is set to 1, a message is sent to the client with the ID specified by target. If targetmode is set to 2 or 3, the target parameter will be ignored and a message is sent to the current channel or server respectively.

Permissions:

i_client_private_textmessage_power
i_client_needed_private_textmessage_power
b_client_server_textmessage_send
b_client_channel_textmessage_send

Syntax:

sendtextmessage targetmode={1-3} target={clientID} msg={text}

Example:

sendtextmessage targetmode=2 target=1 msg=Hello\sWorld!

error id=0 msg=ok

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.

Permissions:

b_serverinstance_log_view
b_virtualserver_log_view

Syntax:

logview [lines={1-100}] [reverse={1|0}] [instance={1|0}] [begin_pos={n}]

Example:

logview lines=30

last_pos=403788 file_size=411980 l=\p\slistening\son\s0.0.0.0:9987 … error id=0 msg=ok

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.

Permissions:

b_serverinstance_log_add
b_virtualserver_log_add

Syntax:

logadd loglevel={1-4} logmsg={text}

Example:

logadd loglevel=4 logmsg=Informational\smessage!

error id=0 msg=ok

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!

error id=0 msg=ok

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.

Permissions:

b_virtualserver_channel_list

Syntax:

channellist [-topic] [-flags] [-voice] [-limits] [-icon] [-secondsempty]

Example:

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 … error id=0 msg=ok

channelinfo

Displays detailed configuration information about a channel including ID, topic, description, etc. For detailed information, see Channel Properties.

Permissions:

b_channel_info_view

Syntax:

channelinfo cid={channelID}

Example:

channelinfo cid=1

channel_name=Default\sChannel channel_topic=Default\sChannel\shas\sno\s[b]topic[\/b] channel_description=This\sis\sthe\sdefault\schannel … error id=0 msg=ok

channelfind

Displays a list of channels matching a given name pattern.

Permissions:

b_virtualserver_channel_search

Syntax:

channelfind pattern={channelName}

Example:

channelfind pattern=default

cid=15 channel_name=Default\sChannel error id=0 msg=ok

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.

Permissions:

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

error id=0 msg=ok

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.

Permissions:

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
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

Syntax:

channelcreate channel_name={channelName} [channel_properties…]

Example:

channelcreate channel_name=My\sChannel channel_topic=My\sTopic

cid=16 error id=0 msg=ok

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.

Permissions:

b_channel_delete_permanent
b_channel_delete_semi_permanent
b_channel_delete_temporary
b_channel_delete_flag_force

Syntax:

channeldelete cid={channelID} force={1|0}

Example:

channeldelete cid=16 force=1

error id=0 msg=ok

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.

Permissions:

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_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

Syntax:

channeledit cid={channelID} [channel_properties…]

Example:

channeledit cid=15 channel_codec_quality=3 channel_description=My\sDescription

error id=0 msg=ok

channelgrouplist

Displays a list of channel groups available on the selected virtual server.

Permissions:

b_virtualserver_channelgroup_list
b_serverinstance_modify_templates

Syntax:

channelgrouplist

Example:

channelgrouplist

cgid=1 name=Channel\sAdmin type=2 iconid=100 savedb=1|cgid=2 … error id=0 msg=ok

channelgroupadd

Creates a new channel group using a given name and displays its ID. The optional type parameter can be used to create template groups. For detailed information, see Definitions.

Permissions:

b_virtualserver_channelgroup_create

Syntax:

channelgroupadd name={groupName} [type={groupDbType}]

Example:

channelgroupadd name=Channel\sAdmin

cgid=13 error id=0 msg=ok

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.

Permissions:

b_virtualserver_channelgroup_delete

Syntax:

channelgroupdel cgid={groupID} force={1|0}

Example:

channelgroupdel cgid=13

error id=0 msg=ok

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 template groups. For detailed information, see Definitions.

Permissions:

b_virtualserver_channelgroup_create
i_group_modify_power
i_group_needed_modify_power

Syntax:

channelgroupcopy scgid={sourceGroupID} tsgid={targetGroupID} name={groupName} type={groupDbType}

Example:

channelgroupcopy scgid=4 tcgid=0 name=My\sGroup\s(Copy) type=1

cgid=33 error id=0 msg=ok

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

error id=0 msg=ok

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.

Permissions:

i_group_modify_power
i_group_needed_modify_power
i_permission_modify_power

Syntax:

channelgroupaddperm cgid={groupID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}…

Example:

channelgroupaddperm cgid=13 permid=17276 permvalue=50|permid=21415 permvalue=20

error id=0 msg=ok

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.

Permissions:

b_virtualserver_channelgroup_permission_list

Syntax:

channelgrouppermlist cgid={groupID} [-permsid]

Example:

channelgrouppermlist cgid=13

permid=8470 permvalue=1 permnegated=0 permskip=0|permid=8475 permvalue=1 … error id=0 msg=ok

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

Syntax:

channelgroupdelperm cgid={groupID} [permid={permID}…] [permsid={permName}…]

Example:

channelgroupdelperm cgid=16 permid=17276|permid=21415

error id=0 msg=ok

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.

Permissions:

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 error id=0 msg=ok

setclientchannelgroup

Sets the channel group of a client to the ID specified with cgid.

Permissions:

i_group_member_add_power
i_group_needed_member_add_power
i_group_member_remove_power
i_group_needed_member_remove_power

Syntax:

setclientchannelgroup cgid={groupID} cid={channelID} cldbid={clientDBID}

Example:

setclientchannelgroup cgid=13 cid=15 cldbid=20

error id=0 msg=ok

tokenadd

Alias for privilegekeyadd.

Syntax:

tokenadd tokentype={1|0} tokenid1={groupID} tokenid2={channelID} [tokendescription={description}] [tokencustomset={customFieldSet}]

Example:

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 error id=0 msg=ok

tokendelete

Alias for privilegekeydelete

Syntax:

tokendelete token={tokenKey}

Example:

tokendelete token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW

error id=0 msg=ok

tokenlist

Alias for privilegekeylist.

Syntax:

tokenlist

Example:

tokenlist

token=88CVUg\/zkujt+y+WfHdko79UcM4R6uyCL6nEfy3B token_type=0 token_id1=9... error id=0 msg=ok

tokenuse

Alias for privilegekeyuse.

Syntax:

tokenuse token={tokenKey}

Example:

tokenuse token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW

error id=0 msg=ok

channelpermlist

Displays a list of permissions defined for a channel.

Permissions:

b_virtualserver_channel_permission_list

Syntax:

channelpermlist cid={channelID} [-permsid]

Example:

channelpermlist cid=2

cid=2 permid=4353 permvalue=1 permnegated=0 permskip=0|permid=17276 permvalue=50 … error id=0 msg=ok

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

Syntax:

channeladdperm cid={channelID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}…

Example:

channeladdperm cid=16 permid=17276 permvalue=50|permid=21415 permvalue=20

error id=0 msg=ok

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.

Permissions:

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

error id=0 msg=ok

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.

Permissions:

b_virtualserver_client_list
i_channel_subscribe_power
i_channel_needed_subscribe_power

Syntax:

clientlist [-uid] [-away] [-voice] [-times] [-groups] [-info] [-country] [-ip] [-badges]

Example:

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 … error id=0 msg=ok

clientinfo

Displays detailed configuration information about a client including unique ID, nickname, client version, etc.

Permissions:

b_client_info_view

Syntax:

clientinfo clid={clientID}

Example:

clientinfo clid=6

client_unique_identifier=P5H2hrN6+gpQI4n\/dXp3p17vtY0= client_nickname=Rabe85 client_version=3.0.0-alpha24\s[Build:\s8785]\s(UI:\s8785) … error id=0 msg=ok

clientfind

Displays a list of clients matching a given name pattern.

Permissions:

b_virtualserver_client_search

Syntax:

clientfind pattern={clientName}

Example:

clientfind pattern=sven

clid=7 client_nickname=Sven error id=0 msg=ok

clientedit

Changes a clients settings using given properties. For detailed information, see Client Properties.

Permissions:

b_client_modify_description
b_client_set_talk_power

Syntax:

clientedit clid={clientID} [client_properties…]

Example:

clientedit clid=10 client_description=Best\sguy\sever!

error id=0 msg=ok

clientdblist

Displays a list of client identities known by the server including their database ID, last nickname, etc.

Permissions:

b_virtualserver_client_dblist

Syntax:

clientdblist [start={offset}] [duration={limit}] [-count]

Example:

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.

Permissions:

b_virtualserver_client_dbinfo

Syntax:

clientdbinfo cldbid={clientDBID}

Example:

clientdbinfo cldbid=4

client_unique_identifier=FPMPSC6MXqXq751dX7BKV0JniSo= client_nickname=ScP client_created=1265411019 … error id=0 msg=ok

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. The pattern parameter can include regular characters and SQL wildcard characters (e.g. %).

Permissions:

b_virtualserver_client_dbsearch

Syntax:

clientdbfind pattern={clientName|clientUID} [-uid]

Example:

clientdbfind pattern=%Sven%

cldbid=56 error id=0 msg=ok

clientdbedit

Changes a clients settings using given properties. For detailed information, see Client Properties.

Permissions:

b_client_modify_dbproperties
b_client_modify_description
b_client_set_talk_power

Syntax:

clientdbedit cldbid={clientDBID} [client_properties…]

Example:

clientdbedit cldbid=56 client_description=Best\sguy\sever!

error id=0 msg=ok

clientdbdelete

Deletes a clients properties from the database.

Permissions:

b_client_delete_dbproperties

Syntax:

clientdbdelete cldbid={clientDBID}

Example:

clientdbdelete cldbid=56

error id=0 msg=ok

clientgetids

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

Syntax:

clientgetids cluid={clientUID}

Example:

clientgetids cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM=

cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= clid=1 name=Janko error id=0 msg=ok

clientgetdbidfromuid

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

Syntax:

clientgetdbidfromuid cluid={clientUID}

Example:

clientgetdbidfromuid cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM=

cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= cldbid=32 error id=0 msg=ok

clientgetnamefromuid

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

Syntax:

clientgetnamefromuid cluid={clientUID}

Example:

clientgetnamefromuid cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM=

cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= cldbid=32 name=Janko error id=0 msg=ok

clientgetuidfromclid

Displays the unique identifier matching the clientID specified by clid.

Syntax:

clientgetuidfromclid clid={clientID}

Example:

clientgetuidfromclid clid=8

clid=8 cluid=yXM6PUfbCcPU+joxIFek1xOQwwQ= nickname=MuhChy1 error id=0 msg=ok

clientgetnamefromdbid

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

Syntax:

clientgetnamefromdbid cldbid={clientDBID}

Example:

clientgetnamefromdbid cldbid=32

cluid=dyjxkshZP6bz0n3bnwFQ1CkwZOM= cldbid=32 name=Janko error id=0 msg=ok

clientsetserverquerylogin

Updates your own ServerQuery login credentials using a specified username. The password will be auto-generated.

Permissions:

b_client_create_modify_serverquery_login

Syntax:

clientsetserverquerylogin client_login_name={username}

Example:

clientsetserverquerylogin client_login_name=admin

client_login_password=+r\/TQqvR error id=0 msg=ok

clientupdate

Change your ServerQuery clients settings using given properties. For detailed information, see Client Properties.

Syntax:

clientupdate [client_properties…]

Example:

clientupdate client_nickname=ScP\s(query)

error id=0 msg=ok

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

Syntax:

clientmove clid={clientID}… cid={channelID} [cpw={channelPassword}]

Example:

clientmove clid=5|clid=6 cid=3

error id=0 msg=ok

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.

Permissions:

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!

error id=0 msg=ok

clientpoke

Sends a poke message to the client specified with clid.

Permissions:

i_client_poke_power
i_client_needed_poke_power

Syntax:

clientpoke clid={clientID} msg={text}

Example:

clientpoke clid=5 msg=Wake\sup!

error id=0 msg=ok

clientpermlist

Displays a list of permissions defined for a client.

Permissions:

b_virtualserver_client_permission_list

Syntax:

clientpermlist cldbid={clientDBID} [-permsid]

Example:

clientpermlist cldbid=2

cldbid=2 permid=4353 permvalue=1 permnegated=0 permskip=0|permid=17276 permvalue=50 permnegated=0 permskip=0|permid=21415 … error id=0 msg=ok

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

Syntax:

clientaddperm cldbid={clientDBID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}… permskip={1|0}…

Example:

clientaddperm cldbid=16 permid=17276 permvalue=50 permskip=1|permid=21415 permvalue=20 permskip=0

error id=0 msg=ok

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.

Permissions:

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

error id=0 msg=ok

channelclientpermlist

Displays a list of permissions defined for a client in a specific channel.

Permissions:

b_virtualserver_channelclient_permission_list

Syntax:

channelclientpermlist cid={channelID} cldbid={clientDBID} [-permsid]

Example:

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 … error id=0 msg=ok

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.

Permissions:

i_group_modify_power
i_group_needed_modify_power
i_permission_modify_power

Syntax:

channelclientaddperm cid={channelID} cldbid={clientDBID} [permid={permID}…] [permsid={permName}…] permvalue={permValue}…

Example:

channelclientaddperm cid=12 cldbid=3 permid=17276 permvalue=50|permid=21415 permvalue=20

error id=0 msg=ok

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

Syntax:

channelclientdelperm cid={channelID} cldbid={clientDBID} [permid={permID}…] [permsid={permName}…]

Example:

channelclientdelperm cid=12 cldbid=3 permid=17276|permid=21415

error id=0 msg=ok

permissionlist

Displays a list of permissions available on the server instance including ID, name and description.

Permissions:

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 … error id=0 msg=ok

permidgetbyname

Displays the database ID of one or more permissions specified by permsid.

Permissions:

b_serverinstance_permission_list

Syntax:

permidgetbyname permsid={permName}…

Example:

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 error id=0 msg=ok

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.

Permissions:

b_client_permissionoverview_view

Syntax:

permoverview cid={channelID} cldbid={clientDBID} [permid={permID}…] [permsid={permName}…]

Example:

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 … error id=0 msg=ok

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

Syntax:

permget permid={permID}|permid={permID} permget permsid={permName}|permsid={permName}

Example:

permget permid=21174

permsid=i_client_move_power permid=21174 permvalue=100 error id=0 msg=ok

permget permsid=i_client_move_power

permsid=i_client_move_power permid=21174 permvalue=100 error id=0 msg=ok

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.

Permissions:

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 error id=0 msg=ok

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.

Permissions:

b_virtualserver_permission_reset

Syntax:

permreset

Example:

permreset

token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW error id=0 msg=ok

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

Syntax:

privilegekeylist

Example:

privilegekeylist

token=88CVUg\/zkujt+y+WfHdko79UcM4R6uyCL6nEfy3B token_type=0 token_id1=9 token_id2=0 … error id=0 msg=ok

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

Permissions:

b_virtualserver_token_add
i_group_needed_member_add_power
i_group_member_add_power

Syntax:

privilegekeyadd tokentype={1|0} tokenid1={groupID} tokenid2={channelID} [tokendescription={description}] [tokencustomset={customFieldSet}]

Example:

privilegekeyadd 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 error id=0 msg=ok

privilegekeydelete

Deletes an existing token matching the token key specified with token.

Permissions:

b_virtualserver_token_delete

Syntax:

privilegekeydelete token={tokenKey}

Example:

privilegekeydelete token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW

error id=0 msg=ok

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.

Permissions:

b_virtualserver_token_use

Syntax:

privilegekeyuse token={tokenKey}

Example:

privilegekeyuse token=eKnFZQ9EK7G7MhtuQB6+N2B1PNZZ6OZL3ycDp2OW

error id=0 msg=ok

messagelist

Displays a list of offline messages you've received. The output contains the senders unique identifier, the messages subject, etc.

Syntax:

messagelist

Example:

messagelist

msgid=4 cluid=xwEzb5ENOaglVHu9oelK++reUyE= subject=Test timestamp=1259439465 flag_read=0 … error id=0 msg=ok

messageadd

Sends an offline message to the client specified by cluid.

Syntax:

messageadd cluid={clientUID} subject={subject} message={text}

Example:

messageadd cluid=oHhi9WzXLNEFQOwAu4JYKGU+C+c= subject=Hi! message=Where\sare\syou?!?

error id=0 msg=ok

messagedel

Deletes an existing offline message with ID msgid from your inbox.

Syntax:

messagedel msgid={messageID}

Example:

messagedel msgid=4

error id=0 msg=ok

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.

Syntax:

messageget msgid={messageID}

Example:

messageget msgid=4

msgid=4 cluid=xwEzb5ENOaglVHu9oelK++reUyE= subject=Hi! message=Where\sare\syou?!? error id=0 msg=ok

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.

Syntax:

messageupdateflag msgid={messageID} flag={1|0}

Example:

messageupdateflag msgid=4 flag=1

error id=0 msg=ok

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

Syntax:

complainlist [tcldbid={targetClientDBID}]

Example:

complainlist tcldbid=3

tcldbid=3 tname=Julian fcldbid=56 fname=Sven message=Bad\sguy! timestamp=1259440948 … error id=0 msg=ok

complainadd

Submits a complaint about a connected client with database ID tcldbid to the server.

Permissions:

i_client_complain_power
i_client_needed_complain_power

Syntax:

complainadd tcldbid={targetClientDBID} message={text}

Example:

complainadd tcldbid=3 message=Bad\sguy!

error id=0 msg=ok

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

error id=0 msg=ok

complaindel

Deletes the complaint about the client with ID tcldbid submitted by the client with ID fcldbid from the server.

Permissions:

b_client_complain_delete
b_client_complain_delete_own

Syntax:

complaindel tcldbid={targetClientDBID} fcldbid={fromClientDBID}

Example:

complaindel tcldbid=3 fcldbid=4

error id=0 msg=ok

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.

Permissions:

i_client_ban_power
i_client_needed_ban_power

Syntax:

banclient clid={clientID} [time={timeInSeconds}] [banreason={text}]

Example:

banclient clid=4 time=3600

banid=2 banid=3 error id=0 msg=ok

banlist

Displays a list of active bans on the selected virtual server.

Permissions:

b_client_ban_list

Syntax:

banlist

Example:

banlist

banid=7 ip=1.2.3.4 created=1259444002242 invokername=Sven invokercldbid=56 invokeruid=oHhi9WzXLNEFQOwAu4JYKGU+C+c= reason enforcements=0 error id=0 msg=ok

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.

Permissions:

b_client_ban_create

Syntax:

banadd [ip={regexp}] [name={regexp}] [uid={clientUID}] [time={timeInSeconds}] [banreason={text}]

Example:

banadd ip=1.2.3.4 banreason=just\s4\sfun

banid=1 error id=0 msg=ok

bandel

Deletes the ban rule with ID banid from the server.

Permissions:

b_client_ban_delete
b_client_ban_delete_own

Syntax:

bandel banid={banID}

Example:

bandel banid=3

error id=0 msg=ok

bandelall

Deletes all active ban rules from the server.

Permissions:

b_client_ban_delete

Syntax:

bandelall

Example:

bandelall

error id=0 msg=ok

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. Since version 3.0.13 there is an optional proto parameter. The client can request a protocol version with it. Currently only 0 and 1 are supported which only differ in the way they handle some timings. The server will reply which protocol version it will support. The server will reply with an ip parameter if it determines the filetransfer subsystem is not reachable by the ip that is currently being used for the query connection.

Permissions:

i_ft_file_upload_power
i_ft_needed_file_ upload _power
i_ft_quota_mb_upload_per_client

Syntax:

ftinitupload clientftfid={clientFileTransferID} name={filePath} cid={channelID} cpw={channelPassword} size={fileSize} overwrite={1|0} resume={1|0} [proto=0-1]

Example:

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 proto=0 error id=0 msg=ok

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. Since version 3.0.13 there is an optional proto parameter. The client can request a protocol version with it. Currently only 0 and 1 are supported which only differ in the way they handle some timings. The server will reply which protocol version it will support. The server will reply with an ip parameter if it determines the filetransfer subsystem is not reachable by the ip that is currently being used for the query connection.

Permissions:

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} [proto=0-1]

Example:

ftinitdownload clientftfid=1 name=\/image.iso cid=5 cpw= seekpos=0

clientftfid=1 serverftfid=7 ftkey=NrOga\/4d2GpYC5oKgxuclTO37X83ca\/1 port=30033 size=673460224 proto=0 error id=0 msg=ok

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.

Permissions:

b_ft_transfer_list

Syntax:

ftlist

Example:

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 … error id=0 msg=ok

ftgetfilelist

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

Permissions:

i_ft_file_browse_power
i_ft_needed_file_browse_power

Syntax:

ftgetfilelist cid={channelID} cpw={channelPassword} path={filePath}

Example:

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 … error id=0 msg=ok

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

Syntax:

ftgetfileinfo cid={channelID} cpw={channelPassword} name={filePath}…

Example:

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 … error id=0 msg=ok

ftstop

Stops the running file transfer with server-side ID serverftfid.

Syntax:

ftstop serverftfid={serverFileTransferID} delete={1|0}

Example:

ftstop serverftfid=2 delete=1

error id=0 msg=ok

ftdeletefile

Deletes one or more files stored in a channels file repository.

Permissions:

i_ft_file_delete_power
i_ft_needed_file_delete_power

Syntax:

ftdeletefile cid={channelID} cpw={channelPassword} name={filePath}…

Example:

ftdeletefile cid=2 cpw= name=\/Pic1.PNG|name=\/Pic2.PNG

error id=0 msg=ok

ftcreatedir

Creates new directory in a channels file repository.

Permissions:

i_ft_directory_create_power
i_ft_needed_file_directory_create_power

Syntax:

ftcreatedir cid={channelID} cpw={channelPassword} dirname={dirPath}

Example:

ftcreatedir cid=2 cpw= dirname=\/My\sDirectory

error id=0 msg=ok

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

Syntax:

ftrenamefile cid={channelID} cpw={channelPassword} [tcid={targetChannelID}] [tcpw={targetChannelPassword}] oldname={oldFilePath} newname={newFilePath}

Example:

ftrenamefile cid=2 cpw= tcid=3 tcpw=secret oldname=\/Pic3.PNG newname=\/Pic3.PNG

error id=0 msg=ok

customsearch

Searches for custom client properties specified by ident and value. The value parameter can include regular characters and SQL wildcard characters (e.g. %).

Syntax:

customsearch ident={ident} pattern={pattern}

Example:

customsearch ident=forum_account pattern=%ScP%

cldbid=2 ident=forum_account value=ScP error id=0 msg=ok

custominfo

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

Syntax:

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.

Syntax:

whoami

Example:

whoami

virtualserver_status=online virtualserver_id=1 virtualserver_unique_identifier=zrPkjznB1tMnRwj01xx7RxXjqeY= client_channel_id=2 … error id=0 msg=ok