Version 4.0

HOME

Messages Namespaces

• Voice

  Create, Update, Delete, List, and Send Voice Messages

  Voice Methods

  Action	Description
  Get Supported TTS Languages	Returns an array of languages supported by the text-to-speech engine.
  Create New Voice Message	Creates a new voice message using a minimum set of options
  Create New Voice Message	Creates a new voice message
  Update Existing Voice Message	Updates the voice message parameters and content.
  Delete a Voice Message	Deletes the given voice message.
  List Voice Messages	Returns a list of either recorded or yet to be recorded voice messages
  Verify Voice Message Exists	Checks to see if the given voice message exists.
  Upload Audio File	Uploads the audio fragment content. The audio file should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Upload Audio File	Uploads the audio fragment content. Audio may be in the format of vox, ulaw, wav, mp3. The audio file should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Generate an Audio File with TTS	Generates an audio fragment using text-to-speech defaulting to English.
  Generate an Audio File with TTS	Generates an audio fragment using text-to-speech defaulting to English.
  Download Audio File	Download an audio file from the server.
  Download Audio File	Download an audio file from the server. The audio can be downloaded in formats of vox, ulaw, wav, mp3.
  Verify All Recordings for Message Exist	Checks to see if all audio fragments corresponding to the given voice message have been recorded.
  Verify an Audio File Exists	Checks to see if an audio fragment has been recorded.
  Send Alert to gzipped Contact Array and Hotline	Sends the alert to the contact list and also posts the voice message content to the specified hotline. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Send Alert to Contact List and Hotline	Sends the alert to the contact list and also posts the voice message content to the specified hotline.
  Send Alert to Contact Array and Hotline	Sends the alert to the contact list and also posts the voice message content to the specified hotline.
  Send Alert to gzipped Contact Array	Launches an alert. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Send Alert to Contact List	Launches an alert
  Send Alert to Contact Array	Launches an alert
  Create VOICE_ALERT_CONTENT Helper Function	Converts the given text content including auto-fields into a VOICE_ALERT_CONTENT object.
  VOICE_ALERT_PROFILE[] to String Helper Function	Retrieves the text content for the given profile in the given language.
  VOICE_ALERT_CONTENT[] to String Helper Function	Retrieves the text content for the given content type
  VOICE_ALERT_CONTENT to String Helper Function	Retrieves the text content for the given alert content object
  Get Voice Message Profile	Returns the Message_Profile object for the given voicecode

• SMS Text (Short Code - Mass Messaging)

  Create, Update, Delete, List, and Send Text(SMS) Messages

  Text Methods

  Action	Description
  Create New SMS Message	Creates a new sms message using a minimum set of options
  Create New SMS Message	Creates a new sms message
  Update Existing SMS Message	Updates the sms message parameters and content.
  Delete Existing SMS Message	Deletes the given SMS message.
  List SMS Messages	Returns a list of sms messages
  Get SMS Message Profile	Returns the SMS_Message object for the given smscode
  Verify SMS Message Exists	Checks to see if the given SMS message exists.
  Send SMS to gzipped Array of Contacts	Launches an alert. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Send SMS to Contact List	Launches an alert
  Send SMS to Array of Contacts	Launches an alert
  String to SMS_TEXT_SOURCE[] Helper Function	Converts the given text content including auto-fields into a SMS_TEXT_SOURCE object.
  SMS_Content[] to String Helper Function	Retrieves the text content for the given content type
  SMS_Content to String Helper Function	Retrieves the text content for the given alert content object

• SMS Text (Long Codes One-To-One Messaging)

  Send Text(SMS) Messages From Hotline Numbers (Long Codes)

  SMS (Long Code) Methods

  Action	Description
  Send SMS message to single contact	Sends an SMS message to a single contact from an sms-enabled hotline number (long code). Replies to the FromPhone number will be posted to your configured SMS callback URL.

