Arvia API (1.0.0)

Download OpenAPI specification:Download

Arvia RESTful APIs

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

cookieAuth

Security Scheme Type API Key
Cookie parameter name: token

Security

Login

Login

Login and get a token.

Request Body schema: application/json
email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@arvia.chat",
  • "password": ""
}

Response samples

Content type
application/json
{
  • "auth": true,
  • "token": "string",
  • "name": "string",
  • "image": "string",
  • "status": "away"
}

Rooms

Create, Get, Update, Delete Rooms

Creates a room

Creates a new room and returns the room details

Authorizations:
Request Body schema: application/json
_id
required
string
name
required
string
display
string
date
string

Responses

Request samples

Content type
application/json
{
  • "_id": "5ed3ffc8bccb2989c1e08907",
  • "name": "my-room-name",
  • "display": "My Room Name",
  • "date": "2016-08-29T09:12:33.001Z"
}

Response samples

Content type
application/json
{
  • "_id": "5ed3ffc8bccb2989c1e08907",
  • "name": "my-room-name",
  • "display": "My Room Name",
  • "date": "2016-08-29T09:12:33.001Z"
}

Gets rooms in the project

By passing project id, you can get list of the rooms in a project.

Authorizations:
query Parameters
projectId
required
string

Pass project ID for looking for the rooms.

skip
integer >= 0

Number of records to skip for pagination

limit
integer [ 0 .. 50 ]

Maximum number of records to return

Responses

Request samples

curl --request GET \
  --url 'https://arvia.chat/api/rooms?projectId=SOME_STRING_VALUE&skip=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
  • {
    }
]

Gets room details

Gets details of the room by passing the room ID

Authorizations:
path Parameters
roomId
required
string

The room ID.

Responses

Request samples

curl --request GET \
  --url https://arvia.chat/api/rooms/%7BroomId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
  • "_id": "5ed3e53fec337e89b3e50ac3",
  • "name": "my-room-name",
  • "display": "My Room Name",
  • "date": "2016-08-29T09:12:33.001Z",
  • "locked": true,
  • "maxUser": 2,
  • "maxVideo": 2,
  • "maxAudio": 2,
  • "agents": [
    ],
  • "admins": [
    ],
  • "analysts": [
    ]
}

Updates the room

Updates room details

Authorizations:
path Parameters
roomId
required
string

The room ID.

Request Body schema: application/json
_id
required
string
name
required
string
display
required
string
date
string
locked
boolean
maxUser
integer
maxVideo
integer
maxAudio
integer
Array of objects
Array of objects
Array of objects

Responses

Request samples

Content type
application/json