Download OpenAPI specification:Download
The first-responder service implements all hotline 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 |
Admins of organizations may also access this resource if they specify their organizationID and the user allows this access.
owner_id required | integer id of requested user |
organization_id | integer id of requested organization (for admin access) |
[- {
- "id": 0,
- "isActive": true,
- "name": "string",
- "phone": "string",
- "userID": 0
}
]
Admins of organizations may also create this resource if they specify their organizationID and the user allows this access.
organization_id | integer id of requested organization (for admin access) |
data for AgentPhone creation
id | integer <int64> |
isActive required | boolean active AgentPhones will be called, inactive ones not |
name required | string name of this AgentPhone |
phone required | string international phone number, e.g. 004924155660 |
userID required | integer <int64> |
{- "id": 0,
- "isActive": true,
- "name": "string",
- "phone": "string",
- "userID": 0
}
{- "id": 0,
- "isActive": true,
- "name": "string",
- "phone": "string",
- "userID": 0
}
Admins of organizations may also edit this resource if they specify their organizationID and the user allows this access.
id required | integer id of updated AgentPhone |
organization_id | integer id of requested organization (for admin access) |
data for AgentPhone update
id | integer <int64> |
isActive required | boolean active AgentPhones will be called, inactive ones not |
name required | string name of this AgentPhone |
phone required | string international phone number, e.g. 004924155660 |
userID required | integer <int64> |
{- "id": 0,
- "isActive": true,
- "name": "string",
- "phone": "string",
- "userID": 0
}
{- "id": 0,
- "isActive": true,
- "name": "string",
- "phone": "string",
- "userID": 0
}
This list is paginated, use limit and offset to control the received data.
organization_id required | integer id of requested organization |
limit | integer [ 1 .. 50 ] Default: 10 limit of entries for pagination |
offset | integer >= 0 Default: 0 offset of entries for pagination |
{- "hotlines": [
- {
- "agents": [
- 0
], - "channelsInbound": 10,
- "channelsOutbound": 10,
- "id": 0,
- "isActive": true,
- "name": "string",
- "number": "string",
- "organizationID": 0,
- "status": "string",
- "ttsInbound": "\"Willkommen zur GroupAlarm.com First Responder Hotline. Der erste freie Agent wird umgehend zu Ihnen durchgestellt.\"",
- "ttsOutbound": "\"Hallo, Sie wurden durch die GroupAlarm.com First Responder Hotline alarmiert. Bitte drücken Sie die 1 zum Annehmen oder legen Sie zum Ablehnen einfach auf.\""
}
], - "totalHotlines": 0
}
Final activation of hotline and all agents may take up to 24 hours but should be done in approximately 1 hour. This requests automatically creates a new local phone number so costs may occur.
data for hotline creation
agents required | Array of integers <int64> [ items <int64 > ] list of userIDs which will be called as agent |
channelsInbound | integer <int64> [ 1 .. 100 ] Default: 10 amount of inbound telephony channels |
channelsOutbound | integer <int64> [ 1 .. 100 ] Default: 10 amount of outbound telephony channels |
id | integer <int64> |
isActive required | boolean active hotlines are reachable, inactive hotlines will be shut down |
name required | string name of this hotline |
organizationID required | integer <int64> |
status | string (HotlineStatus) HotlineStatus describes the status the given hotline is in (e.g. just created, active, paused, ...) |
ttsInbound | string <= 300 Default: "\"Willkommen zur GroupAlarm.com First Responder Hotline. Der erste freie Agent wird umgehend zu Ihnen durchgestellt.\"" text will be played to inbound callers |
ttsOutbound | string <= 300 Default: "\"Hallo, Sie wurden durch die GroupAlarm.com First Responder Hotline alarmiert. Bitte drücken Sie die 1 zum Annehmen oder legen Sie zum Ablehnen einfach auf.\"" text will be played to outbound agents |
{- "agents": [
- 0
], - "channelsInbound": 10,
- "channelsOutbound": 10,
- "id": 0,
- "isActive": true,
- "name": "string",
- "organizationID": 0,
- "status": "string",
- "ttsInbound": "\"Willkommen zur GroupAlarm.com First Responder Hotline. Der erste freie Agent wird umgehend zu Ihnen durchgestellt.\"",
- "ttsOutbound": "\"Hallo, Sie wurden durch die GroupAlarm.com First Responder Hotline alarmiert. Bitte drücken Sie die 1 zum Annehmen oder legen Sie zum Ablehnen einfach auf.\""
}
{- "agents": [
- 0
], - "channelsInbound": 10,
- "channelsOutbound": 10,
- "id": 0,
- "isActive": true,
- "name": "string",
- "number": "string",
- "organizationID": 0,
- "status": "string",
- "ttsInbound": "\"Willkommen zur GroupAlarm.com First Responder Hotline. Der erste freie Agent wird umgehend zu Ihnen durchgestellt.\"",
- "ttsOutbound": "\"Hallo, Sie wurden durch die GroupAlarm.com First Responder Hotline alarmiert. Bitte drücken Sie die 1 zum Annehmen oder legen Sie zum Ablehnen einfach auf.\""
}
hotlineID required | integer id of requested hotline |
{- "agents": [
- 0
], - "channelsInbound": 10,
- "channelsOutbound": 10,
- "id": 0,
- "isActive": true,
- "name": "string",
- "number": "string",
- "organizationID": 0,
- "status": "string",
- "ttsInbound": "\"Willkommen zur GroupAlarm.com First Responder Hotline. Der erste freie Agent wird umgehend zu Ihnen durchgestellt.\"",
- "ttsOutbound": "\"Hallo, Sie wurden durch die GroupAlarm.com First Responder Hotline alarmiert. Bitte drücken Sie die 1 zum Annehmen oder legen Sie zum Ablehnen einfach auf.\""
}
Even a paused hotline will create costs as the local number is still reserved.
hotlineID required | integer id of updated hotline |
data for hotline update
agents required | Array of integers <int64> [ items <int64 > ] list of userIDs which will be called as agent |
channelsInbound | integer <int64> [ 1 .. 100 ] Default: 10 amount of inbound telephony channels |
channelsOutbound | integer <int64> [ 1 .. 100 ] Default: 10 amount of outbound telephony channels |
id | integer <int64> |
isActive required | boolean active hotlines are reachable, inactive hotlines will be shut down |
name required | string name of this hotline |
organizationID required | integer <int64> |
status | string (HotlineStatus) HotlineStatus describes the status the given hotline is in (e.g. just created, active, paused, ...) |
ttsInbound | string <= 300 Default: "\"Willkommen zur GroupAlarm.com First Responder Hotline. Der erste freie Agent wird umgehend zu Ihnen durchgestellt.\"" text will be played to inbound callers |
ttsOutbound | string <= 300 Default: "\"Hallo, Sie wurden durch die GroupAlarm.com First Responder Hotline alarmiert. Bitte drücken Sie die 1 zum Annehmen oder legen Sie zum Ablehnen einfach auf.\"" text will be played to outbound agents |
{- "agents": [
- 0
], - "channelsInbound": 10,
- "channelsOutbound": 10,
- "id": 0,
- "isActive": true,
- "name": "string",
- "organizationID": 0,
- "status": "string",
- "ttsInbound": "\"Willkommen zur GroupAlarm.com First Responder Hotline. Der erste freie Agent wird umgehend zu Ihnen durchgestellt.\"",
- "ttsOutbound": "\"Hallo, Sie wurden durch die GroupAlarm.com First Responder Hotline alarmiert. Bitte drücken Sie die 1 zum Annehmen oder legen Sie zum Ablehnen einfach auf.\""
}
{- "agents": [
- 0
], - "channelsInbound": 10,
- "channelsOutbound": 10,
- "id": 0,
- "isActive": true,
- "name": "string",
- "number": "string",
- "organizationID": 0,
- "status": "string",
- "ttsInbound": "\"Willkommen zur GroupAlarm.com First Responder Hotline. Der erste freie Agent wird umgehend zu Ihnen durchgestellt.\"",
- "ttsOutbound": "\"Hallo, Sie wurden durch die GroupAlarm.com First Responder Hotline alarmiert. Bitte drücken Sie die 1 zum Annehmen oder legen Sie zum Ablehnen einfach auf.\""
}
This list is paginated, use limit and offset to control the received data.
hotlineID required | integer id of requested hotline |
limit | integer [ 1 .. 50 ] Default: 10 limit of entries for pagination |
offset | integer >= 0 Default: 0 offset of entries for pagination |
{- "callLogs": [
- {
- "entries": [
- {
- "action": "string",
- "agentPhone": "string",
- "id": 0,
- "startTime": null,
- "userID": 0
}
], - "hotlineID": 0,
- "id": 0,
- "startTime": null
}
], - "totalCallLogs": 0
}
hotlineID required | integer id of requested hotline |
logID required | integer id of requested call logs |
{- "entries": [
- {
- "action": "string",
- "agentPhone": "string",
- "id": 0,
- "startTime": null,
- "userID": 0
}
], - "hotlineID": 0,
- "id": 0,
- "startTime": null
}
This list is paginated, use limit and offset to control the received data.
hotlineID required | integer id of requested hotline |
limit | integer [ 1 .. 50 ] Default: 10 limit of entries for pagination |
offset | integer >= 0 Default: 0 offset of entries for pagination |
{- "records": [
- {
- "destinationNumber": "string",
- "hotlineID": 0,
- "id": 0,
- "price": 0,
- "timeEnd": null,
- "timeStart": null
}
], - "totalRecords": 0
}
This is a requirement for creating and managing hotlines.
organization's data for sip account creation
city required | string |
cityCode required | string |
country required | string short country code, e.g. "DE" for Germany |
name required | string name of organization or individual |
organizationID required | integer <int64> |
street required | string |
streetHousenumber required | integer <int64> |
{- "city": "string",
- "cityCode": "string",
- "country": "string",
- "name": "string",
- "organizationID": 0,
- "street": "string",
- "streetHousenumber": 0
}
{- "exists": true
}