API Index

Authentication API

Resource Description
GET /auth/token Generate a Security Token

Notification API

Resource Description
PUT /queue/list Add a list of notifications to the Queue
GET /queue/status Get the current status of the Queue

Campaign Template API

Resource Description
PUT /campaign/flat/template Create a new Campaign Template
POST /campaign/flat/template Update existing Campaign Template
GET /campaign/flat/template/:id Retrieve Campaign Template by GUID
DELETE /campaign/template/:id Disable Campaign Template by GUID

Campaign Execution API

Resource Description
PUT /campaign/execution Add a new Execution to an existing Campaign Template
GET /campaign/execution/:id/pause Pause delivery of Notifications in a specific Campaign Execution
GET /campaign/execution/:id/unpause Resume delivery of Notifications in a specific Campaign Execution
GET /campaign/execution/:id/purge Remove all Notifications that have not yet been delivered from a specific Campaign Execution.

Results API

Resource Description
GET /results/notification/uniqueid/:id Get the Results for a specific Notification by unique Identifier
GET /results/notification/refid/:id Get the Results for a specific Notification by Call Reference Id
GET /results Get all new results since the last time the Service  was called