TicketUserServices

OutboundEnqueueBatchRequest

**Requires Authentication**
Required role:	Admin

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundEnqueueBatchRejection:
    index: Optional[int] = None
    dedup_key: Optional[str] = None
    reason: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundEnqueueBatchResult:
    enqueued: Optional[int] = None
    duplicate: Optional[int] = None
    rejected: Optional[int] = None
    rejections: Optional[List[OutboundEnqueueBatchRejection]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundEnqueueRequest:
    channel: Optional[str] = None
    lane: Optional[str] = None
    priority: Optional[int] = None
    address: Optional[str] = None
    platform: Optional[str] = None
    recipient_key: Optional[str] = None
    template_key: Optional[str] = None
    language: Optional[str] = None
    payload_json: Optional[str] = None
    dedup_key: Optional[str] = None
    campaign_id: Optional[int] = None
    owner_id: Optional[int] = None
    guard_key: Optional[str] = None
    guard_subject: Optional[str] = None
    not_before: Optional[datetime.datetime] = None
    expires_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundEnqueueBatchRequest:
    messages: Optional[List[OutboundEnqueueRequest]] = None

Python OutboundEnqueueBatchRequest DTOs

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"}