Messenger API specification (9e074e34355a5facbece3910d74e59e0e26c61fd)

Download OpenAPI specification:Download

The chat service manages chatrooms for our mobile messenger app.

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security Scheme Type API Key
Header parameter name: API-TOKEN

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security Scheme Type API Key
Header parameter name: Personal-Access-Token

chatrooms

Returns either a paginated list of all organization chatrooms or a complete list of all assigned chatrooms for a user.

query Parameters
organization_id
integer

optional organization id, returns all chatrooms for the organization if set

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.

Request Body schema: application/json
assignedUsers
Array of integers <int64> [ items <int64 > ]
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "assignedUsers": [
    ],
  • "name": "string",
  • "organizationID": 0
}

Response samples

Content type
application/json
{
  • "assignedUsers": [
    ],
  • "avatarURL": "string",
  • "eventID": 0,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "scheduledDeletion": null,
  • "type": "string"
}

Creates the default chatroom for an organization.

path Parameters
organizationID
required
integer

id of the organization

Responses

Response samples

Content type
application/json
{
  • "assignedUsers": [
    ],
  • "avatarURL": "string",
  • "eventID": 0,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "scheduledDeletion": null,
  • "type": "string"
}

Removes the default chatroom for an organization.

path Parameters
organizationID
required
integer

id of the organization

Responses

Returns a specific chatroom.

path Parameters
roomID
required
integer

unique identifier of the chatroom

Responses

Response samples

Content type
application/json
{
  • "assignedUsers": [
    ],
  • "avatarURL": "string",
  • "eventID": 0,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "scheduledDeletion": null,
  • "type": "string"
}

Updates an existing custom chatroom for an organization.

path Parameters
roomID
required
integer

unique identifier of the chatroom

Request Body schema: application/json
assignedUsers
Array of integers <int64> [ items <int64 > ]
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "assignedUsers": [
    ],
  • "name": "string",
  • "organizationID": 0
}

Deletes an existing custom chatroom for an organization.

path Parameters
roomID
required
integer

unique identifier of the chatroom

Responses

Sets a new avatar for an existing custom chatroom for an organization.

Send an empty body to remove the avatar.

path Parameters
roomID
required
integer

unique identifier of the chatroom

Request Body schema: application/json
string <binary>

Responses

Request samples

Content type
application/json
"string"

Sends a text message to a chatroom.

path Parameters
roomID
required
integer

unique identifier of the chatroom

Request Body schema: application/json
message
string

Responses

Request samples

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