• Email

  Create, Update, Delete, List, and Send E-mail Messages

  Email Methods

  Action	Description
  Create New Email Message	Creates a new Email message using a minimum set of options
  Create New Email Message	Creates a new Email message
  Updates Existing Email Message	Updates the Email message parameters and content.
  Deletes Existing Email Message	Deletes the given Email message.
  List Email Messages	Returns a list of Email messages
  Get Email Message Profile	Returns the Email_Message object for the given Emailcode
  Verify Email Message Exists	Checks to see if the given Email message exists.
  Send Email Message to gzipped Array of Contacts	Launches an alert. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Send Email Message to Contact List	Launches an alert
  Send Email Message to Array of Contacts	Launches an alert
  String to EMAIL_TEXT_SOURCE[] Helper Function	Converts the given text content including auto-fields into a Email_TEXT_SOURCE object.
  Email_Content[] to String Helper Function	Retrieves the text content for the given content type
  Email_Content to String Helper Function	Retrieves the text content for the given alert content object

• Fax

  Create, Update, Delete, List, and Send Fax Messages

  Fax Methods

  Action	Description
  Create New Fax Message	Creates a new fax message using a minimum set of options
  Create New Fax Message	Creates a new fax message
  Update Existing Fax Message	Updates the fax message parameters and content.
  Delete Existing Fax Message	Deletes the given fax message.
  List Fax Messages	Returns a list of fax messages
  Get Fax Message Profile	Returns the Message_Profile object for the given faxcode
  Verify Fax Message Exists	Checks to see if the given fax message exists.
  Send Fax Message to gzipped Array of Contacts	Launches an alert. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Send Fax Message to Contact List	Launches an alert
  Send Fax Message to Array of Contacts	Launches an alert
  String to FAX_TEXT_SOURCE[] Helper Function	Converts the given text content including auto-fields into a FAX_TEXT_SOURCE object.
  FAX_TEXT_SOURCE[] to String Helper Function	Retrieves the text content for the given fax content object array

• Pager

  Create, Update, Delete, List, and Send Pager Messages

  Pager Methods

  Action	Description
  Create New Pager Message	Creates a new Pager message using a minimum set of options
  Create New Pager Message	Creates a new Pager message
  Update Existing Pager Message	Updates the Pager message parameters and content.
  Delete Existing Pager Message	Deletes the given Pager message.
  List Pager Messages	Returns a list of Pager messages
  Get Pager Message Profile	Returns the Pager_Message object for the given Pagercode
  Verify Pager Message Exists	Checks to see if the given Pager message exists.
  Send Pager Message to gzipped Array of Contacts	Launches an alert. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Send Pager Message to Contact List	Launches an alert
  Send Pager Message to Array of Contacts	Launches an alert
  String to PAGER_TEXT_SOURCE[] Helper Function	Converts the given text content including auto-fields into a Pager_TEXT_SOURCE object.
  Pager_Content to String Helper Function	Retrieves the text content for the given alert content object

ContactLists Namespaces

• ContactLists

  Add, Update, Delete, and Retrieve Contact Lists

  ContactList Methods

  Action	Description
  List Contact Lists	Returns an array of existing ContactLists
  Verify Contact List Exists	Verifies that a contact list exists for the given list code
  Create New Contact List	Creates a new contact list and returns the new ListCode
  Update Properties of Contact List	Updates the properties for the given contact list.
  Delete a Contact List	Deletes the contact list
  Get Profile of a Contact List	Returns the profile for the specified contact list

• Contacts

  Add, Update, Delete, and Retrieve Contacts

  Contact Methods

  Action	Description
  List Contacts	Returns an array of Contacts for the given Contact list.
  List Contacts	Returns an array of Contacts for the given Contact list.
  Search for a Contact on a List	Searches the given contact list and returns an array of Contacts
  Get Count of Contacts in List	Returns the total number of contacts in the given contact list
  Get Count of Search Results	Returns the total number of contacts from the search results.
  Verify Contact Exists	Verifies that the given Contact exists on the given contact list
  Create New Contact	Creates a new Contact on the given contact list
  Create New Contacts From GZipped Array	Creates new Contacts on the given contact list. This method is limited to arrays of 2000 contacts or less. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Create New Contacts From Array	Creates new Contacts on the given contact list. This method is limited to arrays of 2000 contacts or less.
  Update Contact	Updates the contact information for the given contact
  Delete Contact	Deletes the given contact from the given contact list
  Assign Contact	Assigns an existing contact to an additional contact list
  Get Profile for Contact	Returns the contact profile for the given entity

• Contact Validator

  Validate Contacts

  Contact Validation Methods

  Action	Description
  Validate GZipped Array of Contacts	Validates the array of contacts and provides a summary of results and statistics
  Validate Array of Contacts	Validates the array of contacts and provides a summary of results and statistics

