Skip to content

Chatroom API Reference

Rahil khan edited this page May 22, 2022 · 3 revisions

A Fully anonymous, temporary, disposable chat API

API Reference

Create room

  GET https://clorabase.herokuapp.com/chat/create
Parameter Type Description
room string Required. Id of the room to create

A successful response will return the admin id of the room.

Join room

  Websocket wss://clorabase.herokuapp.com/chat/join
Parameter Type Description
room string Required. Id of room to join
user string Required. Username of the person joining the room

If failed, the connection would not be made and an error code will be returned. Possibility is that you might be joining a room that does not exist or an user already exist with such name.

Note : To send message to perticular user, use the formate : [PM:username] YOUR_MESSAGE_HERE

Delete room / kick memeber

  GET https://clorabase.herokuapp.com/chat/:room/delete
Parameter Type Description
admin string Required. Admin ID, got when creating room
user string Optional. Username of the person you want to kick

If the user parameter is not passed, the whole room will be closed else the user with the user username will be kicked from the room.

Getting online memebers

  GET https://clorabase.herokuapp.com/chat/:room/memebers
Parameter Type Description
room string Required. Id of room to join

This will return a JSON array of the usernames of the members that are currently in the room.

Clone this wiki locally