Room

Management

room.create

Create a new chatroom, owned by the currently-authenticated user.

Currently, users are limited to owning up to 200 rooms.

HTTP Method:

POST

URL:

http://www.lingr.com/api/room/create

Parameters:

session `*`	The authenticated session id
name `*`	The name for the new chatroom
description	A description for the new chatroom
password	The password for the new chatroom, if one is desired
listed_in_directory	If `true`, the new chatroom is listed in the public directory of rooms. Otherwise, the new chatroom is not listed. If not provided, the default is `true`.
id	The id for the new chatroom. The id of a chatroom determines the chatroom’s URL. If no id is provided, a random id is generated by the system.
timezone	The timezone for the chatroom. The timezone of a chatroom affects the display of message timestamps in that room. For a list of supported values, see the room settings page at Lingr. If no timezone is provided, the default is “Pacific (US & Canada)”.
tags	A space-delimited list of tags for the new chatroom. To use the space character within a tag, surround the tag with double quotes.
image	An image for the new chatroom. If you provide this parameter, you must comply with the image upload requirements

(*) Required

Example Response:

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <room>
    <id>myawesomeroom</id>
    <name>My awesome room</name>
    <description>A really GREAT room</description>
    <url>http://www.lingr.com/room/myawesomeroom</url>
    <icon_url>http://images.lingr.com/room/gc/nZ/3v/Ac/ZDA/16x16.gif</icon_url>
    <counter>0</counter>
    <max_user_message_id>0</max_user_message_id>
    <tags/>
  </room>
</response>

A successful response contains the following data items:

room

Descriptive information for the new room. This information has elements described here

room.changeSettings

Change the settings on an existing chatroom.

HTTP Method:

POST

URL:

http://www.lingr.com/api/room/change_settings

Parameters:

session `*`	The authenticated session id
id `*`	The id of the chatroom for which you want to change settings.
new_id	A new id for the chatroom
name	A new name for the chatroom
description	A new description for the chatroom
password	A new password for the chatroom. If you pass an empty string, any password currently set for the room is removed.
listed_in_directory	If `true`, the chatroom is listed in the public directory of rooms. Otherwise, the new chatroom is not listed. If not provided, the current state of listing is unchanged.
timezone	A new timezone for the chatroom.
tags	A space-delimited list of new tags for the new chatroom. To use the space character within a tag, surround the tag with double quotes.
image	A new image for the chatroom. If you provide this parameter, you must comply with the image upload requirements

(*) Required

Example Response:

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
  <room>
    <id>myawesomeroom</id>
    <name>My awesome room</name>
    <description>A really GREAT room</description>
    <url>http://www.lingr.com/room/myawesomeroom</url>
    <icon_url>http://images.lingr.com/room/gc/nZ/3v/Ac/ZDA/16x16.gif</icon_url>
    <counter>0</counter>
    <max_user_message_id>0</max_user_message_id>
    <tags/>
  </room>
</response>

A successful response contains the following data items:

room

Descriptive information for the new room. This information has elements described here

room.delete

Delete an existing chatroom.

HTTP Method:

POST

URL:

http://www.lingr.com/api/room/delete

Parameters:

session `*`	The authenticated session id
id `*`	The id of the chatroom that you wish to delete.

(*) Required

Example Response:

<?xml version='1.0' encoding='UTF-8'?>
<response>
  <status>ok</status>
</response>