TicketUserServices

<back to all web services

OutboundEnqueueBatchRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/Outbound/EnqueueBatch
import java.math.*
import java.util.*
import net.servicestack.client.*


open class OutboundEnqueueBatchRequest
{
    var messages:ArrayList<OutboundEnqueueRequest> = ArrayList<OutboundEnqueueRequest>()
}

open class OutboundEnqueueRequest
{
    var channel:String? = null
    var lane:String? = null
    var priority:Int? = null
    var address:String? = null
    var platform:String? = null
    var recipientKey:String? = null
    var templateKey:String? = null
    var language:String? = null
    var payloadJson:String? = null
    var dedupKey:String? = null
    var campaignId:Int? = null
    var ownerId:Int? = null
    var guardKey:String? = null
    var guardSubject:String? = null
    var notBefore:Date? = null
    var expiresAt:Date? = null
}

open class OutboundEnqueueBatchResult
{
    var enqueued:Int? = null
    var duplicate:Int? = null
    var rejected:Int? = null
    var rejections:ArrayList<OutboundEnqueueBatchRejection> = ArrayList<OutboundEnqueueBatchRejection>()
    var statusCode:Int? = null
    var message:String? = null
}

open class OutboundEnqueueBatchRejection
{
    var index:Int? = null
    var dedupKey:String? = null
    var reason:String? = null
}

Kotlin OutboundEnqueueBatchRequest 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/EnqueueBatch HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	messages: 
	[
		{
			channel: String,
			lane: String,
			priority: 0,
			address: String,
			platform: String,
			recipientKey: String,
			templateKey: String,
			language: String,
			payloadJson: String,
			dedupKey: String,
			campaignId: 0,
			ownerId: 0,
			guardKey: String,
			guardSubject: String,
			notBefore: 0001-01-01,
			expiresAt: 0001-01-01
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	enqueued: 0,
	duplicate: 0,
	rejected: 0,
	rejections: 
	[
		{
			index: 0,
			dedupKey: String,
			reason: String
		}
	],
	statusCode: 0,
	message: String
}