API References - Real Time Messaging

Welcome to the Awesome Chat API documentation! This API offers a robust set of endpoints for creating and managing chat platforms. Features include Room Management, Message Handling, Polls, Chat History, Message Replies, Room Role-Based Access Control (RBAC), Admin Moderation, User Management, Attachments, Emojis and Efficient Search Capabilities.

Get started by obtaining your API key and referring to detailed documentation for each endpoint. Ensure proper authentication and authorization for secure integration. Create a dynamic and feature-rich chat platform with the Awesome Chat API!

List all rooms

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/messaging/rooms' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "rooms": [
    {
      "allowed_user_ids": [
        "user_1_id",
        "user_2_id"
      ],
      "app_id": "789",
      "created_by": "1001",
      "id": 123,
      "owner_id": 789,
      "session_id": "channel123",
      "status": "active"
    },
    {
      "allowed_user_ids": [
        "user_3_id",
        "user_4_id"
      ],
      "app_id": "123",
      "created_by": "1002",
      "id": 456,
      "owner_id": 789,
      "session_id": "channel456",
      "status": "inactive"
    }
  ]
}

Rooms response

Create a new room

post

Authorizations

Body

allowed_user_idsstring[]optional

Allowed User IDs

channel_idstringrequired

Create Channel

statusstringoptional

Room status

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/create' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "allowed_user_ids": [
      "user_1_id",
      "user_2_id"
    ],
    "channel_id": "room123",
    "status": "active"
  }'

201

201

{
  "room": {
    "allowed_user_ids": [
      "user_1_id",
      "user_2_id"
    ],
    "app_id": "789",
    "created_by": "1001",
    "id": 123,
    "owner_id": 456,
    "session_id": "channel123",
    "status": "active"
  }
}

Room response

Find a room by channel ID

get

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "room": {
    "allowed_user_ids": [
      "user_1_id",
      "user_2_id"
    ],
    "app_id": "789",
    "created_by": "1001",
    "id": 123,
    "owner_id": 456,
    "session_id": "channel123",
    "status": "active"
  }
}

Room response

Get messages in a channel

get

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

Query parameters

sizeintegeroptional

Number of messages to retrieve

Example: 10

offsetintegeroptional

Offset for pagination

Example: 0

message_idsstringoptional

List of message IDs

Example: [2001,2002]

group_by_daybooleanoptional

messages group by day

Example: false

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "content": "Hello, world!",
  "created_by": "123",
  "created_by_name": "John Doe",
  "id": 1001,
  "inserted_at": "2023-11-20T08:30:00Z"
}

Message response

Delete messages

delete

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

Body

is_emptybooleanoptional

If true, delete all messages in the channel

message_idsinteger[]optional

list of messages ids to delete

Example: [2001,2002]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "is_empty": true,
    "message_ids": [
      1000,
      1001
    ]
  }'

200

200

{
  "message": "Message deleted successfully"
}

Message replies deleted successfully

Search messages in a channel

get

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

Query parameters

search_termstringoptional

Search term

Example: keyword

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/search' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "content": "Hello, world!",
  "created_by": "123",
  "created_by_name": "John Doe",
  "id": 1001,
  "inserted_at": "2023-11-20T08:30:00Z"
}

Message response

Get a single message

get

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

message_idintegerrequired

Message ID

Example: 1001

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "content": "Hello, world!",
  "created_by": "123",
  "created_by_name": "John Doe",
  "id": 1001,
  "inserted_at": "2023-11-20T08:30:00Z"
}

Message response

Edit a message

put

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

message_idintegerrequired

Message ID

Example: 1001

Body

contentstringoptional

New content for the message

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "content": "Updated content"
  }'

200

200

{
  "content": "Hello, world!",
  "created_by": "123",
  "created_by_name": "John Doe",
  "id": 1001,
  "inserted_at": "2023-11-20T08:30:00Z"
}

Message response

Get replies for a message

get

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

message_idintegerrequired

Message ID

Example: 1001

Query parameters

group_by_daybooleanoptional

messages group by day

Example: false

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/messages_replies' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "content": "Hello, world!",
  "created_by": "123",
  "created_by_name": "John Doe",
  "id": 1001,
  "inserted_at": "2023-11-20T08:30:00Z"
}

