TicketUserServices

<back to all web services

OutboundCampaignLaunchRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/Outbound/Campaigns/{CampaignId}/Launch
OutboundCampaignLaunchRequest Parameters:
NameParameterData TypeRequiredDescription
CampaignIdpathintNo
PeoplebodyList<OutboundCampaignPerson>No
OutboundCampaignPerson Parameters:
NameParameterData TypeRequiredDescription
PhoneformstringNo
EmailformstringNo
DevicesformList<OutboundCampaignDevice>No
PushConsentformbool?No
SmsConsentformbool?No
EmailConsentformbool?No
PayloadJsonformstringNo
OutboundCampaignDevice Parameters:
NameParameterData TypeRequiredDescription
TokenformstringNo
PlatformformstringNo
OutboundCampaignResult Parameters:
NameParameterData TypeRequiredDescription
CampaignIdformintNo
DecisionsformDictionary<string, int>No
QueuedByChannelformDictionary<string, int>No
MessageStatusesformDictionary<string, int>No
DuplicatesformintNo
NoIdentityformintNo
StatusCodeformintNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Outbound/Campaigns/{CampaignId}/Launch HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"campaignId":0,"people":[{"phone":"String","email":"String","devices":[{"token":"String","platform":"String"}],"pushConsent":false,"smsConsent":false,"emailConsent":false,"payloadJson":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"campaignId":0,"decisions":{"String":0},"queuedByChannel":{"String":0},"messageStatuses":{"String":0},"duplicates":0,"noIdentity":0,"statusCode":0,"message":"String"}