Author Archives: tmedernach

PUT /campaign/execution

Posted on by

Add a new Execution to an existing Campaign Template. The template id provided in the Web Service Body has to match the id of a Campaign Template associated with the user account identified by the security token.
Resource URL:

PUT http://slingshot.surgentnetworks.com/api/campaign/flat/template

Header Parameters:

Parameter Value Required?
X-Security-Token [your security token] Yes
Content-Type application/json or application/xml Yes

Example Content / JSON

{ 
   "activityState":"Created",
   "campaignState":"0",
   "channels":[ 
      "1"
   ],
   "executionEndTime":"2022-10-02T10:00:00-05:00",
   "executionName":"GeneratedExecution",
   "executionStartTime":"2002-10-02T10:00:00-05:00",
   "templateId":"e0898df7-7572-49ae-bd01-56cdbc9f12d1"
}

Expected Result:
Header:

HTTP/1.1 201 Created

Body:

None

GET /campaign/execution/:id/purge

Posted on by

When purging a Campaign Execution, all undelivered notifications associated with that execution will be canceled. These notifications will be marked with Result Code 721.
Resource URL:

GET http://slingshot.surgentnetworks.com/api/campaign/execution/:id/purge

Header Parameters:

Parameter Value Required?
X-Security-Token [your security token] Yes

URL Parameters:

Parameter Value Required?
id The GUID of the Campaign Template to be purged Yes

Expected Result:
Header:

HTTP/1.1 200 OK

GET /campaign/execution/:id/unpause

Posted on by

When un-pausing a Campaign Execution, all undelivered notifications associated with that execution will be moved back into the delivery queue.
Resource URL:

GET http://slingshot.surgentnetworks.com/api/campaign/execution/:id/unpause

Header Parameters:

Parameter Value Required?
X-Security-Token [your security token] Yes

URL Parameters:

Parameter Value Required?
id The GUID of the Campaign Template to be un-paused Yes

Expected Result:
Header:

HTTP/1.1 200 OK

GET /campaign/execution/:id/pause

Posted on by

When pausing a Campaign Execution, all undelivered notifications associated with that execution will be moved from the delivery queue into a pause list.
Resource URL:

GET http://slingshot.surgentnetworks.com/api/campaign/execution/:id/pause

Header Parameters:

Parameter Value Required?
X-Security-Token [your security token] Yes

URL Parameters:

Parameter Value Required?
id The GUID of the Campaign Template to be paused Yes

Expected Result:
Header:

HTTP/1.1 200 OK

DELETE /campaign/template/:id

Posted on by

Disable existing Campaign Template.
Resource URL:

POST http://slingshot.surgentnetworks.com/api/campaign/flat/template

Header Parameters:

Parameter Value Required?
X-Security-Token [your security token] Yes

URL Parameters:

Parameter Value Required?
id The GUID of the Campaign Template to be disabled Yes

Expected Result:
Header:

HTTP/1.1 200 OK

GET /campaign/flat/template/:id

Posted on by

Retrieve an existing Campaign Template from the system. Only Templates associated with the account identified by the security token can be retrieved.
Header Parameters:

Parameter Value Required?
X-Security-Token [your security token] Yes
Accept application/json or application/xml Yes

URL Parameters:

Parameter Value Required?
id The GUID of the Campaign Template to be retrieved Yes

Expected Result:
Header:

HTTP/1.1 200 OK

Body:

A representation of the retrieved Campaign Template

Example Content / JSON

{
"guid":"1234567890",
"campaignDescription":"Some Test Campaign",
"campaignPriority":1,
"campaignTitle":"Title",
"accountGuid":"111222333444",
"testMode":false,
"respectDoNotCallList":true,
"ignoreDuplicates":true,
"campaignCallbackNumberPhone":"+15556667777",
"campaignCallbackNumberSms":"+5557776666",
"messagePhoneType":"VXML",
"messagePhoneLiveBody":"http://liveVxml.vxml",
"messagePhoneAnsweringMachineBody":"http://amVxml.vxml",
"messageSmsType":"SMS",
"messageSmsBody":"This is an SMS text",
"messageMailBody":"This is an e-mail Message"
}

POST /campaign/flat/template

Posted on by

Update an existing Campaign Template in the system. The GUID provided in the body of the message must match the ID of a Campaign Template in the system.
Resource URL:

POST http://slingshot.surgentnetworks.com/api/campaign/flat/template

Header Parameters:

Parameter Value Required?
X-Security-Token [your security token] Yes
Content-Type application/json or application/xml Yes

Example Content / JSON

{
"guid":"1234567890",
"campaignDescription":"Some Test Campaign",
"campaignPriority":1,
"campaignTitle":"Title",
"accountGuid":"111222333444",
"testMode":false,
"respectDoNotCallList":true,
"ignoreDuplicates":true,
"campaignCallbackNumberPhone":"+15556667777",
"campaignCallbackNumberSms":"+5557776666",
"messagePhoneType":"VXML",
"messagePhoneLiveBody":"http://liveVxml.vxml",
"messagePhoneAnsweringMachineBody":"http://amVxml.vxml",
"messageSmsType":"SMS",
"messageSmsBody":"This is an SMS text",
"messageMailBody":"This is an e-mail Message"
}

Expected Result:
Header:

HTTP/1.1 200 OK

Body:

None

PUT /campaign/flat/template

Posted on by

Create a new Campaign Template.
Resource URL:

PUT http://slingshot.surgentnetworks.com/api/campaign/flat/template

Header Parameters:

Parameter Value Required?
X-Security-Token [your security token] Yes
Content-Type application/json or application/xml Yes

Example Content / JSON

{
"campaignDescription":"Some Test Campaign",
"campaignPriority":1,
"campaignTitle":"Title",
"accountGuid":"111222333444",
"guid":"1234567890",
"testMode":false,
"respectDoNotCallList":true,
"ignoreDuplicates":true,
"campaignCallbackNumberPhone":"+15556667777",
"campaignCallbackNumberSms":"+5557776666",
"messagePhoneType":"VXML",
"messagePhoneLiveBody":"http://liveVxml.vxml",
"messagePhoneAnsweringMachineBody":"http://amVxml.vxml",
"messageSmsType":"SMS",
"messageSmsBody":"This is an SMS text",
"messageMailBody":"This is an e-mail Message"
}

Expected Result:
Header:

HTTP/1.1 201 Created

Body:

None