ChatApp Realtime API 0.8.0 documentation

ChatApp Realtime API 0.8.0

application/json
ID: urn:chatapp:realtime:api

AsyncAPI schema for Socket.IO events used by ChatApp.

Publish = event sent by the client.
Subscribe = event received by the client.

Servers

localhost:4000wslocal
Local backend server (Socket.IO endpoint /socket.io).
Security:
HTTP
Scheme: bearer
Bearer format: JWT

Operations

PUB join_chat
Client joins a chat room to receive realtime chat events.

Operation IDpublishJoinChat
Available only on servers:
- local
Accepts the following message:
Join/Leave/Typing Request
application/json
oneOf
Examples
string

This example has been generated automatically.
PUB leave_chat
Client leaves a chat room.

Operation IDpublishLeaveChat
Available only on servers:
- local
Accepts the following message:
Join/Leave/Typing Request
application/json
oneOf
Examples
string

This example has been generated automatically.
PUB typing_start
Client notifies it started typing. Server broadcasts to other members in the same chat room.

Operation IDpublishTypingStart
Available only on servers:
- local
Accepts the following message:
Join/Leave/Typing Request
application/json
oneOf
Examples
string

This example has been generated automatically.
SUB typing_start
Client notifies it started typing. Server broadcasts to other members in the same chat room.

Operation IDsubscribeTypingStart
Available only on servers:
- local
Accepts the following message:
application/json
object
Examples
{ "chatId": "string", "userId": "string", "username": "string" }

This example has been generated automatically.
PUB typing_end
Client notifies it stopped typing. Server broadcasts to other members in the same chat room.

Operation IDpublishTypingEnd
Available only on servers:
- local
Accepts the following message:
Join/Leave/Typing Request
application/json
oneOf
Examples
string

This example has been generated automatically.
SUB typing_end
Client notifies it stopped typing. Server broadcasts to other members in the same chat room.

Operation IDsubscribeTypingEnd
Available only on servers:
- local
Accepts the following message:
application/json
object
Examples
{ "chatId": "string", "userId": "string", "username": "string" }

This example has been generated automatically.

SUB new_message

New message created in a chat where the user participates.

Operation IDsubscribeNewMessage

Available only on servers:

local

Accepts the following message:

application/json

object

Examples

{
  "id": "string",
  "chatId": "string",
  "senderId": "string",
  "content": "string",
  "fileUrl": "string",
  "fileName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "sender": {
    "id": "string",
    "username": "string"
  }
}

This example has been generated automatically.

SUB chat_updated

Sidebar chat summary update (last message + unread count).

Operation IDsubscribeChatUpdated

Available only on servers:

local

Accepts the following message:

application/json

object

Examples

{
  "chatId": "string",
  "unreadCount": 0,
  "message": {
    "id": "string",
    "chatId": "string",
    "senderId": "string",
    "content": "string",
    "fileUrl": "string",
    "fileName": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "sender": {
      "id": "string",
      "username": "string"
    }
  }
}

This example has been generated automatically.

SUB chat_updated_info

Full chat object update for active views.

Operation IDsubscribeChatUpdatedInfo

Available only on servers:

local

Accepts the following message:

application/json

object

Examples

{
  "id": "string",
  "isGroup": true,
  "name": "string",
  "profilePic": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "users": [
    {
      "userId": "string",
      "chatId": "string",
      "unreadCount": 0,
      "joinedAt": "2019-08-24T14:15:22Z",
      "user": {
        "id": "string",
        "username": "string",
        "profilePic": "string",
        "lastSeen": "2019-08-24T14:15:22Z",
        "online": true
      }
    }
  ],
  "unreadCount": 0,
  "messages": [
    {
      "id": "string",
      "chatId": "string",
      "senderId": "string",
      "content": "string",
      "fileUrl": "string",
      "fileName": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "sender": {
        "id": "string",
        "username": "string"
      }
    }
  ]
}

This example has been generated automatically.

SUB new_chat

User has been added to a newly created chat.

Operation IDsubscribeNewChat

Available only on servers:

local

Accepts the following message:

application/json

object

Examples

{
  "id": "string",
  "isGroup": true,
  "name": "string",
  "profilePic": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "users": [
    {
      "userId": "string",
      "chatId": "string",
      "unreadCount": 0,
      "joinedAt": "2019-08-24T14:15:22Z",
      "user": {
        "id": "string",
        "username": "string",
        "profilePic": "string",
        "lastSeen": "2019-08-24T14:15:22Z",
        "online": true
      }
    }
  ],
  "unreadCount": 0,
  "messages": [
    {
      "id": "string",
      "chatId": "string",
      "senderId": "string",
      "content": "string",
      "fileUrl": "string",
      "fileName": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "sender": {
        "id": "string",
        "username": "string"
      }
    }
  ]
}

This example has been generated automatically.

SUB chat_deleted
Chat has been deleted.

Operation IDsubscribeChatDeleted
Available only on servers:
- local
Accepts the following message:
application/json
allOf
Deleted chat ID.

Examples
string

This example has been generated automatically.
SUB user_status
Presence update for a related user.

Operation IDsubscribeUserStatus
Available only on servers:
- local
Accepts the following message:
application/json
object
Examples
{ "userId": "string", "online": true, "lastSeen": "2019-08-24T14:15:22Z" }

This example has been generated automatically.

Messages

#1Join/Leave/Typing Request
- application/json
Message IDJoinLeaveChatMessage
oneOf
#2
- application/json
Message IDTypingStatusMessage
object
#3
- application/json
Message IDNewMessageMessage
object
#4
- application/json
Message IDChatUpdatedMessage
object
#5
- application/json
Message IDChatUpdatedInfoMessage
object
#6
- application/json
Message IDNewChatMessage
object
#7
- application/json
Message IDChatDeletedMessage
allOf
Deleted chat ID.
#8
- application/json
Message IDUserStatusMessage
object

Schemas

string
Chat ID.
object
oneOf
object
object
allOf
Deleted chat ID.
object
object
object
object
object
object

ChatApp Realtime API 0.8.0

Servers

Security:

Operations

PUB join_chat

Examples

This example has been generated automatically.

PUB leave_chat

Examples

This example has been generated automatically.

PUB typing_start

Examples

This example has been generated automatically.

SUB typing_start

Examples

This example has been generated automatically.

PUB typing_end

Examples

This example has been generated automatically.

SUB typing_end

Examples

This example has been generated automatically.

SUB new_message

Examples

This example has been generated automatically.

SUB chat_updated

Examples

This example has been generated automatically.

SUB chat_updated_info

Examples

This example has been generated automatically.

SUB new_chat

Examples

This example has been generated automatically.

SUB chat_deleted

Examples

This example has been generated automatically.

SUB user_status

Examples

This example has been generated automatically.

Messages

Schemas