User:Ethan: Difference between revisions

From xat wiki
(Blanked the page)
No edit summary
Line 1: Line 1:
__NOTOC__
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 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''':
<pre>http://xat.com/web_gear/chat/SetScroller.php?Message=Hello%20all!&id=12345&pw=1234567890</pre>
Or you can access the API using a programming language.
'''Example of how to access the API in PHP''':
<pre>
$url = 'http://xat.com/web_gear/chat/SetScroller.php';
$url .= "?Message=".urlencode("Hi there");
$url .= "&id=12345";
$url .= "&pw=1234567890";
$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);
</pre>
'''Notes''':
*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.

Revision as of 11:58, 4 September 2016

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

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

Or you can access the API using a programming language.

Example of how to access the API in PHP:

$url = 'http://xat.com/web_gear/chat/SetScroller.php';
$url .= "?Message=".urlencode("Hi there");
$url .= "&id=12345";
$url .= "&pw=1234567890";
$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);

Notes:

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