TicketUserServices

<back to all web services

OutboundCampaignCreateRequest

import Foundation
import ServiceStack

public class OutboundCampaignCreateRequest : Codable
{
    public var ownerId:Int?
    public var name:String?
    public var lane:String?
    public var templateKey:String?
    public var payloadJson:String?
    public var channelOrder:String?
    public var holdoutPercent:Int?
    public var guardKey:String?
    public var guardSubject:String?
    public var sendAt:Date?
    public var expiresAt:Date?
    public var audienceSource:String?
    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 OutboundCampaignCreateRequest DTOs

POST /Outbound/Campaigns HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OutboundCampaignCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AudienceSource>String</AudienceSource>
  <ChannelOrder>String</ChannelOrder>
  <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
  <GuardKey>String</GuardKey>
  <GuardSubject>String</GuardSubject>
  <HoldoutPercent>0</HoldoutPercent>
  <Lane>String</Lane>
  <Name>String</Name>
  <OwnerId>0</OwnerId>
  <PayloadJson>String</PayloadJson>
  <People>
    <OutboundCampaignPerson>
      <Devices>
        <OutboundCampaignDevice>
          <Platform>String</Platform>
          <Token>String</Token>
        </OutboundCampaignDevice>
      </Devices>
      <Email>String</Email>
      <EmailConsent>false</EmailConsent>
      <PayloadJson>String</PayloadJson>
      <Phone>String</Phone>
      <PushConsent>false</PushConsent>
      <SmsConsent>false</SmsConsent>
    </OutboundCampaignPerson>
  </People>
  <SendAt>0001-01-01T00:00:00</SendAt>
  <TemplateKey>String</TemplateKey>
</OutboundCampaignCreateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OutboundCampaignResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CampaignId>0</CampaignId>
  <Decisions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringint>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringint>
  </Decisions>
  <Duplicates>0</Duplicates>
  <Message>String</Message>
  <MessageStatuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringint>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringint>
  </MessageStatuses>
  <NoIdentity>0</NoIdentity>
  <QueuedByChannel xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringint>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringint>
  </QueuedByChannel>
  <StatusCode>0</StatusCode>
</OutboundCampaignResult>