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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;

namespace TicketUserServices.ServiceModel
{
    public partial class OutboundCampaignDevice
    {
        public virtual string Token { get; set; }
        public virtual string Platform { get; set; }
    }

    public partial class OutboundCampaignLaunchRequest
    {
        public OutboundCampaignLaunchRequest()
        {
            People = new List<OutboundCampaignPerson>{};
        }

        public virtual int CampaignId { get; set; }
        public virtual List<OutboundCampaignPerson> People { get; set; }
    }

    public partial class OutboundCampaignPerson
    {
        public OutboundCampaignPerson()
        {
            Devices = new List<OutboundCampaignDevice>{};
        }

        public virtual string Phone { get; set; }
        public virtual string Email { get; set; }
        public virtual List<OutboundCampaignDevice> Devices { get; set; }
        public virtual bool? PushConsent { get; set; }
        public virtual bool? SmsConsent { get; set; }
        public virtual bool? EmailConsent { get; set; }
        public virtual string PayloadJson { get; set; }
    }

    public partial class OutboundCampaignResult
    {
        public OutboundCampaignResult()
        {
            Decisions = new Dictionary<string, int>{};
            QueuedByChannel = new Dictionary<string, int>{};
            MessageStatuses = new Dictionary<string, int>{};
        }

        public virtual int CampaignId { get; set; }
        public virtual Dictionary<string, int> Decisions { get; set; }
        public virtual Dictionary<string, int> QueuedByChannel { get; set; }
        public virtual Dictionary<string, int> MessageStatuses { get; set; }
        public virtual int Duplicates { get; set; }
        public virtual int NoIdentity { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

}

C# OutboundCampaignLaunchRequest DTOs

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

HTTP + 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
}