• Contact Lookup

  Search and View Contact Profiles

  Contact Lookup Methods

  Action	Description
  Search for Contacts	Searches for contacts matching the given criteria. A user-interface for this method is also included so it can be easily embedded into existing applications as a web-frame or iframe with very little effort. The URI for the user-interface version of this method is: GET UI/ContactLists/Lookup/Search/{APIKey}/{CriteriaType}/{SearchCriteria}/{StartIndex}/{PageSize}
  Count Contacts	Gets the total number of contacts matching the given search criteria
  Get Contact Profile	Retrieves a contact profile object for the given EntityGuid. A user-interface for this method is also included so it can be easily embedded into existing applications as a web-frame or iframe with very little effort. The URI for the user-interface version of this method is: GET UI/ContactLists/Lookup/Profile/{APIKey}/{EntityGuid}

• Contact CSV Importer

  Import Contact Data

  Contact Importer Methods

  Action	Description
  Get Pending Imports	Returns an array of import jobs
  Upload and Import a GZipped CSV	Uploads a GZipped CSV of contacts and initializes the import process. The gzipped CSV contents should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Upload and Import CSV	Uploads a CSV of contacts and initializes the import process. The CSV file should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Get Import Status	Returns the current status of the given import job
  Cancel Import	Cancels the import job
  Get List of Invalid Contacts	returns an array of the contact objects that failed validation
  Get Invalid Contact Count	Returns the total number of contact rows that failed validation
  Get Invalid Contact	Returns the Contact data for the given guid
  Updates Pending Contact	Updates an imported contact to correct for prior validation errors
  Delete Pending Contact	Deletes an imported contact that has failed validation

• Contact Object Importer

  Import Contact Data

  Contact Importer Methods

  Action	Description
  Get Pending Import Tasks	Returns a list of import tasks that are still pending or in progress.
  Imports New Contacts From GZipped Array	Imports new Contacts to the given contact list. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Imports New Contacts From GZipped Array	Imports new Contacts to the given contact list. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Imports New Contacts From Array	Imports new Contacts to the given contact list.
  Cancel Existing Import Task	Cancels an existing import task
  Get Import Task Profile	Returns an import task profile and status

• Contact Object Encrypted Importer

  Import Contact Data into Encrypted storage (Encrypted at rest)

  Contact Encrypted Importer Methods

  Action	Description
  Create Encrypted List	Creates an empty encrypted list.
  Imports New Contacts From GZipped Array	Imports new Contacts to the given contact list. All previous contents will be purged and replaced by the contacts uploaded here. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Imports New Contacts From GZipped Array	Imports new Contacts to the given contact list. All previous contents will be purged and replaced by the contacts uploaded here. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Imports New Contacts From Array	Imports new Contacts to the given contact list. All previous contents will be purged and replaced by the contacts uploaded here.

Hotlines Namespaces

• Hotlines

  Configure Hotlines

  Hotline Methods

  Action	Description
  Get Hotline List	Returns a list of Hotlines
  Update Hotline Configuration	Updates the configuration of a hotline
  Get Hotline Profile	Returns the profile for the specified hotline

• Hotlines.Reports

  Hotline Call Record Reports

  Hotline Report Methods

  Action	Description
  List Hotline Records	Return the call records for the specified hotline
  List Hotline Records	Return the call records for the specified hotline
  Search Hotline Records	Searchs through the hotline records for calls meeting the search criteria
  Count Hotline Records	Get the total number of hotline records
  Count Search Results	Count Hotline Records Search Results
  Download Hotline Records	Downloads a zipped comma-delimited CSV file of the raw records

Alerts Namespaces

