TicketUserServices

OutboundEnqueueBatchRequest

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/Outbound/EnqueueBatch


export class OutboundEnqueueBatchRejection
{
    public index?: number;
    public dedupKey?: string;
    public reason?: string;

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

export class OutboundEnqueueBatchResult
{
    public enqueued?: number;
    public duplicate?: number;
    public rejected?: number;
    public rejections?: OutboundEnqueueBatchRejection[];
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<OutboundEnqueueBatchResult>) { (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); }
}

export class OutboundEnqueueBatchRequest
{
    public messages?: OutboundEnqueueRequest[];

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

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

<OutboundEnqueueBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Messages>
    <OutboundEnqueueRequest>
      <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>
  </Messages>
</OutboundEnqueueBatchRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OutboundEnqueueBatchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Duplicate>0</Duplicate>
  <Enqueued>0</Enqueued>
  <Message>String</Message>
  <Rejected>0</Rejected>
  <Rejections>
    <OutboundEnqueueBatchRejection>
      <DedupKey>String</DedupKey>
      <Index>0</Index>
      <Reason>String</Reason>
    </OutboundEnqueueBatchRejection>
  </Rejections>
  <StatusCode>0</StatusCode>
</OutboundEnqueueBatchResult>