TicketUserServices

OutboundCampaignLaunchRequest

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/Outbound/Campaigns/{CampaignId}/Launch


export class OutboundCampaignResult
{
    public campaignId?: number;
    public decisions?: { [index: string]: number; };
    public queuedByChannel?: { [index: string]: number; };
    public messageStatuses?: { [index: string]: number; };
    public duplicates?: number;
    public noIdentity?: number;
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<OutboundCampaignResult>) { (Object as any).assign(this, init); }
}

export class OutboundCampaignDevice
{
    public token?: string;
    public platform?: string;

    public constructor(init?: Partial<OutboundCampaignDevice>) { (Object as any).assign(this, init); }
}

export class OutboundCampaignPerson
{
    public phone?: string;
    public email?: string;
    public devices?: OutboundCampaignDevice[];
    public pushConsent?: boolean;
    public smsConsent?: boolean;
    public emailConsent?: boolean;
    public payloadJson?: string;

    public constructor(init?: Partial<OutboundCampaignPerson>) { (Object as any).assign(this, init); }
}

export class OutboundCampaignLaunchRequest
{
    public campaignId?: number;
    public people?: OutboundCampaignPerson[];

    public constructor(init?: Partial<OutboundCampaignLaunchRequest>) { (Object as any).assign(this, init); }
}

TypeScript OutboundCampaignLaunchRequest DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<OutboundCampaignLaunchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CampaignId>0</CampaignId>
  <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>
</OutboundCampaignLaunchRequest>

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>