[API] TS3 PHP Framework

[Ronin Design]

// connect to local server, authenticate and spawn an object for the virtual server on port 9987
$ts3_VirtualServer = TeamSpeak3::factory("serverquery://<username>:<password>@<address>:10011/?server_port=9987");

Maybe you're just hiding credentials for the post, but you did make sure to put in real values for <username>, <password>, <address>?

Otherwise, your code looks fine...

Hello ma friends,

i have a problem where i need help.

The API is working fine when i am running it local under xampp with a puplic (not local) teamspeak.
Then i uploaded it to my webspace and i only get the following message:



The teamspeak server is working, i also can connect the server query with putty.
I think my webspace provider (https://www.hetzner.de/) is blocking outgoing connections like it is used in the API.
How can i verify this?
It is possible to check the requirements with phpinfo()?

I would appreciate help.

Your web host should provide you with ssh access. You can login, and then test with using telnet:
$ telnet <remote teamspeak IP> 10011

You should see the TeamSpeak 3 Server Query prompt.

Hello,

I am trying to make a function that moves people when they login. However, the functions of

$ts3_VirtualServer->notifyRegister("server");
$ts3_VirtualServer->notifyRegister("channel");
TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyLogin", "onLogin");
function onLogin(TeamSpeak3_Node_Host $host){
....
}

are not working. I believe the notifyLogin is what is called when someone joins the server, however it is not firing. Any help would be nice.

notifyLogin is not emitted when someone joins the server.

It is emitted from TeamSpeak3_Node_Host::login().
"Authenticates with the TeamSpeak 3 Server instance using given ServerQuery login credentials."
[doc] [src]


The notify event you're looking for is notifyCliententerview.
You can subscribe and register as follows:

  // Subscribe to event.
  TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyCliententerview", "onClientEnterView");

  // Connect to server, login and get TeamSpeak3_Node_Host object by URI
  $ts3 = TeamSpeak3::factory("serverquery://" . $cfg["user"] . ":" . $cfg["pass"] . "@" . $cfg["host"] . ":" . $cfg["query"] . "/?server_port=" . $cfg["voice"] . "&blocking=0");

  // Register for events as needed...
  $ts3->notifyRegister("server");
  $ts3->notifyRegister("channel");
  $ts3->notifyRegister("textserver");
  $ts3->notifyRegister("textchannel");
  $ts3->notifyRegister("textprivate");

  function onClientEnterView(TeamSpeak3_Node_Host $host){
    // move client to target channel...
  } 

How can i give a channel group to a user?

Please search the documentation before posting:

TeamSpeak3_Node_Server::clientSetChannelGroup($cld bid, $cid, $cgid)

Hello,
I'm trying to get a TS viewer. It's working fine on the one mashine but not working on the other. I'm getting this error:

https://pastebin.com/dnDeaCW0
(Can't paste it here, because the page forbids me to submit the post with the error)

My Code:

public function GetViewer(){
            return $this->worker->getViewer(new TeamSpeak3_Viewer_Html("assets/img/teamspeak_viewer/", "assets/img/countryflags-dis/", "data:image"));
}

Retrieving server information like online users is working fine with the same instance of the API.

I recommend double-checking the file locations on the other machine:
'assets/img/teamspeak_viewer/'
'assets/img/countryflags-dis/'

You might also try absolute path ('/....../assets/img/.....', etc) just to be safe.

I think I found some kind of bugs.
1. When channel is named as number eg. 123456 then channelList() return this channel_name as integer not as TeamSpeak3_Helper_String.

Edit:
I found fix for second bug on github: https://github.com/planetteamspeak/t...07492fb7e32225
Also I found another issue in situation that normally can not happen.
3. When I tried to download avatar and avatar file does not exist in ts_server_dir/files/virtualserver_1/internal my script get stuck, some kind of freeze and the only way to handle this is to kill process.
This could happen when some own copy server without files folder like I did for fast backup for tests only.

Myszax.

2nd bug is on GitHub repo as you found.

I can confirm 1st bug. If you have not already, I highly recommend opening two issues (one of each bug, 1st and 3rd).
This will greatly speed testing / fix implementation.

Thank you for pointing this out and providing examples, really helps a lot!

Guys I make a control panel, To control my server, Stop the server, start the server, Server Information.
When I stop the server The Website Is stop.
So how I can fix that problem?,

What do you mean by 'the website is stop'?
From your code, I see no loop logic that would stop the webpage from stopping after the framework request is finished.
If you want live server info, you need to use a loop (not recommended) or asynchronous refresh your server properties.

However, I'm still not sure exactly what issue you're having.

Please close the threat. Doesn't make sense to post here.

There is no support at all.

There are many ways to find the information for yourself:

With almost 100 pages of questions / examples in this forum, you can search google: 'how do I... site:forum.teamspeak.com'
You can check docs: https://docs.planetteamspeak.com/ts3/php/framework/
You can search source code: https://github.com/planetteamspeak/ts3phpframework
If you need real support, in the form of a bug fix, you can create an issue at the GitHub repo.

(not meaning to aggravate, just pointing out many sources of information, in case you are not aware...)

My bot only working 10min. Someone have any solutions?

You need to handle keepalive, otherwise your bot will be timed out by the TeamSpeak 3 server after 10 minutes.

Please search before simply posting, there are many examples of this. Some keywords to search with might be 'timeout', 'keepalive', etc.

NOTE: There may be bug in published / release version of the framework. Recommend downloading the latest directly from GitHub.
onServerQueryTimeout Bug: https://github.com/planetteamspeak/t...c9e88dca9dae19
Download latest version: https://github.com/planetteamspeak/t...ive/master.zip

Here is an example ScP gave for 'event based daemon', which implements onTimeout() keepalive logic:

<?php

/* load framework library */
require_once("TeamSpeak3/TeamSpeak3.php");

/* initialize */
TeamSpeak3::init();

try
{
  /* subscribe to various events */
  TeamSpeak3_Helper_Signal::getInstance()->subscribe("serverqueryConnected", "onConnect");
  TeamSpeak3_Helper_Signal::getInstance()->subscribe("serverqueryWaitTimeout", "onTimeout");
  TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyLogin", "onLogin");
  TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyEvent", "onEvent");
  TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyServerselected", "onSelect");

  /* connect to server, login and get TeamSpeak3_Node_Host object by URI */
  $ts3 = TeamSpeak3::factory("serverquery://username:[email protected]:10011/?server_port=9987&blocking=0");

  /* wait for events */
  while(1) $ts3->getAdapter()->wait();
}
catch(Exception $e)
{
  die("[ERROR]  " . $e->getMessage() . "\n");
}

// ================= [ BEGIN OF CALLBACK FUNCTION DEFINITIONS ] =================

/**
 * Callback method for 'serverqueryConnected' signals.
 *
 * @param  TeamSpeak3_Adapter_ServerQuery $adapter
 * @return void
 */
function onConnect(TeamSpeak3_Adapter_ServerQuery $adapter)
{
  echo "[SIG]\tconnected to TeamSpeak 3 Server on " . $adapter->getHost() . "\n";

  echo "[INFO]\tserver is running with version " . $adapter->getHost()->version("version") . " on " . $adapter->getHost()->version("platform") . "\n";
}

/**
 * Callback method for 'serverqueryWaitTimeout' signals.
 *
 * @param  integer $seconds
 * @return void
 */
function onTimeout($seconds, TeamSpeak3_Adapter_ServerQuery $adapter)
{
  echo "[SIG]\tno reply from the server for " . $seconds . " seconds\n";

  if($adapter->getQueryLastTimestamp() < time()-300)
  {
    echo "[INFO]\tsending keep-alive command\n";

    $adapter->request("clientupdate");
  }
}

/**
 * Callback method for 'notifyLogin' signals.
 *
 * @param  TeamSpeak3_Node_Host $host
 * @return void
 */
function onLogin(TeamSpeak3_Node_Host $host)
{
  echo "[SIG]\tauthenticated as user " . $host->whoamiGet("client_login_name") . "\n";
}

/**
 * Callback method for 'notifyEvent' signals.
 *
 * @param  TeamSpeak3_Adapter_ServerQuery_Event $event
 * @param  TeamSpeak3_Node_Host $host
 * @return void
 */
function onEvent(TeamSpeak3_Adapter_ServerQuery_Event $event, TeamSpeak3_Node_Host $host)
{
  echo "[SIG]\treceived notification " . $event->getType() . "\n\t" . $event->getMessage() . "\n";
}

/**
 * Callback method for 'notifyServerselected' signals.
 *
 * @param  string $cmd
 * @return void
 */
function onSelect(TeamSpeak3_Node_Host $host)
{
  echo "[SIG]\tselected virtual server with ID " . $host->serverSelectedId() . "\n";
  
  $host->serverGetSelected()->notifyRegister("server");
  $host->serverGetSelected()->notifyRegister("channel");
  $host->serverGetSelected()->notifyRegister("textserver");
  $host->serverGetSelected()->notifyRegister("textchannel");
  $host->serverGetSelected()->notifyRegister("textprivate");
}

[ref]

I got the following script to list all connected Clients, but i want to show the Server Group Icons of the Users as well in the list. How can i add that? I dont understand...

echo "<div class='list-group'>";
foreach($ts3_VirtualServer->clientList() as $client) {
	echo "<a href='#' class='list-group-item'>" . $client . "</a>";
}
echo "</div>";

This is just some pseudo-code to get you going in the right direction:

echo "<div class='list-group'>";
foreach($ts3_VirtualServer->clientList() as $client) {
  // Open row / line / link tag
  echo "<a href='#' class='list-group-item'>" . $client;

    foreach($client->memberOf() as $group) {
      // Get raw byte data for image, encoded in whatever the icon's Mime type is.
      $iconData = $group->iconDownload();
      
      // Dump raw image data by base64 encoding into HTML <img /> tag.
      echo ' <img src="data:' . TeamSpeak3_Helper_Convert::imageMimeType($iconData) . ';base64,' . base64_encode($iconData) . '" alt="'.$group['name'].'" /> ';
    }
  echo "</a>";
}
echo "</div>"; 

Again, this is untested pseudo-code, please troubleshoot / adjust as needed, but hopefully will give you an idea of how to do it.

You will probably need additional styling to render icons inline, etc.

[bamajoe411]

I'm trying to use the API to make a script that will help me find out which channels are used and which channels aren't so I can get rid of unused channels. I can't figure out how to get the number of users for each channel. Here is the script I've been testing with and it cycles through all the channels correctly but each loop just shows the number of clients in the entire server and not just that channel.

<?php

//Config
$user = "USER";
$pass = "PASS";
$serverIP = "IP";

// load framework files
require_once("libraries/TeamSpeak3/TeamSpeak3.php");

// connect to local server, authenticate and spawn an object for the virtual server on port 9987
$ts3_VirtualServer = TeamSpeak3::factory("serverquery://{$user}:{$pass}@{$serverIP}:10011/?server_port=9987");

// cycle through each channel and list how many clients there are
foreach ($ts3_VirtualServer->channelList() as $ts3_Channel) {
  $number = $ts3_Channel->clientCount();
  echo $ts3_Channel . " " . $number . "\n";
}

?>

[Ronin Design]

I'm trying to use the API to make a script that will help me find out which channels are used and which channels aren't so I can get rid of unused channels. I can't figure out how to get the number of users for each channel. Here is the script I've been testing with and it cycles through all the channels correctly but each loop just shows the number of clients in the entire server and not just that channel.

<?php

//Config
$user = "USER";
$pass = "PASS";
$serverIP = "IP";

// load framework files
require_once("libraries/TeamSpeak3/TeamSpeak3.php");

// connect to local server, authenticate and spawn an object for the virtual server on port 9987
$ts3_VirtualServer = TeamSpeak3::factory("serverquery://{$user}:{$pass}@{$serverIP}:10011/?server_port=9987");

// cycle through each channel and list how many clients there are
foreach ($ts3_VirtualServer->channelList() as $ts3_Channel) {
  $number = $ts3_Channel->clientCount();
  echo $ts3_Channel . " " . $number . "\n";
}

?>

The best way to do this is hinted at in the PHP TS3 Framework for TeamSpeak3_Node_Channel::clientList():

foreach($this->getParent()->clientList() as $client)
{
  if($client["cid"] == $this->getId())
  {
    $clients[$client->getId()] = $client;
  }
} 

[ref]

Adapted for your purpose, something like this might work:

$channels = [];

foreach($ts3_VirtualServer->clientList() as $client)
{
  if (!$channels[$client["cid"]]) {
    $channels[$client["cid"]] = 1
  } else {
    $channels[$client["cid"]]++
  }
}

// Sort by value, low to high, maintain key association:
asort($channels);

// Print Channels, lowest number of clients will show first.
print_r($channels); 

Please note: this logic is the reverse (or inverse) of your described method.

It loops the entire set of clients, initializing a counter for any channel a client is in.
If the channel already has a counter, it is incremented by one.

[GambarojaLP]

Hey,

I coded a little Plugin for my User Control Panel, sending out a Poke Message with a randomly generated code to an User.
The Plugin works great too.

The only Problem we have is, that for some Users, the Poke Messages doesn't arrive...
Now it happened to 2 People and I can't explain myself why.

Does anybody maybe know something?

[samlmao]

Hi. Trying to get a list of all clients in one specific channel. Currently using this but getting 500 error.
(the username and password has been omitted)

<?php

    error_reporting(-1);
    ini_set("display_errors", 1); 
// load framework files
require_once("libraries/TeamSpeak3/TeamSpeak3.php");
// connect to local server, authenticate and spawn an object for the virtual server on port 9987
$ts3_VirtualServer = TeamSpeak3::factory("serverquery://USERNAME:[email protected]:10011/?server_port=9987");

// grab current channel ID
$current_cid = $ts3->whoamiGet("cid");

// query the client list and filter by cid
$ts3->clientList(array("cid" => 28))

// spit out client nicknames
foreach($clients as $clid => $client)
{
  echo $client . "\n";
}  

?>

[Ronin Design]

Hey,

I coded a little Plugin for my User Control Panel, sending out a Poke Message with a randomly generated code to an User.
The Plugin works great too.

The only Problem we have is, that for some Users, the Poke Messages doesn't arrive...
Now it happened to 2 People and I can't explain myself why.

Does anybody maybe know something?

...it's hard to say without seeing your code around the poke logic.

There could be several things, are you getting any errors?

Some idea though:
Poking a client that no longer has the same client_id (e.g. you're not keeping client list updated).
Poke message is too long?
Server throttling / antiflood?
Client timeout while waiting for something or after being loaded for 10 minutes (keepalive)?
Needed poke power?
Internal interrupting logic, e.g. something causing the plugin to error / except before it gets a chance to send poke?

Really could be lots of things...
Maybe try sending textmessage along with the poke to increase chance of delivery...

Hi. Trying to get a list of all clients in one specific channel. Currently using this but getting 500 error.
(the username and password has been omitted)

<?php

    error_reporting(-1);
    ini_set("display_errors", 1); 
// load framework files
require_once("libraries/TeamSpeak3/TeamSpeak3.php");
// connect to local server, authenticate and spawn an object for the virtual server on port 9987
$ts3_VirtualServer = TeamSpeak3::factory("serverquery://USERNAME:[email protected]:10011/?server_port=9987");

// grab current channel ID
$current_cid = $ts3->whoamiGet("cid");

// query the client list and filter by cid
$ts3->clientList(array("cid" => 28))

// spit out client nicknames
foreach($clients as $clid => $client)
{
  echo $client . "\n";
}  

?>

From your code, $clients does not exist (was not assigned) before it was used (accessed).

Recommend:

// ...

// query the client list and filter by cid
// $ts3->clientList(array("cid" => 28)) // Change to:
$clients = $ts3->clientList(array("cid" => 28))

// spit out client nicknames
foreach($clients as $clid => $client)
// ... 

Assuming this is the most likely case as you're getting 500 server error.

[qeekus]

$ignorecid = 1453, 8512, 51, 14, 156;
foreach($tsAdmin->channelList() as $channels) {
echo $channels;
} 

How to ignore cid $ignorecid in channelList, not show channel with id ($ignorecid)?

[Ronin Design]

$ignorecid = 1453, 8512, 51, 14, 156;
foreach($tsAdmin->channelList() as $channels) {
echo $channels;
} 

How to ignore cid $ignorecid in channelList, not show channel with id ($ignorecid)?

$tsAdmin->channelList() has a $filter argument, but it does not work with an array.

An obvious or straight forward solution might be simply:

$ignorecid = [1453, 8512, 51, 14, 156];
foreach($tsAdmin->channelList() as $channel) {
  if (!in_array($channel->cid, $ignorecid)) {
    echo $channel;
  }
} 

NB: This is nk runtime (n channels x k ignorecids), depending on how many channels and how often you're doing this, you may want to cache or limit how often you run this.

[qeekus]

this solution show channel whis id $ignorecid

[Ronin Design]

I've updated original post. My apologies you want converse set by:

$ignorecid = [1453, 8512, 51, 14, 156];
foreach($tsAdmin->channelList() as $channel) {
  if (!in_array($channel->cid, $ignorecid)) {
    echo $channel;
  }
} 

[qeekus]

Ronin Design thx u, nice work)

[mr.jeffpaul]

I've removed my nesting from the framework as I don't want the lines to show, however - this was a problem before as well.

If I have a channel named Channel 1. Within that channel is sub 1, sub 2, sub 3.

Channel 1
. Sub 1
. Sub 2
. Sub 3

If you are in Sub 1, all appears correct
Channel 1
. Sub 1
. . User
. Sub 2
. Sub 3

But if you are in Channel 1, it looks like this.
Channel 1
. Sub 1
. Sub 2
. Sub 3
. User

I would rather it look like this:

Channel 1
. User
. Sub 1
. Sub 2
. Sub 3

I think the fix might be in /Node/Abstract.php line 192 which is function getViewer, but I am unsure. Has anyone else experienced this nesting issue and know how to resolve it?

There's an example.. Those users are in Lounge of All Lounges, not Bastard Chat.

[ScP]

I think the fix might be in /Node/Abstract.php line 192 which is function getViewer, but I am unsure. Has anyone else experienced this nesting issue and know how to resolve it?
http://forum.teamspeak.com/attachmen...id=15609&stc=1
There's an example.. Those users are in Lounge of All Lounges, not Bastard Chat.

Try using the clients_before_channels option in your factory or call the setLoadClientlistFirst() method on any node object.

$node->setLoadClientlistFirst(TRUE); 

Basically, this setting is similar to the "Sort clients below channels" option in the TeamSpeak 3 Client design settings.

[qeekus]

Not working line break in user description?

$output = '
This is line 1\r\n
This is line 2\r\n
This is line 3';
$client->client_description = $output; 

[PortStone]

Hey,

which command I need to show my servers Banner and Banner URL? Like:

Host Banner: [img]
Host Banner URL: [link]

If you go over with your mouse on [img] it will show the Image and if you click on [link] it will forward you to the Banner URL.