SMS API specification (b63bb6ce8c40f3cf1cc7029b2610c7e8d99a9953)
Download OpenAPI specification:
The sms service implements all sms functions for GroupAlarm
ListConfigurations
Returns all sms-alarming configurations
Authorizations:
query Parameters
| organization_id required | integer requesting organization |
Responses
Response samples
- 200
[- {
- "gsm": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pin": "string"
}
]UpdateConfiguration
Updates an existing sms-alarming configuration
Authorizations:
Request Body schema: application/jsonrequired
updated sms-alarming configuration
| gsm | string |
| id | integer <int64> |
| name | string |
| organizationID | integer <int64> |
| pin | string |
Responses
Request samples
- Payload
{- "gsm": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pin": "string"
}Response samples
- 200
{- "gsm": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pin": "string"
}CreateConfiguration
Creates a new sms-alarming configuration
Authorizations:
Request Body schema: application/jsonrequired
new sms-alarming configuration
| gsm | string |
| id | integer <int64> |
| name | string |
| organizationID | integer <int64> |
| pin | string |
Responses
Request samples
- Payload
{- "gsm": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pin": "string"
}Response samples
- 200
{- "gsm": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pin": "string"
}GetDisabledOrganization
Returns whether the given organization has disabled this way of alarming or not
Authorizations:
query Parameters
| organization_id required | integer requesting organization |
Responses
Response samples
- 200
[- {
- "isDisabled": true
}
]SetDisabledOrganization
Sets whether the given organization has this way of alarming disabled or not
Authorizations:
query Parameters
| organization_id required | integer requesting organization |
Request Body schema: application/jsonrequired
isDisabled payload
| isDisabled | boolean |
Responses
Request samples
- Payload
{- "isDisabled": true
}SetTextFormatter
Sets the given organization's text formatter
Authorizations:
Request Body schema: application/jsonrequired
organization and it's text formatter settings
| organizationID | integer <int64> |
| textFormatterName | string |
Responses
Request samples
- Payload
{- "organizationID": 0,
- "textFormatterName": "string"
}List
Returns all gsm numbers for queried owner
Authorizations:
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
- 200
[- {
- "active": true,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}
]Update
Updates an existing gsm configuration
Authorizations:
query Parameters
| organization_id | integer requesting organization, not required if user accesses his own resources |
Request Body schema: application/jsonrequired
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 +) |
| 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
- Payload
{- "active": true,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Response samples
- 200
{- "active": true,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Create
Create a gsm configuration for specific user
Authorizations:
query Parameters
| organization_id | integer requesting organization, not required if user accesses his own resources |
Request Body schema: application/jsonrequired
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 +) |
| 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
- Payload
{- "active": true,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Response samples
- 200
{- "active": true,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Delete
Delete an existing gsm configuration
Authorizations:
path Parameters
| mobileID required | integer ID of an existing mobile configuration |
query Parameters
| organization_id | integer requesting organization, not required if user accesses his own resources |
Responses
Response samples
- 200
{- "status": "deleted"
}Get
Returns an gsm number configuration
Authorizations:
path Parameters
| mobileID required | integer ID of an gsm configuration |
query Parameters
| organization_id | integer requesting organization, not required if user accesses his own resources |
Responses
Response samples
- 200
[- {
- "active": true,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}
]AnyActive
Check if any gsm is active for the passed owner id in the passed organization id and get the permissions of the user and the organization
Authorizations:
query Parameters
| user_id required | integer id of the user |
| organization_id required | integer id of the organization |
Responses
Response samples
- 200
{- "activeCount": 0,
- "anyActive": true,
- "organizationPermission": true,
- "userPermission": true
}Sets the given organization's SMS TTL.
Authorizations:
Request Body schema: application/jsonrequired
organization and it's sms TTL settings
| organizationID | integer <int64> OrganizationID indicates the organization for these TTLSettings |
| ttlMinutes | integer <int64> TTLMinutes indicates the number of minutes that an SMS will be valid from time it is requested. If that time elapses before the SMS can be delivered, it will be discarded by the carrier. If it is zero, the SMS does not have a TTL. |
Responses
Request samples
- Payload
{- "organizationID": 0,
- "ttlMinutes": 0
}GetPermission
Returns true if there is an active permission for the passed organization or specifically for the passed user in an organization.
Authorizations:
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.
Authorizations:
Request Body schema: application/jsonrequired
restriction configuration with user and organization id
| organizationID | integer <int64> |
| userID | integer <int64> |
Responses
Request samples
- Payload
{- "organizationID": 0,
- "userID": 0
}