Protocols/AOL/Midas/Megaphone: Difference between revisions
VoyArchivist (talk | contribs) (Added documentation for api/v1/chat) |
VoyArchivist (talk | contribs) m (Fixed a mistake when copying over the table from the previous API documentation for categories) |
||
| Line 72: | Line 72: | ||
| displayName || Display name | | displayName || Display name | ||
|- | |- | ||
| isCreatedByAolMember || Is this | | isCreatedByAolMember || Is this chat created by an AOL member? | ||
|- | |- | ||
| isPrivate || Is this chat private? | | isPrivate || Is this chat private? | ||
Revision as of 00:36, 5 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/chat
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 |