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

GEThttps://api.sariska.io/api/v1/messaging/rooms

Response

Rooms response

Body

roomsarray of Room

The rooms details

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
    }
  ]
}

Create a new room

POSThttps://api.sariska.io/api/v1/messaging/rooms/create

Body

Room parameters

allowed_user_idsarray of string

Allowed User IDs

channel_id*string

Create Channel

statusstring

Room status

Response

Room response

Body

roomany of

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "allowed_user_ids": [
        "user_1_id",
        "user_2_id"
      ],
      "channel_id": "room123",
      "status": "active"
    }),
});
const data = await response.json();

Response

{
  "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"
  }
}

Find a room by channel ID

GEThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}

Path parameters

channel_id*string

Channel ID

Example: "channel123"

Response

Room response

Body

roomany of

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  }
}

Get messages in a channel

GEThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages

Path parameters

channel_id*string

Channel ID

Example: "channel123"

Query parameters

Response

Message response

Body

contentstring

Message content

created_bystring

User ID who created the message

created_by_namestring

User name who created the message

idinteger

Message ID

inserted_atstring (date-time)

Insertion timestamp

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Delete messages

DELETEhttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages

Path parameters

channel_id*string

Channel ID

Example: "channel123"

Body

Delete replies for a message

is_emptyboolean

If true, delete all messages in the channel

message_idsarray of integer

list of messages ids to delete

Response

Message replies deleted successfully

Body

messagestring

Message deleted successfully

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "is_empty": true,
      "message_ids": [
        1000,
        1001
      ]
    }),
});
const data = await response.json();

Response

{
  "message": "Message deleted successfully"
}

Search messages in a channel

GEThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/search

Path parameters

channel_id*string

Channel ID

Example: "channel123"

Query parameters

Response

Message response

Body

contentstring

Message content

created_bystring

User ID who created the message

created_by_namestring

User name who created the message

idinteger

Message ID

inserted_atstring (date-time)

Insertion timestamp

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get a single message

GEThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}

Path parameters

channel_id*string

Channel ID

Example: "channel123"

message_id*integer

Message ID

Example: 1001

Response

Message response

Body

contentstring

Message content

created_bystring

User ID who created the message

created_by_namestring

User name who created the message

idinteger

Message ID

inserted_atstring (date-time)

Insertion timestamp

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Edit a message

PUThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}

Path parameters

channel_id*string

Channel ID

Example: "channel123"

message_id*integer

Message ID

Example: 1001

Body

Edit message

contentstring

New content for the message

Response

Message response

Body

contentstring

Message content

created_bystring

User ID who created the message

created_by_namestring

User name who created the message

idinteger

Message ID

inserted_atstring (date-time)

Insertion timestamp

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "content": "Updated content"
    }),
});
const data = await response.json();

Response

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

Get replies for a message

GEThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/messages_replies

Path parameters

channel_id*string

Channel ID

Example: "channel123"

message_id*integer

Message ID

Example: 1001

Query parameters

Response

Message response with replies

Body

contentstring

Message content

created_bystring

User ID who created the message

created_by_namestring

User name who created the message

idinteger

Message ID

inserted_atstring (date-time)

Insertion timestamp

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/messages_replies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Delete replies for a message

DELETEhttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/messages_replies

Path parameters

channel_id*string

Channel ID

Example: "channel123"

message_id*integer

Message ID

Example: 1001

Body

Delete replies for a message

reply_message_idsarray of integer

List of reply message IDs to delete

Response

Message replies deleted successfully

Body

messagestring

Message deleted successfully

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/messages_replies', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "reply_message_ids": [
        1000,
        1002
      ]
    }),
});
const data = await response.json();

Response

{
  "message": "Message deleted successfully"
}

Check if the current user has voted for a poll

GEThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/poll/is_voted

Path parameters

channel_id*string

Channel ID

Example: "channel123"

message_id*integer

Message ID

Example: 1001

Response

Is voted response

Body

is_votedboolean

Flag indicating whether the user has voted

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/poll/is_voted', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "is_voted": true
}

Get total votes for a poll

GEThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/poll/votes

Path parameters

channel_id*string

Channel ID

Example: "channel123"

message_id*integer

Message ID

Example: 1001

Response

Total votes response

Body

votesarray of PollAnswer

List of user votes

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/poll/votes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Update a user's answer for a poll

POSThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/poll/{poll_option_id}

Path parameters

channel_id*string

Channel ID

Example: "channel123"

message_id*integer

Message ID

Example: 1001

poll_option_id*integer

Poll Option ID

Example: 1

Response

Poll answer response

Body

poll_answerany of

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/messages/{message_id}/poll/{poll_option_id}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

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

Get details of a user in a room

GEThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/users/{user_id}

Path parameters

channel_id*string

Channel ID

Example: "channel123"

user_id*string

User ID

Example: 1001

Response

User response

Body

userany of

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/users/{user_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Add a user to a room

POSThttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/users/{user_id}

Path parameters

channel_id*string

Channel ID

Example: "channel123"

user_id*string

User ID

Example: 1001

Response

Room response

Body

roomany of

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/users/{user_id}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  }
}

Delete a user from a room

DELETEhttps://api.sariska.io/api/v1/messaging/rooms/{channel_id}/users/{user_id}

Path parameters

channel_id*string

Channel ID

Example: "channel123"

user_id*string

User ID

Example: 1001

Response

Room response

Body

roomany of

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/rooms/{channel_id}/users/{user_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  }
}

Search for user in rooms within an organization

GEThttps://api.sariska.io/api/v1/messaging/users/search

Query parameters

Response

Users response

Body

usersarray of User

List of users

Request

const response = await fetch('https://api.sariska.io/api/v1/messaging/users/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Generate Token

Generate a JWT token based on provided parameters.

POSThttps://api.sariska.io/api/v1/misc/generate-token

Body

API Key

apiKey*string

API key tied to the Sariska account

expstring

Exp claim of JWT token

nbfstring

Nbf claim of JWT token

scopestring

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

userobject

User information

Response

Token generated successfully

Body

tokenstring

Generated JWT token

Request

const response = await fetch('https://api.sariska.io/api/v1/misc/generate-token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "apiKey": "iufwenufewifweifiuTbddhbdjhjfbjfjwfjwfj",
      "exp": "24 hours",
      "nbf": "",
      "scope": "messaging",
      "user": {
        "avatar": "https://some-storage-location/nick.jpg",
        "email": "nick@gmail.com",
        "id": "ytyVgh",
        "moderator": false,
        "name": "Nick"
      }
    }),
});
const data = await response.json();

Response

{
  "token": "your_generated_token_here"
}

Get S3 presigned

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

POSThttps://api.sariska.io/api/v1/misc/get-presigned

Body

Get presigned parameters

fileNamestring

File name

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

fileTypestring

File extension

Example: "jpeg"

Response

Presigned URL generated successfully

Body

presigned_urlstring

presigned url

Example: "url"

Request

const response = await fetch('https://api.sariska.io/api/v1/misc/get-presigned', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fileName": "some-s3-folder/file-name.jpeg",
      "fileType": "jpeg"
    }),
});
const data = await response.json();

Response

{
  "presigned_url": "url"
}

Get all users in a room

GEThttps://api.sariska.io/api/v1/rooms/{channel_id}/users

Path parameters

channel_id*string

Channel ID

Example: "channel123"

Response

Users response

Body

usersarray of User

List of users

Request

const response = await fetch('https://api.sariska.io/api/v1/rooms/{channel_id}/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

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

Last updated 7 months ago