E-postbatcher – En grupp av e-postmeddelanden

Läsa en samling av e-postbatcher

Endpoint: GET emails

Den här endpointen ger dig en samling e-postbatcher för vilka du kan se e-post dokument-definitionen nedan. MessageSummary och PriceSummary kommer dock inte att tillhandahållas eftersom de endast är tillgängliga för den endpointen för enskilda meddelanden i en e-postbatch. Ordnad kronologiskt efter skapandedatum.

Läs en enskild e-postbatch

Endpoint: GET emails/{emailId}

Denna endpoint kommer att ge dig enda e-postbatch som ger dig det totala priset för ett e-postmeddelande samt en sammanfattning av statusen för e-postmeddelandena.

Respons-datatypen

{
    "id": "5bc86b6e85c7209830f96936",
    "owner": "ip1-XXXXX",
    "senderName": "Sample Corp",
    "senderAddress": "info@example.com",
    "subject": "Sample Email",
    "body": "This is a sample email in {text} text to {name}",
    "type": "Text",
    "priority": 1,
    "templated": true,
    "reference": "A client reference",
    "deliveryReportUrl": "https://api.example.com/email/deliveryreport",
    "priceSummary": {
        "total": 1.88,
        "currency": "EUR",
        "average": 0.01
    },
    "messageSummary": {
        "101": {
          "messages": 43
        },
        "102": {
          "messages": 3
        },
        "201": {
          "messages": 142
        }
    },
    "tags": ["marketing", "ux", "design"],
    "deliveryWindows": [
        {
            "opens": "ISO-8601 string",
            "closes": "ISO-8601 string"
        },
        {
            "opens": "ISO-8601 string",
            "closes": "ISO-8601 string"
        }
    ]
}

id

Ett unikt id för en specifik e-postbatch.

owner

Kontonumret för kontot som äger e-postbatchen (Exempelvis du).

senderName

Namnet som är kopplat till avsändaradressen. Kan vara vad som helst, max 64 tecken

senderAddress

Avsändarens e-postadress som e-postmeddelandet kommer att skickas från. Alla giltiga e-postadresser för en registrerad och verifierad domän.

subject

E-postmeddelandets ämnesrad. Max 78 tecken.

body

Innehållet i e-postbatchens meddelanden. Oformaterad text eller HTML beroende på vilken typ som används.

type

Vilken typ av e-postmeddelanden som ska skickas som avgör hur body-parametern används, beskrivningar nedan

priority

Om det är mycket viktigt för dig att dina meddelanden kommer fram snabbt och inte hindras av våra andra meddelanden i kön kan du prioritera högre. Att prioritera ett högre värde kommer dock att höja priset med 10 öre (0,01 EUR). Prioritet 1 är standard och är den lägsta prioritet som är tillgänglig, och prioritet 2 är den högsta tillgängliga prioriteten. Om det anges är 1 och 2 de enda giltiga värdena.

templated

Om Tempalting användes eller inte.

reference

Detta är en egenskap som gör att användaren av detta API kan ha sitt eget ID eller referens om lagring av iP.1:s genererade ID inte föredras.

deliveryReportUrl

Om det tillhandahålls kommer rapporter om statusuppdateringar att skickas till denna URL via POST. Dessa rapporter är separata för varje meddelandemottagare och varje statusuppdatering. För ytterligare information om dessa rapporter, se Ta emot leveransrapporter.

priceSummary

priceSummary.total Det totala priset för e-postmeddelandet. Detta värde kan ändras om meddelanden avvisas av nästa uppströmsoperatör i vilket fall betalningen för det specifika meddelandet kommer att annulleras.

priceSummary.currency Vilken valuta totalt och genomsnitt anges i.

priceSummary.average Det genomsnittliga priset för ett enskilt meddelande i paketet.

messageSummary

Det här är en dictionary där nyckeln är en statuskod och värdet är antalet meddelanden som har den statuskoden som senast lades till. För mer information om våra statuskoder för meddelanden, se vårt avsnitt om statuskoder.

tags

En rad taggar som används för att kategorisera/sortera e-postmeddelandet bland dina andra e-postmeddelanden. När du listar batcher kan du filtrera efter dessa taggar.

deliveryWindows

Om det finns ett behov av att schemalägga ett utskick i framtiden finns det möjlighet att göra det med våra leveranstidsfönster

Du kan ha hur många fönster som helst. Detta gör att du kan skicka meddelanden vid specifika tider under flera dagar, t.ex. varje dag mellan 10:00 och 10:05 på vardagar.