Protocols/AOL/Midas/Megaphone: Difference between revisions
VoyArchivist (talk | contribs) m (Removing some information deemed not important from the responses table of the categories POST request) |
m (Quickly fixing a mistake from my original document, will add more information on APIs tomorrow) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{Protocols/AOL | |||
|protocol=midas}} | |||
Megaphone is the API and system developed in-house by AOL to be used exclusively with the chat system for AOL Desktop Gold. | Megaphone is the API and system developed in-house by AOL to be used exclusively with the chat system for AOL Desktop Gold. | ||
Line 36: | Line 39: | ||
| isPrivate || Is this category private? | | 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. | |||
{| class="wikitable" | |||
|- | |||
! 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 | |||
|} | |||
[[Category:AOL]] | |||
[[Category:Protocols/AOL]] | |||
[[Category:Not_Currently_Documented]] | |||
[[Category:Work_In_Progress]] |
Latest revision as of 05:56, 6 December 2020
AOL Protocol |
Introduction • Terms • Clients |
Basic |
Datatypes • |
FLAP • P3 • Midas |
Tokens • Atoms • FDO |
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 |