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
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type OutboundCampaignResult() = 
        member val CampaignId:Int32 = new Int32() with get,set
        member val Decisions:Dictionary<String, Int32> = new Dictionary<String, Int32>() with get,set
        member val QueuedByChannel:Dictionary<String, Int32> = new Dictionary<String, Int32>() with get,set
        member val MessageStatuses:Dictionary<String, Int32> = new Dictionary<String, Int32>() with get,set
        member val Duplicates:Int32 = new Int32() with get,set
        member val NoIdentity:Int32 = new Int32() with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type OutboundCampaignDevice() = 
        member val Token:String = null with get,set
        member val Platform:String = null with get,set

    [<AllowNullLiteral>]
    type OutboundCampaignPerson() = 
        member val Phone:String = null with get,set
        member val Email:String = null with get,set
        member val Devices:ResizeArray<OutboundCampaignDevice> = new ResizeArray<OutboundCampaignDevice>() with get,set
        member val PushConsent:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val SmsConsent:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val EmailConsent:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val PayloadJson:String = null with get,set

    [<AllowNullLiteral>]
    type OutboundCampaignLaunchRequest() = 
        member val CampaignId:Int32 = new Int32() with get,set
        member val People:ResizeArray<OutboundCampaignPerson> = new ResizeArray<OutboundCampaignPerson>() with get,set

F# OutboundCampaignLaunchRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"campaignId":0,"decisions":{"String":0},"queuedByChannel":{"String":0},"messageStatuses":{"String":0},"duplicates":0,"noIdentity":0,"statusCode":0,"message":"String"}