TicketUserServices

OutboundCampaignLaunchRequest

**Requires Authentication**
Required role:	Admin

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

**OutboundCampaignLaunchRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CampaignId	path	int	No
People	body	List<OutboundCampaignPerson>	No

**OutboundCampaignPerson** Parameters:
Name	Parameter	Data Type	Required
Phone	form	string	No
Email	form	string	No
Devices	form	List<OutboundCampaignDevice>	No
PushConsent	form	bool?	No
SmsConsent	form	bool?	No
EmailConsent	form	bool?	No
PayloadJson	form	string	No

**OutboundCampaignDevice** Parameters:
Name	Parameter	Data Type	Required	Description
Token	form	string	No
Platform	form	string	No

**OutboundCampaignResult** Parameters:
Name	Parameter	Data Type	Required
CampaignId	form	int	No
Decisions	form	Dictionary<string, int>	No
QueuedByChannel	form	Dictionary<string, int>	No
MessageStatuses	form	Dictionary<string, int>	No
Duplicates	form	int	No
NoIdentity	form	int	No
StatusCode	form	int	No
Message	form	string	No

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
}