TicketUserServices

<back to all web services

OutboundEnqueueBatchRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/Outbound/EnqueueBatch
OutboundEnqueueBatchRequest Parameters:
NameParameterData TypeRequiredDescription
MessagesbodyList<OutboundEnqueueRequest>No
OutboundEnqueueRequest Parameters:
NameParameterData TypeRequiredDescription
ChannelformstringNo
LaneformstringNo
PriorityformintNo
AddressformstringNo
PlatformformstringNo
RecipientKeyformstringNo
TemplateKeyformstringNo
LanguageformstringNo
PayloadJsonformstringNo
DedupKeyformstringNo
CampaignIdformint?No
OwnerIdformint?No
GuardKeyformstringNo
GuardSubjectformstringNo
NotBeforeformDateTime?No
ExpiresAtformDateTime?No
OutboundEnqueueBatchResult Parameters:
NameParameterData TypeRequiredDescription
EnqueuedformintNo
DuplicateformintNo
RejectedformintNo
RejectionsformList<OutboundEnqueueBatchRejection>No
StatusCodeformintNo
MessageformstringNo
OutboundEnqueueBatchRejection Parameters:
NameParameterData TypeRequiredDescription
IndexformintNo
DedupKeyformstringNo
ReasonformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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-01T00:00:00.0000000","expiresAt":"0001-01-01T00:00:00.0000000"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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