Setscroller

From xat wiki
(Redirected from SetScroller)
This page contains changes which are not marked for translation.


SetScroller is a feature aimed at advanced users who want to set the chat scroller automatically from their server. e.g. showing tweets, displaying now/next on their radio station.

To use it, you will need your chat's id and pw, which can be found in your chat's Extra features link.

Usage

You can use the API manually via a web page here: http://xat.com/web_gear/chat/SetScroller.php

Example

If your chat had ID 12345 and PW 1234567890 and you wanted the scroll message to display "Hello!" the link would look like this:

http://xat.com/web_gear/chat/SetScroller.php?Message=Hello!&id=12345&pw=1234567890

You can also access the API using a programming language.

Example of how to access the API in PHP:

$message = "Hello all!";
$id = 12345;
$pw = 1234567890;

$url = "http://xat.com/web_gear/chat/SetScroller.php?Message=".urlencode($message)."&id={$id}&pw={$pw}";
$ch = curl_init();
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt ($ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_TIMEOUT, 60);
$content = curl_exec ($ch);
print "$content\n";
curl_close ($ch);

Things to note

  • You are limited to 1 update every minute.
  • The above uses the GET HTTP method, POST will also work.
  • If you reset your chat you will need to update your software to go to the new ID and PW. If you change your group password you'll need to update to use the new pass.