Download OpenAPI specification:Download
The sms service implements all sms functions for GroupAlarm
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 |
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 |
Returns all sms-alarming configurations
organization_id required | int64 requesting organization |
sms-alarming configurations for given organization
organizationID is missing or in wrong format
Unexpected database error
[- {
- "gsm": "string",
- "id": 0,
- "organizationID": 0,
- "pin": "string"
}
]
Updates an existing sms-alarming configuration
updated sms-alarming configuration
gsm | string |
id | integer <int64> |
organizationID | integer <int64> |
pin | string |
updated sms-alarming configuration
payload is missing or invalid
Unexpected database error
{- "gsm": "string",
- "id": 0,
- "organizationID": 0,
- "pin": "string"
}
{- "gsm": "string",
- "id": 0,
- "organizationID": 0,
- "pin": "string"
}
Creates a new sms-alarming configuration
new sms-alarming configuration
gsm | string |
id | integer <int64> |
organizationID | integer <int64> |
pin | string |
newly created sms-alarming configuration
payload is missing or invalid
Unexpected database error
{- "gsm": "string",
- "id": 0,
- "organizationID": 0,
- "pin": "string"
}
{- "gsm": "string",
- "id": 0,
- "organizationID": 0,
- "pin": "string"
}
Deletes an existing sms-alarming configuration
configurationID required | int64 ID of an existing sms-alarming configuration |
deleted sms-alarming configuration
payload is missing or invalid
Unexpected database error
Returns whether the given organization has disabled this way of alarming or not
organization_id required | int64 requesting organization |
whether this way of alarming is disabled or not
organization_id is missing or in wrong format
Unexpected database error
[- {
- "isDisabled": true
}
]
Sets whether the given organization has this way of alarming disabled or not
organization_id required | int64 requesting organization |
isDisabled payload
isDisabled | boolean |
request successful
organization_id is missing or in wrong format
Unexpected database error
{- "isDisabled": true
}
Returns the current text formatter of the given organization
organization required | int64 requested organization |
organization's text formatter
organization is missing or in wrong format
unexpected error
{- "organizationID": 0,
- "textFormatterName": "string"
}
Sets the given organization's text formatter
organization and it's text formatter settings
organizationID | integer <int64> |
textFormatterName | string |
request successful
request body is missing or in wrong format
unexpected error
{- "organizationID": 0,
- "textFormatterName": "string"
}
Returns all gsm numbers for queried owner
owner_id required | int64 requested owner by using his user ID |
organization_id | int64 requesting organization, not required if user accesses his own resources |
mobile configurations for passed user
owner ID is missing or in wrong format
Unexpected database error
[- {
- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
]
Updates an existing gsm configuration
organization_id | int64 requesting organization, not required if user accesses his own resources |
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 |
update mobile configuration
mobile configuration payload is missing or in wrong format
Unexpected database error
{- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
{- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
Create a gsm configuration for specific user
organization_id | int64 requesting organization, not required if user accesses his own resources |
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 |
created mobile configuration
mobile configuration payload is missing or in wrong format
Unexpected database error
{- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
{- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
Delete an existing gsm configuration
mobileID required | int64 ID of an existing mobile configuration |
organization_id | int64 requesting organization, not required if user accesses his own resources |
update mobile configuration
passed mobile ID is missing or in wrong format
Unexpected database error
{- "status": "deleted"
}
Returns an gsm number configuration
mobileID required | int64 ID of an gsm configuration |
organization_id | int64 requesting organization, not required if user accesses his own resources |
requested mobile configuration
ID is missing or in wrong format
Unexpected database error
[- {
- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
]
Check if any gsm is active for the passed owner id in the passed organization id
user_id required | int64 id of the user |
organization_id required | int64 id of the organization |
contains the information if any device is active for the passed user
organization_id or user_id is missing or in wrong format
Unexpected database error
{- "anyActive": true
}