Call API specification (af079ee16a271cb8bb85abd202792788b31e41bf)
Download OpenAPI specification:Download
The call service implements all call functions for GroupAlarm
ListConfigurations
Returns all call-alarming configurations
Authorizations:
query Parameters
| organization_id required | integer requesting organization |
Responses
Response samples
- 200
[- {
- "alarmTemplateID": 0,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pin": "string"
}
]UpdateConfiguration
Updates an existing call-alarming configuration
Authorizations:
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
- Payload
{- "alarmTemplateID": 0,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pin": "string"
}Response samples
- 200
{- "alarmTemplateID": 0,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pin": "string"
}CreateConfiguration
Creates a new call-alarming configuration
Authorizations:
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
- Payload
{- "alarmTemplateID": 0,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pin": "string"
}Response samples
- 200
{- "alarmTemplateID": 0,
- "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/json
isDisabled payload
| isDisabled | boolean |
Responses
Request samples
- Payload
{- "isDisabled": true
}List
Returns all phone 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
}
]Create
Create a phone configuration for specific user
Authorizations:
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
- Payload
{- "active": true,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Response samples
- 200
{- "active": true,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Update
Updates an existing phone configuration
Authorizations:
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
- 200
{- "active": true,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Delete
Delete an existing phone configuration
Authorizations:
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
- 200
{- "status": "deleted"
}Get
Gets a phone configuration
Authorizations:
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
- 200
{- "active": true,
- "gsm": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}AnyActive
Check if any device 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
}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/json
restriction configuration with user and organization id
| organizationID | integer <int64> |
| userID | integer <int64> |
Responses
Request samples
- Payload
{- "organizationID": 0,
- "userID": 0
}