Animadoria at 01:08, 16 May 2025

2025-05-16T01:08:19Z

← Older revision		Revision as of 01:08, 16 May 2025
Line 5:		Line 5:
	This is a NINA-created service and wasn't present in the original WebAPI.		This is a NINA-created service and wasn't present in the original WebAPI.

	To use chats you must subscribe to the "chats" [[Protocols/WebAPI/Reference/Enumeration#Event_Type\|Event Type]]. Chat events are sent through there		To use chats you must subscribe to the "chats" [[Protocols/WebAPI/Reference/Enumeration#Event_Type\|Event Type]]. Chat events are sent through there to announce chat specific events (message, user joins, user depatures, et cetera).

	== createAndJoinChat ==		== createAndJoinChat ==

Animadoria: Created page with "{{Protocols/WebAPI}} This page is about WebAPI chat methods, in a series for the WebAPI reference manual. This is a NINA-created service and wasn't present in the original WebAPI. To use chats you must subscribe to the "chats" Event Type. Chat events are sent through there == createAndJoinChat == Creates (if it doesn't exist) and joins a chat...."

2025-05-16T01:04:07Z

Created page with "{{Protocols/WebAPI}} This page is about WebAPI chat methods, in a series for the WebAPI reference manual. This is a NINA-created service and wasn't present in the original WebAPI. To use chats you must subscribe to the "chats" Event Type. Chat events are sent through there == createAndJoinChat == Creates (if it doesn't exist) and joins a chat...."

New page

{{Protocols/WebAPI}}

This page is about WebAPI chat [[Protocols/WebAPI/Reference/Methods|methods]], in a series for the WebAPI [[Protocols/WebAPI/Reference|reference manual]].

This is a NINA-created service and wasn't present in the original WebAPI.

To use chats you must subscribe to the "chats" [[Protocols/WebAPI/Reference/Enumeration#Event_Type|Event Type]]. Chat events are sent through there

== createAndJoinChat ==

Creates (if it doesn't exist) and joins a chat.

URL: GET http://api.nina.chat/chat/createAndJoinChat

=== Input Parameters ===

'''NOTE:''' You must either pass in roomId ''or'' roomName, not both.

{| class="wikitable"
! Type
! Field
! Description
|-
| [[Protocols/WebAPI/Reference/Enumeration#Format|Format]]
| f
| '' [Required]'' The format of the data returned
|-
| String
| c
| JSONP callback
|-
| String
| r
| Request id
|-
| String
| aimsid
| '' [Required]'' Use an AIM Session Id from the [[Protocols/WebAPI/Reference/Methods/Session#startSession|startSession]] call for authentication
|-
| String
| roomId
| Room ID as returned by the API
|-
| String
| roomName
| Room name
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

=== Output Fields ===

{| class="wikitable"
! Type
! Field
! Description
|-
| String
| chatsid
| ID that identifies this chat room session, not to be confused with the roomID
|-
| [[Protocols/WebAPI/Reference/Types#ChatRoom|ChatRoom]]
| room
| Chat room information
|}

=== Sample JSON Output ===
<pre>
{
"response": {
"statusCode": 200,
"statusText": "Ok",
"data": {
"chatsid": "1352330044",
"room": {
"roomName": "Last Call",
"roomId": "aol://2719:10-4-lastcall",
"instanceId": 0,
"roomType": "userCreated",
"categoryId": "131245"
}
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://developer.aim.com/xsd/chat.xsd">
<statusCode>200</statusCode>
<statusText>Ok</statusText>
<data/>
</response>
</pre>

== sendMessage ==

Sends a message to a chat room

URL: GET http://api.nina.chat/chat/sendMessage

=== Input Parameters ===

{| class="wikitable"
! Type
! Field
! Description
|-
| [[Protocols/WebAPI/Reference/Enumeration#Format|Format]]
| f
| '' [Required]'' The format of the data returned
|-
| String
| c
| JSONP callback
|-
| String
| r
| Request id
|-
| String
| aimsid
| '' [Required]'' Use an AIM Session Id from the [[Protocols/WebAPI/Reference/Methods/Session#startSession|startSession]] call for authentication
|-
| String
| chatsid
| '' [Required]'' Chat session ID as returned by the API on createAndJoinChat
|-
| String
| message
| '' [Required]'' Message to send to the chat room
|-
| String
| whisperTarget
| Whisper target if the message is a whisper; do not send if not a whisper
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

=== Sample JSON Output ===
<pre>
{
"response": {
"statusCode": 200,
"statusText": "Ok",
"data": {
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://developer.aim.com/xsd/chat.xsd">
<statusCode>200</statusCode>
<statusText>Ok</statusText>
</data>
</response>
</pre>

== setTyping ==

Sets typing status for a chat room

URL: GET http://api.nina.chat/chat/setTyping

=== Input Parameters ===

{| class="wikitable"
! Type
! Field
! Description
|-
| [[Protocols/WebAPI/Reference/Enumeration#Format|Format]]
| f
| '' [Required]'' The format of the data returned
|-
| String
| c
| JSONP callback
|-
| String
| r
| Request id
|-
| String
| aimsid
| '' [Required]'' Use an AIM Session Id from the [[Protocols/WebAPI/Reference/Methods/Session#startSession|startSession]] call for authentication
|-
| String
| chatsid
| '' [Required]'' Chat session ID as returned by the API on createAndJoinChat
|-
| [[Protocols/WebAPI/Reference/Enumeration#Typing_Status|Typing Status]]
| typingStatus
| '' [Required]'' The new typing status
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

=== Sample JSON Output ===
<pre>
{
"response": {
"statusCode": 200,
"statusText": "Ok",
"data": {
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://developer.aim.com/xsd/chat.xsd">
<statusCode>200</statusCode>
<statusText>Ok</statusText>
</data>
</response>
</pre>

== leaveChat ==

Leaves current chat room

URL: GET http://api.nina.chat/chat/leaveChat

=== Input Parameters ===

{| class="wikitable"
! Type
! Field
! Description
|-
| [[Protocols/WebAPI/Reference/Enumeration#Format|Format]]
| f
| '' [Required]'' The format of the data returned
|-
| String
| c
| JSONP callback
|-
| String
| r
| Request id
|-
| String
| aimsid
| '' [Required]'' Use an AIM Session Id from the [[Protocols/WebAPI/Reference/Methods/Session#startSession|startSession]] call for authentication
|-
| String
| chatsid
| '' [Required]'' Chat session ID as returned by the API on createAndJoinChat
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

=== Sample JSON Output ===
<pre>
{
"response": {
"statusCode": 200,
"statusText": "Ok",
"data": {
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://developer.aim.com/xsd/chat.xsd">
<statusCode>200</statusCode>
<statusText>Ok</statusText>
</data>
</response>
</pre>

[[Category:Stub]]
[[Category:AOL]]
[[Category:AIM]]
[[Category:Protocols/WebAPI]]
[[Category:Protocols/WebAPI/Reference]]
[[Category:Work_In_Progress]]

Protocols/WebAPI/Reference/Methods/Chat - Revision history

Animadoria at 01:08, 16 May 2025