• Alerts

  Pause, Resume, Cancel, Send, List, and Get Progress of Alert Campaigns

  Alert Methods

  Action	Description
  List Alert Campaigns	Returns a list of jobs that ran within the given dates.
  List Alert Campaigns	Returns a page from the list of jobs that ran within the given dates
  Count Alert Campaigns	Returns the total number of jobs that ran within the given dates.
  List Active Alert Campaigns	Returns a list of all active jobs. This includes in-progress, queing, and paused.
  Get Alert Campaign Profile	Returns the profile for the given jobcode
  Send Alerts to gzipped Array of Contacts and Hotline	Launches an alert using any combination of the given message types and also posts the voice message content to the specified hotline. Voice is required for this method. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Send Alerts to Contact List and Hotline	Launches an alert using any combination of the given message types and also posts the voice message content to the specified hotline. Voice is required for this method.
  Send Alerts to Array of Contacts and Hotline	Launches an alert using any combination of the given message types and also posts the voice message content to the specified hotline. Voice is required for this method.
  Send Alerts to gzipped Array of Contacts	Launches an alert using any combination of the given message types. The gzip compressed contacts array xml should be sent in the HTTP POST body using a content-type of application x-www-form-urlencoded.
  Send Alerts to gzipped Array of Contacts	Launches an alert using any combination of the given message types. The messages are all created dynamically using the content specified.
  Send Alerts to Contact List	Launches an alert using any combination of the given message types. The messages are all created dynamically using the content specified.
  Send Alerts to Array of Contacts	Launches an alert using any combination of the given message types. The messages are all created dynamically using the content specified.
  Send Alert that initiates a two-way phone call	Calls the OriginatingPhone. When the person answers the first call and presses any key, a call is automatically initiated to the terminating phone number and bridged with the first call. This is commonly used for applications such as Click-to-Call.
  Send Alerts to Contact List	Launches an alert using any combination of the given message types.
  Send Alerts to Contact List	Launches an alert using any combination of the given message types.
  Send Alerts to Array of Contacts	Launches an alert using any combination of the given message types.
  Pause Alert Campaign	Pauses the given active job
  Resume Alert Campaign	Resumes the given paused job
  Cancel Alert Campaign	Cancels the given active or paused job
  Get Alert Campaign Progress	Returns the progress of the given job

• Scheduler

  List, Create, and Update Scheduled Alerts

  Scheduler Methods

  Action	Description
  List Scheduled Alerts	Gets a list of scheduled alerts
  Create New Scheduled Alert	Creates a new scheduled alert
  Update Scheduled Alert	Updates an existing alert schedule
  Activate or Deactivate Schedule	Activate or deactivate scheduled alert
  Delete Scheduled Alert	Delete a scheduled alert
  Get Scheduled Alert Profile	Gets the scheduled alert profile for the given schedulecode

Alerts.Triggers Namespaces

• Text

  Trigger alerts from incoming Text (SMS) messages.

  Text Trigger Methods

  Action	Description
  Delete existing SMS Alert Trigger	Deletes an SMSTrigger
  Create a new SMS Alert Trigger	Creates a new SMS Alert trigger.
  Update an existing SMS Alert Trigger	Updates an existing SMSTrigger profile
  List SMS Alert Triggers	Returns a list of SMSTrigger objects
  Get total number of sms alert trigger	Returns the total number of existing SMSTriggers
  Enable or Disable an SMS Alert Trigger	Enables or Disables an existing SMSTrigger
  Get SMS Alert Trigger Profile	Returns the SMSTrigger object for the given TriggerCode

Alerts.Reports Namespaces

• Voice

  Voice Message Delivery Reports for Alerting Campaigns.

  Voice Report Methods

  Action	Description
  Count Call Records Search Results	Gets the total number of records for the given job using the search criteria
  List Call Records	Returns a paged set of records for the given job
  List Call Records	Returns a paged set of records for the given job sorted as specified
  Search Call Records	Returns a paged set of records for the given job sorted as specified and filtered by the search criteria
  Count Call Records	Gets the total number of records for the given job
  Download Call Records	Downloads a zipped comma-delimited CSV file of the raw records
  Download Feedback Audio File	Download a feedback audio file from the server.

• Link

  Voice Message Delivery Reports for Alerting Campaigns. The Link reports are for voice message types that are two-way such as voice-link, conference blast, and custom.

  Link Report Methods

  Action	Description
  Count Call Records Search Results	Gets the total number of records for the given job using the search criteria
  List Call Records	Returns a paged set of records for the given job
  List Call Records	Returns a paged set of records for the given job sorted as specified
  Search Call Records	Returns a paged set of records for the given job sorted as specified and filtered by the search criteria
  Count Call Records	Gets the total number of records for the given job
  Download Call Records	Downloads a zipped comma-delimited CSV file of the raw records

