logo
Documentation Powered by ReDoc

SMS API specification (3.7.2)

Download OpenAPI specification:Download

The sms service implements all sms 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 sms-alarming configurations

query Parameters
organization_id
required
int64

requesting organization

Responses

200

sms-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/sms/alarming

Response samples

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

UpdateConfiguration

Updates an existing sms-alarming configuration

Request Body schema: application/json

updated sms-alarming configuration

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

Responses

200

updated sms-alarming configuration

400

payload is missing or invalid

500

Unexpected database error

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

Request samples

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

Response samples

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

CreateConfiguration

Creates a new sms-alarming configuration

Request Body schema: application/json

new sms-alarming configuration

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

Responses

200

newly created sms-alarming configuration

400

payload is missing or invalid

500

Unexpected database error

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

Request samples

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

Response samples

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

DeleteConfiguration

Deletes an existing sms-alarming configuration

path Parameters
configurationID
required
int64

ID of an existing sms-alarming configuration

Responses

200

deleted sms-alarming configuration

400

payload is missing or invalid

500

Unexpected database error

delete /alarming/{configurationID}
https://app.groupalarm.com/api/v1/sms/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/sms/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/sms/disabled

Request samples

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

text-formatter

GetTextFormatter

Returns the current text formatter of the given organization

query Parameters
organization
required
int64

requested organization

Responses

200

organization's text formatter

400

organization is missing or in wrong format

500

unexpected error

get /formatter
https://app.groupalarm.com/api/v1/sms/formatter

Response samples

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

SetTextFormatter

Sets the given organization's text formatter

Request Body schema: application/json

organization and it's text formatter settings

organizationID
integer <int64>
textFormatterName
string

Responses

200

request successful

400

request body is missing or in wrong format

500

unexpected error

put /formatter
https://app.groupalarm.com/api/v1/sms/formatter

Request samples

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

gsm

List

Returns all gsm 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

mobile configurations for passed user

400

owner ID is missing or in wrong format

500

Unexpected database error

get /mobile
https://app.groupalarm.com/api/v1/sms/mobile

Response samples

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

Update

Updates an existing gsm configuration

query Parameters
organization_id
int64

requesting organization, not required if user accesses his own resources

Request Body schema: application/json

mobile configuration payload

active
boolean

true, if this configuration can be used for alarm notifications

gsm
string

gsm number for alarm notifications with sms (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

update mobile configuration

400

mobile configuration payload is missing or in wrong format

500

Unexpected database error

put /mobile
https://app.groupalarm.com/api/v1/sms/mobile

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
}

Create

Create a gsm configuration for specific user

query Parameters
organization_id
int64

requesting organization, not required if user accesses his own resources

Request Body schema: application/json

mobile configuration payload

active
boolean

true, if this configuration can be used for alarm notifications

gsm
string

gsm number for alarm notifications with sms (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 mobile configuration

400

mobile configuration payload is missing or in wrong format

500

Unexpected database error

post /mobile
https://app.groupalarm.com/api/v1/sms/mobile

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
}

Delete

Delete an existing gsm configuration

query Parameters
mobileID
required
int64

ID of an existing mobile configuration

organization_id
int64

requesting organization, not required if user accesses his own resources

Responses

200

update mobile configuration

400

passed mobile ID is missing or in wrong format

500

Unexpected database error

delete /mobile/{mobileID}
https://app.groupalarm.com/api/v1/sms/mobile/{mobileID}

Response samples

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

List

Returns an gsm number configuration

query Parameters
mobileID
required
int64

ID of an gsm configuration

organization_id
int64

requesting organization, not required if user accesses his own resources

Responses

200

requested mobile configuration

400

ID is missing or in wrong format

500

Unexpected database error

get /{mobileID}
https://app.groupalarm.com/api/v1/sms/{mobileID}

Response samples

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

mobiles

AnyActive

Check if any gsm 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 /mobiles/any-active
https://app.groupalarm.com/api/v1/sms/mobiles/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 permissions 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 permissions 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/sms/user-permissions

CreatePermission

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

Request Body schema: application/json

restriction 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

403

a restriction can only be configured if this device is globally disabled for the current organization

500

Unexpected database error

post /user-permissions
https://app.groupalarm.com/api/v1/sms/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

restriction 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/sms/user-permissions/{organizationID}/{userID}