Message response with replies

Delete replies for a message

delete

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

message_idintegerrequired

Message ID

Example: 1001

Body

reply_message_idsinteger[]optional

List of reply message IDs to delete

Example: [2001,2002]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/messages_replies' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "reply_message_ids": [
      1000,
      1002
    ]
  }'

200

200

{
  "message": "Message deleted successfully"
}

Message replies deleted successfully

Check if the current user has voted for a poll

get

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

message_idintegerrequired

Message ID

Example: 1001

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/poll/is_voted' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "is_voted": true
}

Is voted response

Get total votes for a poll

get

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

message_idintegerrequired

Message ID

Example: 1001

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/poll/votes' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "votes": [
    {
      "answer": 1,
      "user_id": "123"
    },
    {
      "answer": 2,
      "user_id": "456"
    }
  ]
}

Total votes response

Update a user's answer for a poll

post

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

message_idintegerrequired

Message ID

Example: 1001

poll_option_idintegerrequired

Poll Option ID

Example: 1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/poll/{poll_option_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "poll_answer": {
    "answer": 1,
    "user_id": "123"
  }
}

Poll answer response

Get details of a user in a room

get

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

user_idstringrequired

User ID

Example: 1001

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/users/{user_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "user": {
    "id": "789",
    "name": "John Doe"
  }
}

User response

Add a user to a room

post

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

user_idstringrequired

User ID

Example: 1001

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/users/{user_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "room": {
    "allowed_user_ids": [
      "user_1_id",
      "user_2_id"
    ],
    "app_id": "789",
    "created_by": "1001",
    "id": 123,
    "owner_id": 456,
    "session_id": "channel123",
    "status": "active"
  }
}

Room response

Delete a user from a room

delete

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

user_idstringrequired

User ID

Example: 1001

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/users/{user_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "room": {
    "allowed_user_ids": [
      "user_1_id",
      "user_2_id"
    ],
    "app_id": "789",
    "created_by": "1001",
    "id": 123,
    "owner_id": 456,
    "session_id": "channel123",
    "status": "active"
  }
}

Room response

Search for user in rooms within an organization

get

Authorizations

Query parameters

search_termstringoptional

Search term

Example: john

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/messaging/users/search' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "users": [
    {
      "id": "789",
      "name": "John Doe"
    },
    {
      "id": "123",
      "name": "Johnathan"
    }
  ]
}

Users response

Generate Token

post

Generate a JWT token based on provided parameters.

Authorizations

Body

apiKeystringrequired

API key tied to the Sariska account

expstringoptional

Exp claim of JWT token

nbfstringoptional

Nbf claim of JWT token

scopestringoptional

Scope of the token (messaging, media, sariska, or leave it blank)

userobjectoptional

User information

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sariska.io/api/v1/misc/generate-token' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "apiKey": "iufwenufewifweifiuTbddhbdjhjfbjfjwfjwfj",
    "exp": "24 hours",
    "nbf": "",
    "scope": "messaging",
    "user": {
      "avatar": "https://some-storage-location/nick.jpg",
      "email": "[e-mail]",
      "id": "ytyVgh",
      "moderator": false,
      "name": "Nick"
    }
  }'

200

200

{
  "token": "your_generated_token_here"
}

Token generated successfully

Get S3 presigned

post

Get S3 presigned url and upload media to directly your s3 as you have configured in console

Authorizations

Body

fileNamestringoptional

File name

Example: some-s3-folder/file-name.jpeg

fileTypestringoptional

File extension

Example: jpeg

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sariska.io/api/v1/misc/get-presigned' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "fileName": "some-s3-folder/file-name.jpeg",
    "fileType": "jpeg"
  }'

200

200

{
  "presigned_url": "url"
}

Presigned URL generated successfully

Get all users in a room

get

Authorizations

Path parameters

channel_idstringrequired

Channel ID

Example: channel123

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sariska.io/api/v1/rooms/{channel_id}/users' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "users": [
    {
      "id": "789",
      "name": "John Doe"
    },
    {
      "id": "123",
      "name": "Krish"
    }
  ]
}

Users response

For a full list of APIs go to: https://messaging.sariska.io/swaggerui