logo
API docs by Redocly

Messenger API specification (02c48c66a7d6bde4827685eb596c2d8e5fbd0c03)

Download OpenAPI specification:Download

The chat service manages chatrooms for our mobile messenger app.

chatroom

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
{
  • "assignedUsers": [
    ],
  • "avatarURL": "string",
  • "eventID": 0,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "scheduledDeletion": null,
  • "type": "string"
}

chatrooms

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

Authorizations:
API_TokenPersonal-Access-Token
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.

Authorizations:
API_TokenPersonal-Access-Token
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.

Authorizations:
API_TokenPersonal-Access-Token
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.

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
{
  • "assignedUsers": [
    ],
  • "avatarURL": "string",
  • "eventID": 0,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "scheduledDeletion": null,
  • "type": "string"
}

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
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.

Authorizations:
API_TokenPersonal-Access-Token
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.

Authorizations:
API_TokenPersonal-Access-Token
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.

Authorizations:
API_TokenPersonal-Access-Token
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"
}