Private channelgroupsPrivate channelsPrivate clientsReadonly configPrivate contextPrivate priorizePrivate queryPrivate serverPrivate servergroupsPrivate serversDisplays a list of active bans on the selected virtual server.
Optional start: numberoptional start from where clients should be listed
Optional duration: numberoptional duration on how much ban entries should be retrieved
displays a list of permissions defined for a client in a specific channel
the channel to search from
the client database id to get permissions from
Optional permsid: falsewether to retrieve permission names instead of ids
Optional permsid: trueCreates a new channel using the given properties. Note that this command accepts multiple properties which means that you're able to specifiy all settings of the new channel at once.
the name of the channel
properties of the channel
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.
the channel id
the permid or permsid
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.
the channel id
if set to 1 the channel will be deleted even when client are in it
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.
the channel id
the properties of the channel which should get changed
Adds a specified permissions to the channel group. A permission can be specified by permid or permsid.
the channelgroup id
Optional perm: undefinedthe permission object
Displays the IDs of all clients currently residing in the channel group.
Optional channel: ChannelTypeOptional client: TeamSpeakClient.ClientTypeCreates a copy of the channel group. 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 source channelgroup
the target channelgroup (0 to create a new group)
the type of the group (0 = Template Group | 1 = Normal Group)
name of the goup
Creates a new channel group using a given name. The optional type parameter can be used to create ServerQuery groups and template groups.
the name of the channelgroup
type of the channelgroup
Removes a set of specified permissions from the channel group. A permission can be specified by permid or permsid.
the channelgroup id
the permid or permsid
Displays a list of channel groups available. Depending on your permissions, the output may also contain template groups.
Displays a list of permissions assigned to the channel group specified with cgid.
the channelgroup id to list
if the permsid option is set to true the output will contain the permission names.
Create a new privilegekey token for a Channel Group and assigned Channel ID with the given description
the channel group for which the token should be valid
Optional description: stringtoken description
Optional customset: stringChanges the name of the channel group
the channelgroup id to rename
new name of the ghannelgroup
Displays detailed configuration information about a channel including ID, topic, description, etc.
the channel id
Lists all Channels with a given Filter
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.
the channel id
channel parent id
channel sort order
Displays a list of permissions defined for a channel.
the channel id
whether the permsid should be displayed aswell
Adds a set of specified permissions to a channel.
the channel id
the permission object
Adds a set of specified permissions to a channel. A permission can be specified by permid or permsid.
the channel id
the permissions to assign
TeamSpeak.channelSetPerms(5, [{ permsid: "i_channel_needed_modify_power", permvalue: 75 }])
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.
the client database id
the permission object
Adds one or more servergroups to a client. Please note that a client cannot be added to default groups or template groups
one or more client database ids which should be added
one or more servergroup ids which the client should be added to
Deletes a clients properties from the database.
the client database id which should be deleted
Changes a clients settings using given properties.
the client database id which should be edited
the properties which should be modified
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 which should be searched for
true when instead of the Name it should be searched for an uid
Returns the Clients Database Info
one or more client database ids to get
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
the client database id
the permid or permsid
Removes one or more servergroups from the client.
one or more client database ids which should be added
one or more servergroup ids which the client should be removed from
edits a specific client
the client id to modify
the properties to change
Returns General Info of the Client, requires the Client to be online
one or more client ids to get
Kicks the Client from the Server
the client id
the reasonid
the message the client should receive when getting kicked
ignore errors
Lists all Clients with a given Filter
Moves the Client to a different Channel
the client id
channel id in which the client should get moved
Optional cpw: stringthe channel password
ignore errors
Displays a list of permissions defined for a client
the client database id
if the permsid option is set to true the output will contain the permission names
Pokes the Client with a certain message
the client id
the message the client should receive
Submits a complaint about the client with database ID dbid to the server.
filter only for certain client with the given database id
the Message which should be added
Deletes the complaint about the client with ID tcldbid submitted by the client with ID fdbid from the server. If fcldbid will be left empty all complaints for the tcldbid will be deleted
the target client database id
Optional fromClient: TeamSpeakClient.ClientTypethe client database id which filed the report
Displays a list of complaints on the selected virtual server. If dbid is specified, only complaints about the targeted client will be shown.
Optional client: TeamSpeakClient.ClientTypefilter only for certain client with the given database id
Private createPrivate createPrivate createPrivate createdisplays 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. only supports version 2 (from server 3.10.0)
Optional password: stringthe optional password to encrypt the snapshot
Removes a custom property from a client specified by the cldbid. This requires TeamSpeak Server Version 3.2.0 or newer.
the client Database ID which should be changed
the key which should be deleted
returns a list of custom properties for the client specified with cldbid.
the Client Database ID which should be retrieved
Searches for custom client properties specified by ident and value. The value parameter can include regular characters and SQL wildcard characters (e.g. %).
the key to search for
the search pattern to use
Creates or updates a custom property for client specified by the cldbid. Ident and value can be any value, and are the key value pair of the custom property. This requires TeamSpeak Server Version 3.2.0 or newer.
the client database id which should be changed
the key which should be set
the value which should be set
Deletes the channel group. If force is set to 1, the channel group will be deleted even if there are clients within.
the channelgroup id
if set to true the channelgroup will be deleted even when clients are in it
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. only supports version 2 (from server 3.10.0)
Optional salt: stringif a password has been set provide the salt from the response
Optional password: stringthe password which has been set while saving
wether it should keep the file mapping
Optional version: stringof the snapshot with 0 the version of the current teamspeak server is being used
returns the file in the channel with the given path
the path whith the filename where the file should be uploaded to
channel id to download from (0 = server)
channel password of the channel which will be uploaded to
Private evchannelcreatedPrivate evchanneldeletedPrivate evchanneleditedPrivate evchannelmovedPrivate evcliententerviewPrivate evclientleftviewPrivate evclientmovedPrivate evservereditedPrivate evtextmessagePrivate evtokenusedSends a raw command to the TeamSpeak Server.
Rest ...args: executeArgs[]the command which should get executed on the teamspeak server
ts3.execute("clientlist", ["-ip"])
ts3.execute("use", [9987], { clientnickname: "test" })
Creates new directory in a channels file repository
the channel id to check for
path to the directory
the channel password
Deletes one or more files stored in a channels file repository
the channel id to check for
path to the file to delete
the channel password
Displays detailed information about one or more specified files stored in a channels file repository.
the channel id to check for
the filepath to receive
the channel password
Displays a list of files and directories stored in the specified channels file repository.
the channel id to check for
the path to list
the channel password
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.
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.
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
the channel id to check for
the path to the file which should be renamed
the path to the file with the new name
Optional tcid: stringtarget channel id if the file should be moved to a different channel
the channel password from where the file gets renamed
the channel password from where the file will get transferred to
Retrieves a Single Channel by the given Channel ID
the channel id
Retrieves a Single Channel by the given Channel Name
the name of the channel
Retrieves a single ChannelGroup by the given ChannelGroup ID
the channelgroup Id
Retrieves a single ChannelGroup by the given ChannelGroup Name
the channelGroup name
Retrieves a Single Client by the given Client Database ID
the client database Id
Retrieves a Single Client by the given Client ID
the client id
Retrieves a Single Client by the given Client Unique Identifier
the nickname of the client
Retrieves a Single Client by the given Client Unique Identifier
the client unique identifier
Private getRetrieves a single ServerGroup by the given ServerGroup ID
the servergroup id
Retrieves a single ServerGroup by the given ServerGroup Name
the servergroup name
Private handleparses the whole cache by given objects
the cache object
the list to check against the cache
the key used to identify the object inside the cache
the class which should be used
Private handlePrivate handlePrivate ignorewether the query client should get handled or not
the client type
Private isWrites 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
level 1 to 4
message to log
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.
amount of lines to receive
invert output (like Array.reverse)
instance or virtualserver log
begin at position
Sends an offline message to the client specified by uid.
client unique identifier
subject of the message
message text
Optional error: ErrorRetrieves detailed information about all assignments of the permission. The output is similar to permoverview which includes the type and the ID of the client, channel or group associated with the permission.
perm id or name to retrieve
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.
the client database id
one or more permission names
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.
Create a new token.+ If type is set to 0, the ID specified with tokenid will be a server group ID. Otherwise, tokenid is used as a channel group ID and you need to provide a valid channel ID using channelid.
token type
depends on the type given, add either a valid channelgroup or servergroup
depends on the type given, add a valid channel id
Optional description: stringtoken description
Optional customset: stringtoken custom set
Optional description: stringOptional customset: stringAdds a new query client login, or enables query login for existing clients. When no virtual server has been selected, the command will create global query logins. Otherwise the command enables query login for existing client, and cldbid must be specified.
the login name
Optional client: TeamSpeakClient.ClientTypeoptional database id or teamspeak client
Deletes an existing server query login on selected server. When no virtual server has been selected, deletes global query logins instead.
client database id or teamspeak client object
List existing query client logins. The pattern parameter can include regular characters and SQL wildcard characters (e.g. %). Only displays query logins of the selected virtual server, or all query logins when no virtual server have been selected.
Optional pattern: stringthe pattern to filter for client login names
Optional start: numberthe offset from where clients should be listed
Optional duration: numberhow many clients should be listed
attempts a reconnect to the teamspeak server with full context features
the amount of times it should try to reconnect (-1 = try forever)
time in ms to wait inbetween reconnect
retrieves the own query client as TeamSpeakClient instance
sends a message to a teamspeak channel, if the client is not in this channel he will move into the channel, send the message and move back after
the target channel to send the message
the message which should be sent
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.
target client id or channel id which should receive the message
targetmode (1: client, 2: channel, 3: server)
the message the client should receive
Creates a new virtual server using the given properties and displays its ID, port and initial administrator privilege key. If virtualserverPort is not specified, the server will test for the first unused UDP port
the server properties
deletes the teamspeak server
the server id to delete
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.
Adds one or more clients to a server group specified with sgid. Please note that a client cannot be added to default groups or template groups
one or more client database ids which should be added
the servergroup id which the client(s) should be added to
Adds a specified permissions to the server group. A permission can be specified by permid or permsid.
the serverGroup id
the permission object
returns the IDs of all clients currently residing in the server group.
the servergroup id
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 source ServerGroup
the target ServerGroup, 0 to create a new Group
the type of the servergroup (0 = Query Group | 1 = Normal Group)
name of the group
Creates a new server group using the name specified with name. The optional type parameter can be used to create ServerQuery groups and template groups.
the name of the servergroup
type of the servergroup
Deletes the server group. If force is set to 1, the server group will be deleted even if there are clients within.
the servergroup id
if set to 1 the servergoup will be deleted even when clients stil belong to this group
Removes one or more clients from the server group specified with sgid.
one or more client database ids which should be added
the servergroup id which the client(s) should be removed from
Removes a set of specified permissions from the server group. A permission can be specified by permid or permsid.
the servergroup id
the permid or permsid
Displays a list of server groups available. Depending on your permissions, the output may also contain global ServerQuery groups and template groups.
Displays a list of permissions assigned to the server group specified with sgid.
if the permsid option is set to true the output will contain the permission names
Create a new privilegekey token for a ServerGroup with the given description
servergroup which should be generated the token for
Optional description: stringtoken description
Optional customset: stringChanges the name of the server group
the servergroup id
new name of the servergroup
displays all server groups the client specified with cldbid is currently residing in
the client database id to check
Displays a list of virtual servers including their ID, status, number of clients online, etc.
Stops the entire TeamSpeak 3 Server instance by shutting down the process.
Optional reasonmsg: stringspecifies a text message that is sent to the clients before the client disconnects (requires TeamSpeak Server 3.2.0 or newer).
Starts the virtual server. Depending on your permissions, you're able to start either your own virtual server only or all virtual servers in the server instance.
the server id to start
Stops the virtual server. Depending on your permissions, you're able to stop either your own virtual server only or all virtual servers in the server instance.
the server id to stop
Optional reasonmsg: stringSpecifies a text message that is sent to the clients before the client disconnects (requires TeamSpeak Server 3.2.0 or newer).
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.
Sets the channel group of a client
the channelgroup which the client should get assigned
the channel in which the client should be assigned the group
the client database id which should be added to the group
Private updatePrivate updateupdates the context when the inner callback gets called and throws the first parameter which is an error
context data to update
Private updateuploads a file
the path whith the filename where the file should be uploaded to
the data to upload
channel id to upload to (0 = server)
channel password of the channel which will be uploaded to
Selects the virtual server specified with the sid to allow further interaction.
the server id
Optional clientNickname: stringset nickname when selecting a server
Displays the servers version information including platform and build number.
if this parameter has been set it will send a command to the server otherwise will use the cached info
Static connectconnects via a Promise wrapper
config options to connect
Static filterStatic singleStatic toStatic waitGenerated using TypeDoc
Deletes an apikey. Any apikey owned by the current user, can always be deleted Deleting apikeys from other requires bVirtualserverApikeyManage