TicketUserServices

<back to all web services

OutboundEnqueueRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/Outbound/Enqueue
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class OutboundEnqueueRequest
            Public Overridable Property Channel As String
            Public Overridable Property Lane As String
            Public Overridable Property Priority As Integer
            Public Overridable Property Address As String
            Public Overridable Property Platform As String
            Public Overridable Property RecipientKey As String
            Public Overridable Property TemplateKey As String
            Public Overridable Property Language As String
            Public Overridable Property PayloadJson As String
            Public Overridable Property DedupKey As String
            Public Overridable Property CampaignId As Nullable(Of Integer)
            Public Overridable Property OwnerId As Nullable(Of Integer)
            Public Overridable Property GuardKey As String
            Public Overridable Property GuardSubject As String
            Public Overridable Property NotBefore As Nullable(Of Date)
            Public Overridable Property ExpiresAt As Nullable(Of Date)
        End Class

        Public Partial Class OutboundEnqueueResult
            Public Overridable Property Status As String
            Public Overridable Property MessageId As Nullable(Of Long)
            Public Overridable Property Reason As String
            Public Overridable Property Suppressed As Boolean
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class
    End Namespace
End Namespace

VB.NET OutboundEnqueueRequest 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/Enqueue HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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

{
	status: String,
	messageId: 0,
	reason: String,
	suppressed: False,
	statusCode: 0,
	message: String
}