Call API specification (3.7.0)

Download OpenAPI specification:Download

The call service implements all call functions for GroupAlarm

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

alarming

ListConfigurations

Returns all call-alarming configurations

query Parameters
organization_id
required
int64

requesting organization

Responses

200

call-alarming configurations for given organization

400

organizationID is missing or in wrong format

500

Unexpected database error

get /alarming
https://app.groupalarm.com/api/v1/call/alarming

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

UpdateConfiguration

Updates an existing call-alarming configuration

Request Body schema: application/json

updated call-alarming configuration

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

Responses

200

updated call-alarming configuration

400

payload is missing or invalid

500

Unexpected database error

put /alarming
https://app.groupalarm.com/api/v1/call/alarming

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "alarmTemplateID": 0,
  • "gsm": "string",
  • "id": 0,
  • "organizationID": 0,
  • "pin": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "alarmTemplateID": 0,
  • "gsm": "string",
  • "id": 0,
  • "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>
organizationID
integer <int64>
pin
string

Responses

200

newly created call-alarming configuration

400

payload is missing or invalid

500

Unexpected database error

post /alarming
https://app.groupalarm.com/api/v1/call/alarming

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "alarmTemplateID": 0,
  • "gsm": "string",
  • "id": 0,
  • "organizationID": 0,
  • "pin": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "alarmTemplateID": 0,
  • "gsm": "string",
  • "id": 0,
  • "organizationID": 0,
  • "pin": "string"
}

DeleteConfiguration

Deletes an existing call-alarming configuration

path Parameters
configurationID
required
int64

ID of an existing call-alarming configuration

Responses

200

deleted call-alarming configuration

400

payload is missing or invalid

500

Unexpected database error

delete /alarming/{configurationID}
https://app.groupalarm.com/api/v1/call/alarming/{configurationID}

organizations

GetDisabledOrganization

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

query Parameters
organization_id
required
int64

requesting organization

Responses

200

whether this way of alarming is disabled or not

400

organization_id is missing or in wrong format

500

Unexpected database error

get /disabled
https://app.groupalarm.com/api/v1/call/disabled

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

SetDisabledOrganization

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

query Parameters
organization_id
required
int64

requesting organization

Request Body schema: application/json

isDisabled payload

isDisabled
boolean

Responses

200

request successful

400

organization_id is missing or in wrong format

500

Unexpected database error

put /disabled
https://app.groupalarm.com/api/v1/call/disabled

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "isDisabled": true
}

phone

List

Returns all phone numbers for queried owner

query Parameters
owner_id
required
int64

requested owner by using his user ID

organization_id
int64

requesting organization, not required if user accesses his own resources

Responses

200

phone configurations for passed user

400

owner ID is missing or in wrong format

500

Unexpected database error

get /phone
https://app.groupalarm.com/api/v1/call/phone

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Create

Create a phone configuration for specific user

query Parameters
organization_id
int64

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 +)

name
string

user defined name for this configuration

ownerID
integer <int64>

user id, who owns this configuration

Responses

200

created phone configuration

400

phone configuration payload is missing or in wrong format

500

Unexpected database error

post /phone
https://app.groupalarm.com/api/v1/call/phone

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "active": true,
  • "gsm": "string",
  • "name": "string",
  • "ownerID": 0
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "active": true,
  • "gsm": "string",
  • "name": "string",
  • "ownerID": 0
}

Update

Updates an existing phone configuration

query Parameters
phoneID
required
int64

ID of an existing phone configuration

organization_id
int64

requesting organization, not required if user accesses his own resources

Responses

200

update phone configuration

400

phone configuration payload is missing or in wrong format

500

Unexpected database error

put /phone/{phoneID}
https://app.groupalarm.com/api/v1/call/phone/{phoneID}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "active": true,
  • "gsm": "string",
  • "name": "string",
  • "ownerID": 0
}

Delete

Delete an existing phone configuration

query Parameters
phoneID
required
int64

ID of an existing phone configuration

organization_id
int64

requesting organization, not required if user accesses his own resources

Responses

200

update phone configuration

400

passed phone ID is missing or in wrong format

500

Unexpected database error

delete /phone/{phoneID}
https://app.groupalarm.com/api/v1/call/phone/{phoneID}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "status": "deleted"
}

Get

Gets a phone configuration

path Parameters
phoneID
required
int64

ID of a phone configuration

query Parameters
organization_id
int64

requesting organization, not required if user accesses his own resources

Responses

200

requested phone configuration

500

Unexpected database error

get /{phoneID}
https://app.groupalarm.com/api/v1/call/{phoneID}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "active": true,
  • "gsm": "string",
  • "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
int64

id of the user

organization_id
required
int64

id of the organization

Responses

200

contains the information if any device is active for the passed user

400

organization_id or user_id is missing or in wrong format

500

Unexpected database error

get /phones/any-active
https://app.groupalarm.com/api/v1/call/phones/any-active

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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
int64

ID of an organization

user_id
int64

ID of an user in this organization

Responses

200

true/false if there is any permission configured for the search query

400

id of organization is missing or either id of the organization or user in wrong format

500

Unexpected database error

get /user-permissions
https://app.groupalarm.com/api/v1/call/user-permissions

CreatePermission

Creates a user permission with the passed organizationID and userID for this device

Request Body schema: application/json

permission configuration with user and organization id

organizationID
integer <int64>
userID
integer <int64>

Responses

201

permission was created successfully and is active

400

id of organization or user is missing in wrong format

500

Unexpected database error

post /user-permissions
https://app.groupalarm.com/api/v1/call/user-permissions

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "organizationID": 0,
  • "userID": 0
}

DeletePermission

Removes a configured user permission for this device

path Parameters
organizationID
required
int64

ID of an organization

userID
required
int64

ID of an user in this organization

Responses

200

permission was removed successfully

400

id of organization or user is missing in wrong format

500

Unexpected database error

delete /user-permissions/{organizationID}/{userID}
https://app.groupalarm.com/api/v1/call/user-permissions/{organizationID}/{userID}