Amtelco IS Web
The Amtelco IS Web connector enables seamless integration with Amtelco's communication and scheduling platform, providing essential functionalities such as message delivery and on-call shift management.
Amtelco IS Web is a comprehensive communication management system designed for critical messaging and dispatching. This connector enables seamless integration with Amtelco IS Web, allowing users to automate message creation, delivery, and retrieval directly within Swimlane Turbine. By leveraging this connector, end-users can streamline communication workflows, manage on-call schedules, and access directory information, enhancing operational efficiency and response times. The integration with Amtelco IS Web provides a powerful tool for security teams to maintain continuous, automated communication channels, crucial for incident management and coordination.
Supported Version
- The Amtelco connector supports the latest version.
Prerequisites
To effectively utilize the Amtelco IS Web connector within Swimlane Turbine, ensure you have the following prerequisites:
- Amtelco IS Web credentials and connection details:
- URL: The endpoint for the Amtelco IS Web REST API.
- Username: Your Amtelco IS Web account username.
- API Key: A unique key provided by Amtelco for authenticating API requests.
Authentication Methods
- Amtelco IS Web credentials, which include:
- URL: The endpoint for the Amtelco IS Web REST API.
- Username: Your Amtelco IS Web username for authentication.
- API Key: A unique key provided by Amtelco for secure API access.
Capabilities
This Amtelco IS Web Connector provides the following capabilities:
- Create Message
- Deliver Message
- Get Directory Field Layout
- Get Directory Listing Detail
- Get Message
- Get Messages
- Get On-Call Schedule
- Get On-Call Shifts
- List Directory Subjects
- List Directory Views
- Search Directory Listings
- Undeliver Message
Create Message
- Create a new message in the Amtelco IS Web system.
Deliver Message
- Deliver a message by ID.
Get Directory Field Layout
- Retrieve the field layout and initial listings for a directory subject and view.
Get Directory Listing Detail
- Retrieve the full details for a specific directory listing.
Get Message
- Retrieve details for a specific message by ID.
Get Messages
- Retrieve all messages from the Amtelco IS Web REST API.
Get On-Call Schedule
- Retrieve the on-call schedule for the given subject and optional schedule ID.
Get On-Call Shifts
- Retrieve on-call shifts for the provided subject, schedule, and time window.
List Directory Subjects
- Retrieve all directory subjects available to the authenticated user.
List Directory Views
- Retrieve the available views for a specified directory subject.
Search Directory Listings
- Search directory listings for matching records and return their identifiers.
Undeliver Message
- Mark a message as undelivered by ID.
Configurations
Amtelco IS Web REST API
Asset containing credentials and connection details for the Amtelco IS Web REST API.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | Base mobileIS.svc endpoint (e.g., https://host/IS-API/mobileIS.svc). | string | Required |
username | API user ID used to authenticate. | string | Required |
password | API key associated with the username. | string | Required |
verify_ssl | Verify SSL certificates when communicating with the API. | boolean | Optional |
http_proxy | Proxy URL to route requests through. | string | Optional |
timeout | Timeout, in seconds, to wait for Amtelco API responses. | integer | Optional |
debug | Enable debug logging for requests to the Amtelco API. | boolean | Optional |
Actions
Create Message
Generates a new message within the Amtelco IS Web system using the provided data body.
Endpoint
- URL: /Message
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
data_body | object | Required | Form fields used to create the message. |
data_body.cltId | string | Required | Numeric client identifier. |
data_body.listId | string | Required | Numeric list identifier. |
data_body.subject | string | Required | Message subject text. |
data_body.message | string | Required | Message body content. |
data_body.urgent | boolean | Optional | Mark the message as urgent. |
data_body.dispatch | boolean | Optional | Dispatch the message immediately. |
Input Example
{"data_body":{"cltId":"string","listId":"string","subject":"string","message":"string","urgent":true,"dispatch":true}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
Value | string | Value for the parameter |
Output Example
{"Value":"string"}
Deliver Message
Delivers a specific message using its unique ID in the Amtelco IS Web system.
Endpoint
- URL: /Messages/{{message_id}}/Deliver
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.message_id | string | Required | The message identifier to deliver. |
Input Example
{"path_parameters":{"message_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
history | array | Output field: history |
history.agent | string | Output field: history.agent |
history.agentType | string | Type of the resource |
history.disposition | string | Output field: history.disposition |
history.historyId | integer | Unique identifier |
history.initials | string | Output field: history.initials |
history.listingDescription | string | Output field: history.listingDescription |
history.messageId | integer | Unique identifier |
history.timeStamp | string | Output field: history.timeStamp |
history.timezoneOffset | string | Output field: history.timezoneOffset |
message | object | Response message |
message.delivered | boolean | Response message |
message.deliveredStamp | string | Response message |
message.initials | string | Response message |
message.listId | integer | Unique identifier |
message.messageId | integer | Unique identifier |
message.subject | string | Response message |
message.taken | string | Response message |
message.timezoneOffset | string | Response message |
message.urgent | boolean | Response message |
summary | string | Output field: summary |
Output Example
{"history":[{"agent":"string","agentType":"string","disposition":"string","historyId":123,"initials":"string","listingDescription":"string","messageId":123,"timeStamp":"2024-01-01T00:00:00Z","timezoneOffset":"string"}],"message":{"delivered":true,"deliveredStamp":"string","initials":"string","listId":123,"messageId":123,"subject":"string","taken":"string","timezoneOffset":"string","urgent":true},"summary":"string"}
Get Directory Field Layout
Retrieve field layout and initial listings for a specified directory subject and view in Amtelco IS Web, requiring 'subject_id' and 'view_id'.
Endpoint
- URL: /Directory/{{subject_id}}/{{view_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.subject_id | string | Required | Directory subject identifier. |
path_parameters.view_id | string | Required | Directory view identifier. |
Input Example
{"path_parameters":{"subject_id":"string","view_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{}
Get Directory Listing Detail
Retrieve full details for a directory listing in Amtelco IS Web using subject_id, view_id, and list_id.
Endpoint
- URL: /Directory/{{subject_id}}/{{view_id}}/{{list_id}}/detail
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.subject_id | string | Required | Directory subject identifier. |
path_parameters.view_id | string | Required | Directory view identifier. |
path_parameters.list_id | string | Required | Unique listing identifier. |
Input Example
{"path_parameters":{"subject_id":"string","view_id":"string","list_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{}
Get Message
Retrieve details for a specific message using its unique message ID in Amtelco IS Web.
Endpoint
- URL: /Messages/{{message_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.message_id | string | Required | The unique message identifier. |
Input Example
{"path_parameters":{"message_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
history | array | Output field: history |
history.agent | string | Output field: history.agent |
history.agentType | string | Type of the resource |
history.disposition | string | Output field: history.disposition |
history.historyId | integer | Unique identifier |
history.initials | string | Output field: history.initials |
history.listingDescription | string | Output field: history.listingDescription |
history.messageId | integer | Unique identifier |
history.timeStamp | string | Output field: history.timeStamp |
history.timezoneOffset | string | Output field: history.timezoneOffset |
message | object | Response message |
message.delivered | boolean | Response message |
message.deliveredStamp | string | Response message |
message.initials | string | Response message |
message.listId | integer | Unique identifier |
message.messageId | integer | Unique identifier |
message.subject | string | Response message |
message.taken | string | Response message |
message.timezoneOffset | string | Response message |
message.urgent | boolean | Response message |
summary | string | Output field: summary |
Output Example
{"history":[{"agent":"string","agentType":"string","disposition":"string","historyId":123,"initials":"string","listingDescription":"string","messageId":123,"timeStamp":"2024-01-01T00:00:00Z","timezoneOffset":"string"}],"message":{"delivered":true,"deliveredStamp":"string","initials":"string","listId":123,"messageId":123,"subject":"string","taken":"string","timezoneOffset":"string","urgent":true},"summary":"string"}
Get Messages
Fetches all messages from the Amtelco IS Web REST API, providing a comprehensive overview of communications.
Endpoint
- URL: /Messages
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters | object | Optional | Optional query parameters to include with the request. |
Input Example
{"parameters":{}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
[]
Get On-Call Schedule
Retrieve the on-call schedule for a specified subject and an optional schedule ID in Amtelco IS Web.
Endpoint
- URL: /OnCall/{{subject_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.subject_id | string | Required | The subject identifier to query. |
schedule_id | string | Optional | Optional schedule identifier. |
Input Example
{"path_parameters":{"subject_id":"string"},"schedule_id":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
administratorEmail | string | Output field: administratorEmail |
alertExpiration | string | Output field: alertExpiration |
alertMessage | string | Response message |
comment | string | Output field: comment |
commentPhrases | array | Output field: commentPhrases |
roles | array | Output field: roles |
roles.name | string | Name of the resource |
roles.roleId | integer | Unique identifier |
schedule | object | Output field: schedule |
schedule.name | string | Name of the resource |
schedule.scheduleId | integer | Unique identifier |
schedule.subjectId | integer | Unique identifier |
Output Example
{"administratorEmail":"string","alertExpiration":"string","alertMessage":"string","comment":"string","commentPhrases":["string"],"roles":[{"name":"Example Name","roleId":123}],"schedule":{"name":"Example Name","scheduleId":123,"subjectId":123}}
Get On-Call Shifts
Retrieve on-call shifts for a specific subject and schedule within a set time window in Amtelco IS Web.
Endpoint
- URL: /OnCall/{{subject_id}}/{{schedule_id}}/Shifts/{{start}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.subject_id | string | Required | The subject identifier to query. |
path_parameters.schedule_id | string | Required | The schedule identifier to query. |
path_parameters.start | string | Required | Start time for the search window. Accepts YYYYMMDDTHHMMSS. |
end | string | Optional | Optional end time for the search window. Accepts YYYYMMDDTHHMMSS. |
Input Example
{"path_parameters":{"subject_id":"string","schedule_id":"string","start":"string"},"end":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
[]
List Directory Subjects
Retrieve all directory subjects available to the authenticated Amtelco IS Web user.
Endpoint
- URL: /Directory
- Method: GET
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{}
List Directory Views
Retrieve available views for a specified directory subject in Amtelco IS Web, requiring the subject_id as a path parameter.
Endpoint
- URL: /Directory/{{subject_id}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.subject_id | string | Required | Directory subject identifier. |
Input Example
{"path_parameters":{"subject_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{}
Search Directory Listings
Retrieve identifiers for matching records in Amtelco IS Web directory listings based on search criteria including subject_id, view_id, number_of_results, search_type, and query.
Endpoint
- URL: /Directory/{{subject_id}}/{{view_id}}/{{number_of_results}}/{{search_type}}/{{query}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.subject_id | string | Required | Directory subject identifier. |
path_parameters.view_id | string | Required | Directory view identifier. |
path_parameters.number_of_results | integer | Required | Maximum number of listings to return. |
path_parameters.search_type | string | Required | Search strategy recognized by the API. |
path_parameters.query | string | Required | Search query string (URL-encoded if necessary). |
Input Example
{"path_parameters":{"subject_id":"string","view_id":"string","number_of_results":123,"search_type":"string","query":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{}
Undeliver Message
Marks a specific message as undelivered in Amtelco IS Web using the provided message ID.
Endpoint
- URL: /Messages/{{message_id}}/UnDeliver
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.message_id | string | Required | The message identifier to mark as undelivered. |
Input Example
{"path_parameters":{"message_id":"string"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | integer | HTTP status code of the response |
reason | string | Response reason phrase |
history | array | Output field: history |
history.agent | string | Output field: history.agent |
history.agentType | string | Type of the resource |
history.disposition | string | Output field: history.disposition |
history.historyId | integer | Unique identifier |
history.initials | string | Output field: history.initials |
history.listingDescription | string | Output field: history.listingDescription |
history.messageId | integer | Unique identifier |
history.timeStamp | string | Output field: history.timeStamp |
history.timezoneOffset | string | Output field: history.timezoneOffset |
message | object | Response message |
message.delivered | boolean | Response message |
message.deliveredStamp | string | Response message |
message.initials | string | Response message |
message.listId | integer | Unique identifier |
message.messageId | integer | Unique identifier |
message.subject | string | Response message |
message.taken | string | Response message |
message.timezoneOffset | string | Response message |
message.urgent | boolean | Response message |
summary | string | Output field: summary |
Output Example
{"history":[{"agent":"string","agentType":"string","disposition":"string","historyId":123,"initials":"string","listingDescription":"string","messageId":123,"timeStamp":"2024-01-01T00:00:00Z","timezoneOffset":"string"}],"message":{"delivered":true,"deliveredStamp":"string","initials":"string","listId":123,"messageId":123,"subject":"string","taken":"string","timezoneOffset":"string","urgent":true},"summary":"string"}
Response Headers
Header | Description | Example |
|---|---|---|
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |