| Required role: | Admin |
| POST | /Outbound/Campaigns/{CampaignId}/Launch |
|---|
import Foundation
import ServiceStack
public class OutboundCampaignLaunchRequest : Codable
{
public var campaignId:Int?
public var people:[OutboundCampaignPerson] = []
required public init(){}
}
public class OutboundCampaignPerson : Codable
{
public var phone:String?
public var email:String?
public var devices:[OutboundCampaignDevice] = []
public var pushConsent:Bool?
public var smsConsent:Bool?
public var emailConsent:Bool?
public var payloadJson:String?
required public init(){}
}
public class OutboundCampaignDevice : Codable
{
public var token:String?
public var platform:String?
required public init(){}
}
public class OutboundCampaignResult : Codable
{
public var campaignId:Int?
public var decisions:[String:Int] = [:]
public var queuedByChannel:[String:Int] = [:]
public var messageStatuses:[String:Int] = [:]
public var duplicates:Int?
public var noIdentity:Int?
public var statusCode:Int?
public var message:String?
required public init(){}
}
Swift OutboundCampaignLaunchRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length
{
campaignId: 0,
decisions:
{
String: 0
},
queuedByChannel:
{
String: 0
},
messageStatuses:
{
String: 0
},
duplicates: 0,
noIdentity: 0,
statusCode: 0,
message: String
}