TicketUserServices

<back to all web services

OutboundEnqueueRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/Outbound/Enqueue
OutboundEnqueueRequest Parameters:
NameParameterData TypeRequiredDescription
ChannelbodystringNo
LanebodystringNo
PrioritybodyintNo
AddressbodystringNo
PlatformbodystringNo
RecipientKeybodystringNo
TemplateKeybodystringNo
LanguagebodystringNo
PayloadJsonbodystringNo
DedupKeybodystringNo
CampaignIdbodyint?No
OwnerIdbodyint?No
GuardKeybodystringNo
GuardSubjectbodystringNo
NotBeforebodyDateTime?No
ExpiresAtbodyDateTime?No
OutboundEnqueueResult Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo
MessageIdformlong?No
ReasonformstringNo
StatusCodeformintNo
MessageformstringNo

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/Enqueue HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
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-01T00:00:00.0000000","expiresAt":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"status":"String","messageId":0,"reason":"String","statusCode":0,"message":"String"}