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