Messaging API specification (30fb6ef986eaef0b440bfa05d94abcd552e4d75e)
Download OpenAPI specification:
The message service is used to manage messages.
SetUserEscalation
Creates or updates an existing escalation configuration for the passed user
Authorizations:
Request Body schema: application/jsonrequired
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
- Payload
{- "escalations": [
- {
- "delay": 0,
- "wayofalarm": "string"
}
], - "organizationID": 0,
- "userID": 0
}Response samples
- 200
{- "message": "escalation saved"
}GetUserEscalation
Returns the escalation configuration for the passed user
Authorizations:
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
- 200
{- "escalations": [
- {
- "delay": 0,
- "wayofalarm": "string"
}
], - "organizationID": 0,
- "userID": 0
}SetOrganizationEscalation
Sets the escalation configuration for the given organization
Authorizations:
Request Body schema: application/jsonrequired
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
- Payload
{- "escalations": [
- {
- "delay": 0,
- "wayofalarm": "string"
}
], - "organizationID": 0,
- "userID": 0
}GetOrganizationEscalation
Returns the escalation configuration for the given organization
Authorizations:
path Parameters
| organizationID required | integer organizationID for the requested escalation |
Responses
Response samples
- 200
{- "escalations": [
- {
- "delay": 0,
- "wayofalarm": "string"
}
], - "organizationID": 0,
- "userID": 0
}RemoveOrganizationEscalation
Removes the escalation configuration for the given organization
Authorizations:
path Parameters
| organizationID required | integer organizationID for the requested escalation |
Responses
Response samples
- 200
{- "escalations": [
- {
- "delay": 0,
- "wayofalarm": "string"
}
], - "organizationID": 0,
- "userID": 0
}GetAlarmMessageStatus
Returns the status of each alarmed device for the user in the alarm
Authorizations:
path Parameters
| alarm_id required | integer ID of the alarm |
query Parameters
| user_id required | integer ID of the user |
Responses
Response samples
- 200
{- "devices": [
- {
- "date": null,
- "name": "string",
- "noDate": null,
- "status": 0,
- "type": "string",
- "yesDate": null
}
]
}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:
Request Body schema: application/jsonrequired
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 |
| userID required | integer <int64> UserID of the user that is sending this feedback |
Responses
Request samples
- Payload
{- "alarmID": 0,
- "organizationID": 0,
- "response": true,
- "userID": 0
}Response samples
- 200
{- "success": true
}Sets the response-timeout after which a notified user times out and can no longer answer an alarm in the organization.
Authorizations:
path Parameters
| organizationID required | integer |
Request Body schema: application/jsonrequired
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
- Payload
{- "timeout": 10
}Response samples
- 200
{- "timeout": 10
}