| Required role: | Admin |
| POST | /Outbound/EnqueueBatch |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;
namespace TicketUserServices.ServiceModel
{
public partial class OutboundEnqueueBatchRejection
{
public virtual int Index { get; set; }
public virtual string DedupKey { get; set; }
public virtual string Reason { get; set; }
}
public partial class OutboundEnqueueBatchRequest
{
public OutboundEnqueueBatchRequest()
{
Messages = new List<OutboundEnqueueRequest>{};
}
public virtual List<OutboundEnqueueRequest> Messages { get; set; }
}
public partial class OutboundEnqueueBatchResult
{
public OutboundEnqueueBatchResult()
{
Rejections = new List<OutboundEnqueueBatchRejection>{};
}
public virtual int Enqueued { get; set; }
public virtual int Duplicate { get; set; }
public virtual int Rejected { get; set; }
public virtual List<OutboundEnqueueBatchRejection> Rejections { get; set; }
public virtual int StatusCode { get; set; }
public virtual string Message { get; set; }
}
public partial class OutboundEnqueueRequest
{
public virtual string Channel { get; set; }
public virtual string Lane { get; set; }
public virtual int Priority { get; set; }
public virtual string Address { get; set; }
public virtual string Platform { get; set; }
public virtual string RecipientKey { get; set; }
public virtual string TemplateKey { get; set; }
public virtual string Language { get; set; }
public virtual string PayloadJson { get; set; }
public virtual string DedupKey { get; set; }
public virtual int? CampaignId { get; set; }
public virtual int? OwnerId { get; set; }
public virtual string GuardKey { get; set; }
public virtual string GuardSubject { get; set; }
public virtual DateTime? NotBefore { get; set; }
public virtual DateTime? ExpiresAt { get; set; }
}
}
C# OutboundEnqueueBatchRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>