logo
API docs by Redocly

Messenger API specification (b63bb6ce8c40f3cf1cc7029b2610c7e8d99a9953)

Download OpenAPI specification:

The chat service manages chatrooms for our mobile messenger app.

chatrooms

Returns a specific chatroom searched by eventID in a specific organization.

Authorizations:
API-TOKENPersonal-Access-Token
query Parameters
organization_id
required
integer

id of an organization the chatroom belongs to

event_id
required
integer

id of an organization the chatroom belongs to

Responses

Response samples

Content type
application/json
{
  • "admins": [
    ],
  • "assignedUsers": [
    ],
  • "automationEnabled": true,
  • "avatarURL": "string",
  • "eventID": 0,
  • "matrixRoomID": "string",
  • "moderators": [
    ],
  • "name": "string",
  • "organizationID": 0,
  • "scheduledDeletion": null,
  • "type": "string"
}

GetRooms

Returns a paginated list of all organization chatrooms

Authorizations:
API-TOKENPersonal-Access-Token
query Parameters
organization_id
required
integer

id of the organization

all
boolean
Default: false

returns all entries, ignoring limit and offset parameters

limit
integer [ 1 .. 50 ]
Default: 10

max. amount of chatrooms in paginated list

offset
integer
Default: 0

skipped chatrooms in paginated list

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0
}

Creates a new custom chatroom for an organization.

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required
admins
Array of integers <int64> [ items <int64 > ]
assignedUsers
Array of integers <int64> [ items <int64 > ]
automationEnabled
boolean
avatar
Array of integers <uint8> [ items <uint8 > ]
moderators
Array of integers <int64> [ items <int64 > ]
name
string
organizationID
integer <int64>
scheduledDeletion
any

Responses

Request samples

Content type
application/json
{
  • "admins": [
    ],
  • "assignedUsers": [
    ],
  • "automationEnabled": true,
  • "avatar": [
    ],
  • "moderators": [
    ],
  • "name": "string",
  • "organizationID": 0,
  • "scheduledDeletion": null
}

Response samples

Content type
application/json
{
  • "admins": [
    ],
  • "assignedUsers": [
    ],
  • "automationEnabled": true,
  • "avatarURL": "string",
  • "eventID": 0,
  • "matrixRoomID": "string",
  • "moderators": [
    ],
  • "name": "string",
  • "organizationID": 0,
  • "scheduledDeletion": null,
  • "type": "string"
}

Creates the default chatroom for an organization.

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required
automationEnabled
boolean
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "automationEnabled": true,
  • "organizationID": 0
}

Response samples

Content type
application/json
{
  • "admins": [
    ],
  • "assignedUsers": [
    ],
  • "automationEnabled": true,
  • "avatarURL": "string",
  • "eventID": 0,
  • "matrixRoomID": "string",
  • "moderators": [
    ],
  • "name": "string",
  • "organizationID": 0,
  • "scheduledDeletion": null,
  • "type": "string"
}

Removes the default chatroom for an organization.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
organizationID
required
integer

id of the organization

Responses

Returns a specific chatroom.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
roomID
required
integer

unique identifier of the chatroom

Responses

Response samples

Content type
application/json
{
  • "admins": [
    ],
  • "assignedUsers": [
    ],
  • "automationEnabled": true,
  • "avatarURL": "string",
  • "eventID": 0,
  • "matrixRoomID": "string",
  • "moderators": [
    ],
  • "name": "string",
  • "organizationID": 0,
  • "scheduledDeletion": null,
  • "type": "string"
}

Deletes an existing custom chatroom for an organization.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
roomID
required
integer

unique identifier of the chatroom

Responses

Updates an existing custom chatroom for an organization.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
roomID
required
integer

unique identifier of the chatroom

Request Body schema: application/json
required
automationEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "automationEnabled": true
}

Claims a chatroom for the user.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
roomID
required
string

unique identifier of the chatroom

Responses

Adds users to a chatroom.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
roomID
required
integer

unique identifier of the chatroom

Request Body schema: application/json
required
admins
Array of integers <int64> [ items <int64 > ]
assignedUsers
Array of integers <int64> [ items <int64 > ]
moderators
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "admins": [
    ],
  • "assignedUsers": [
    ],
  • "moderators": [
    ]
}

user

GetCredentials

Get credentials for Matrix

Authorizations:
API-TOKENPersonal-Access-Token

Responses

Response samples

Content type
application/json
{
  • "password": "string",
  • "username": "string"
}

Login

Login to Matrix

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required
deviceID
string

Responses

Request samples

Content type
application/json
{
  • "deviceID": "string"
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "deviceID": "string",
  • "expiresInMS": 0,
  • "refreshToken": "string",
  • "userID": "string",
  • "wellKnown": {
    }
}