logo
Documentation Powered by Redocly

Call API specification (887cf3d4f37487346e33ee5d2c4aee5e8f74aa6e)

Download OpenAPI specification:Download

The call service implements all call functions for GroupAlarm

Authentication

API_Token

You can generate an API-Token in the permissions-settings of your organization. All requests will be performed in the scope of this organization. Requests regarding users will fail.

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

Personal-Access-Token

You can generate a Personal Access Token in your profile settings. All requests will be performed as the user who created the token, with permissions as configured in each organization.

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

alarming

ListConfigurations

Returns all call-alarming configurations

query Parameters
organization_id
required
integer

requesting organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

UpdateConfiguration

Updates an existing call-alarming configuration

Request Body schema: application/json

updated call-alarming configuration

alarmTemplateID
integer <int64>
gsm
string
id
integer <int64>
name
string
organizationID
integer <int64>
pin
string

Responses

Request samples

Content type
application/json
{
  • "alarmTemplateID": 0,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pin": "string"
}

Response samples

Content type
application/json
{
  • "alarmTemplateID": 0,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pin": "string"
}

CreateConfiguration

Creates a new call-alarming configuration

Request Body schema: application/json

new call-alarming configuration

alarmTemplateID
integer <int64>
gsm
string
id
integer <int64>
name
string
organizationID
integer <int64>
pin
string

Responses

Request samples

Content type
application/json
{
  • "alarmTemplateID": 0,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pin": "string"
}

Response samples

Content type
application/json
{
  • "alarmTemplateID": 0,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pin": "string"
}

DeleteConfiguration

Deletes an existing call-alarming configuration

path Parameters
configurationID
required
integer

ID of an existing call-alarming configuration

Responses

organizations

GetDisabledOrganization

Returns whether the given organization has disabled this way of alarming or not

query Parameters
organization_id
required
integer

requesting organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SetDisabledOrganization

Sets whether the given organization has this way of alarming disabled or not

query Parameters
organization_id
required
integer

requesting organization

Request Body schema: application/json

isDisabled payload

isDisabled
boolean

Responses

Request samples

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

phone

List

Returns all phone numbers for queried owner

query Parameters
owner_id
required
integer

requested owner by using his user ID

organization_id
integer

requesting organization, not required if user accesses his own resources

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create

Create a phone configuration for specific user

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Request Body schema: application/json

phone configuration payload

active
boolean

true, if this configuration can be used for alarm notifications

gsm
string

gsm number for calls (E.164-format with 00 instead of +)

id
integer <int64>

id for this configuration

name
string

user defined name for this configuration

ownerID
integer <int64>

user id, who owns this configuration

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Response samples

Content type
application/json
{
  • "active": true,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Update

Updates an existing phone configuration

path Parameters
phoneID
required
integer

ID of an existing phone configuration

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Delete

Delete an existing phone configuration

path Parameters
phoneID
required
integer

ID of an existing phone configuration

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Responses

Response samples

Content type
application/json
{
  • "status": "deleted"
}

Get

Gets a phone configuration

path Parameters
phoneID
required
integer

ID of a phone configuration

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

phones

AnyActive

Check if any device is active for the passed owner id in the passed organization id

query Parameters
user_id
required
integer

id of the user

organization_id
required
integer

id of the organization

Responses

Response samples

Content type
application/json
{
  • "activeCount": 0,
  • "anyActive": true
}

user-permissions

GetPermission

Returns true if there is an active permission for the passed organization or specifically for the passed user in an organization.

query Parameters
organization_id
required
integer

ID of an organization

user_id
integer

optional ID of a user in this organization

Responses

Allows a specific user in a specific organization to use this service's alarming-type.

Request Body schema: application/json

restriction configuration with user and organization id

organizationID
integer <int64>
userID
integer <int64>

Responses

Request samples

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

Removes a specific user's permission to use this service's alarming-type in an organization.

path Parameters
organizationID
required
integer

ID of an organization

userID
required
integer

ID of a user in this organization

Responses