Protocols/AOL/Midas/Megaphone: Difference between revisions

From NINA Wiki
Jump to navigation Jump to search
m (Fixed a mistake when copying over the table from the previous API documentation for categories)
m (Quickly fixing a mistake from my original document, will add more information on APIs tomorrow)
 
Line 40: Line 40:
|}
|}


=== api/v1/chat ===
=== api/v1/rooms ===


Gets chatrooms in a category.
Gets chatrooms in a category.

Latest revision as of 05:56, 6 December 2020

AOL Protocol
IntroductionTermsClients
Basic
Datatypes
FLAPP3Midas
TokensAtomsFDO
Tutorials
Sign On
Technical Documentation
Host Architecture

Megaphone is the API and system developed in-house by AOL to be used exclusively with the chat system for AOL Desktop Gold.

Backend Language

Megaphone is completely coded in JS or Javascript. When a user accesses AOL Desktop Gold and goes to access the chat system, Megaphone is what powers it. Megaphone is loaded in the client as a minified version of itself, this is so the file size will be smaller.

POST Requests

api/v1/categories

This allows to get the chat categories available.


Request parameters: “locale”: The language that you would like results to be displayed in.

Response: A list of categories.

Response Name Response Description
id UUID (identifier) of the category
name Name of the category
locale The language of the category
adult Is this category an adult category?
createdAt Created at time in milliseconds
displayName Display name
isCreatedByAolMember Is this category created by an AOL member?
isPrivate Is this category private?

api/v1/rooms

Gets chatrooms in a category.


Request parameters: locale: The language that you would like results to be displayed in.

Optional request parameters: name

Response: A list of chatrooms.

Response Name Response Description
id UUID (identifier) of the chat
categoryId UUID (identifier) of the category that this chat has been created under
name Name of the chat
locale The language of the chat
adult Is this chat an adult chat?
createdAt Created at time in milliseconds
displayName Display name
isCreatedByAolMember Is this chat created by an AOL member?
isPrivate Is this chat private?
category Category name