• Text

  Text(SMS) Message Delivery Reports for Alerting Campaigns.

  Text Report Methods

  Action	Description
  Count SMS Records Search Results	Gets the total number of records for the given job using the search criteria
  List SMS Records	Returns a paged set of records for the given job
  List SMS Records	Returns a paged set of records for the given job sorted as specified
  Search SMS Records	Returns a paged set of records for the given job sorted as specified and filtered by the search criteria
  Count SMS Records	Gets the total number of records for the given job
  Download SMS Records	Downloads a zipped comma-delimited CSV file of the raw records

• E-mail

  E-mail Message Delivery Reports for Alerting Campaigns.

  Email Report Methods

  Action	Description
  Count Email Records Search Results	Gets the total number of records for the given job using the search criteria
  List Email Records	Returns a paged set of records for the given job
  List Email Records	Returns a paged set of records for the given job sorted as specified
  Search Email Records	Returns a paged set of records for the given job sorted as specified and filtered by the search criteria
  Count Email Records	Gets the total number of records for the given job
  Download Email Records	Downloads a zipped comma-delimited CSV file of the raw records

• Fax

  Fax Message Delivery Reports for Alerting Campaigns.

  Fax Report Methods

  Action	Description
  Count Fax Records Search Results	Gets the total number of records for the given job using the search criteria
  List Fax Records	Returns a paged set of records for the given job
  List Fax Records	Returns a paged set of records for the given job sorted as specified
  Search Fax Records	Returns a paged set of records for the given job sorted as specified and filtered by the search criteria
  Count Fax Records	Gets the total number of records for the given job
  Download Fax Records	Downloads a zipped comma-delimited CSV file of the raw records

• Pager

  Pager Message Delivery Reports for Alerting Campaigns.

  Pager Report Methods

  Action	Description
  Count Pager Records Search Results	Gets the total number of records for the given job using the search criteria
  List Pager Records	Returns a paged set of records for the given job
  List Pager Records	Returns a paged set of records for the given job sorted as specified
  Search Pager Records	Returns a paged set of records for the given job sorted as specified and filtered by the search criteria
  Count Pager Records	Gets the total number of records for the given job
  Download Pager Records	Downloads a zipped comma-delimited CSV file of the raw records

Incidents Namespaces

• Incident Triggers

  Add, Update, Delete, and Retrieve Incident Triggers

  Incident Triggers Methods

  Action	Description
  Create Trigger	Creates a new incident trigger
  Update Trigger	updates an existing incident trigger
  Delete Trigger	deletes an existing incident trigger
  List Incident Triggers	Returns a list of Incident Triggers
  Get Trigger	returns an incident trigger
  Create Incident from Hardware	Invokes a trigger from the press of a hardware based panic button
  Check for Active Incident	Checks if an incident is already active for the property and its corresponding message phone number.
  Create New Incident	Creates a new Incident. This can be called to invoke a new incident directly without the need for triggers.
  Import Incident Contacts	Imports contacts into an existing incident
  List Properties	Returns a list of properties (campuses) available for incident management

• Incident Trusts

  Add, Update, Delete, and Retrieve Incident Trusts

  Incident Trusts Methods

  Action	Description
  List Trust Relationships	Gets a list of currently fully established trust relationships
  List Pending Trust Requests	Gets a list of trust relationship requests currently pending approval
  Request New Trust	Initiates a request for a new Trust Relationship
  Approve Request Confirmation	Approve the final step of the confirmation process
  Cancel Trust Request	Cancels a trust request
  Resend Confirmation Code	Re-sends the confirmation code to the trusted 3rd party

• Incident Contact Linker

  Provision and manage links between 3rd party contact data and swift911 contact profiles

  Incident Contact Linker Methods

  Action	Description
  Import	import 3rd party data into the pending authorization list
  List All	Returns a list of all entities both authorized and those pending authorization for the given property.
  Authorization Count	Returns count of entities currently authorized for the given property
  List Authorized	Returns a list of entities currently authorized for the given property
  Pending Authorization Count	Returns a count of entities still pending authorization
  List Pending Authorization	Returns a list of entities still pending authorization for the given property
  Delete Authorization	deletes the entity authorization using the vendor provided unique id for the contact
  Delete Authorization	deletes the entity authorization using the entity guid for the contact
  Assign List	Assigns an authorized entity to a contact list. This is primarily used to associate the entity with the trigger access list.
  Unassign List	removes an authorized entity from a contact list