TicketUserServices

<back to all web services

OutboundEnqueueRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/Outbound/Enqueue

export class OutboundEnqueueResult
{
    public status?: string;
    public messageId?: number;
    public reason?: string;
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<OutboundEnqueueResult>) { (Object as any).assign(this, init); }
}

export class OutboundEnqueueRequest
{
    public channel?: string;
    public lane?: string;
    public priority?: number;
    public address?: string;
    public platform?: string;
    public recipientKey?: string;
    public templateKey?: string;
    public language?: string;
    public payloadJson?: string;
    public dedupKey?: string;
    public campaignId?: number;
    public ownerId?: number;
    public guardKey?: string;
    public guardSubject?: string;
    public notBefore?: string;
    public expiresAt?: string;

    public constructor(init?: Partial<OutboundEnqueueRequest>) { (Object as any).assign(this, init); }
}

TypeScript OutboundEnqueueRequest DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<OutboundEnqueueRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Address>String</Address>
  <CampaignId>0</CampaignId>
  <Channel>String</Channel>
  <DedupKey>String</DedupKey>
  <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
  <GuardKey>String</GuardKey>
  <GuardSubject>String</GuardSubject>
  <Lane>String</Lane>
  <Language>String</Language>
  <NotBefore>0001-01-01T00:00:00</NotBefore>
  <OwnerId>0</OwnerId>
  <PayloadJson>String</PayloadJson>
  <Platform>String</Platform>
  <Priority>0</Priority>
  <RecipientKey>String</RecipientKey>
  <TemplateKey>String</TemplateKey>
</OutboundEnqueueRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OutboundEnqueueResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>String</Message>
  <MessageId>0</MessageId>
  <Reason>String</Reason>
  <Status>String</Status>
  <StatusCode>0</StatusCode>
</OutboundEnqueueResult>