logo
API docs by Redocly

Messaging API specification (8ebcfaccdf2ae5c903057909249ae4dd2311d0dd)

Download OpenAPI specification:Download

The message service is used to manage messages.

user

SetUserEscalation

Creates or updates an existing escalation configuration for the passed user

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

new escalation configuration

required
Array of objects (Escalation)

configured escalations

organizationID
integer <int64>

organization id for editing escalation as an organization administrator

userID
integer <int64>

assigned user for this escalation configuration for organization administrator editing

Responses

Request samples

Content type
application/json
{
  • "escalations": [
    ],
  • "organizationID": 0,
  • "userID": 0
}

Response samples

Content type
application/json
{
  • "message": "escalation saved"
}

GetUserEscalation

Returns the escalation configuration for the passed user

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
userID
required
integer

user id for the requested escalation

query Parameters
organization_id
integer

has to be set if you want to edit a user as admin of an organization

Responses

Response samples

Content type
application/json
{
  • "escalations": [
    ],
  • "organizationID": 0,
  • "userID": 0
}

escalation

SetOrganizationEscalation

Sets the escalation configuration for the given organization

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

new escalation configuration

required
Array of objects (Escalation)

configured escalations

organizationID
integer <int64>

organization id for editing escalation as an organization administrator

userID
integer <int64>

assigned user for this escalation configuration for organization administrator editing

Responses

Request samples

Content type
application/json
{
  • "escalations": [
    ],
  • "organizationID": 0,
  • "userID": 0
}

GetOrganizationEscalation

Returns the escalation configuration for the given organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

organizationID for the requested escalation

Responses

Response samples

Content type
application/json
{
  • "escalations": [
    ],
  • "organizationID": 0,
  • "userID": 0
}

RemoveOrganizationEscalation

Removes the escalation configuration for the given organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

organizationID for the requested escalation

Responses

Response samples

Content type
application/json
{
  • "escalations": [
    ],
  • "organizationID": 0,
  • "userID": 0
}

alarm

GetAlarmMessageStatus

Returns the current alarm message status for the user in the given alarm

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
alarm_id
required
integer

alarmID this request is about

query Parameters
organization_id
required
integer

associated organization requesting the information (used for rbac-check)

user_id
required
integer

requested user status

Responses

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

feedback

Sets the user feedback for a specific alarm or organization using the api.

You can use a JWT Token or Personal Access Token to update a specific user's feedback in an alarm or organization. You can also use an organization api token to update any user's feedback in an alarm or your organization.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

the users feedback

alarmID
integer <int64>

AlarmID associated to the feedback

organizationID
integer <int64>

OrganizationID associated to the feedback

response
required
boolean

Response should be true if the user gave positive feedback and false if not

userID
required
integer <int64>

UserID of the user that is sending this feedback

Responses

Request samples

Content type
application/json
{
  • "alarmID": 0,
  • "organizationID": 0,
  • "response": true,
  • "userID": 0
}

Response samples

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

organization

Returns the response-timeout after which a notified user times out and can no longer answer an alarm in the organization.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

Responses

Response samples

Content type
application/json
{
  • "timeout": 10
}

Sets the response-timeout after which a notified user times out and can no longer answer an alarm in the organization.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer
Request Body schema: application/json
required

organization timeout configuration

timeout
required
integer <int64> [ 10 .. 86400 ]

Time in seconds after which a notified user times out and can no longer answer an alarm.

Responses

Request samples

Content type
application/json
{
  • "timeout": 10
}

Response samples

Content type
application/json
{
  • "timeout": 10
}