Batch – Gruppering av meddelanden

Lista en samling av batcher

Endpoint: GET /v2/batches

Denna endpoint kommer att ge dig en samling av batcher, enligt batch definition nedan. Observera att messageSummary och priceSummary enbart är tillgänglig i endpointen för enskilda batcher. Batcher listas i kronologisk ordning efter datumet de skapades.

Lista en enskild Batch

Endpoint: GET batches/{batchId}

Den här endpointen kommer att lista en enskild batch, som innehåller total-priset för batchen, samt en summering av status för batchens meddelanden.

Responsdata-typ

{
    "id": "5bc86b6e85c7209830f96936",
    "sender": "46101606060",
    "body": "Hi my name is {name}",
    "owner": "ip1-XXXXX",
    "direction": "MT",
    "type": "flash",
    "datacoding": "GSM",
    "priority": 1,
    "templated": true,
    "priceSummary": {
        "total": 0.125,
        "currency": "EUR",
        "average": 0.0416
    },
    "messageSummary": {
        "101": {
          "messages": 43,
          "sms": 86
        },
        "102": {
          "messages": 3,
          "sms": 6
        },
        "201": {
          "messages": 142,
          "sms": 284
        }
    },
    "deliveryWindows": [
        {
            "opens": "ISO-8601 string",
            "closes": "ISO-8601 string"
        },
        {
            "opens": "ISO-8601 string",
            "closes": "ISO-8601 string"
        }
    ],
    "status": 112,
    "deliveryReportUrl": "https://api.example.com/sms/deliveryreport",
    "reference": "A client reference",
    "tags": ["marketing", "auth", "etc"],
}

sender

Avsändaren som används för ett eller flera meddelanden.

body

Den ursprungliga bodyn som skickas, före mallar har tillämpats, enligt den ursprungliga requesten.

owner

Kontonumret för SMS-kontot som står som ägare till batchen.

direction

Avgör om meddelandet skickades eller togs emot av vårt system.

mt En akronym för mobile terminated.
mo En akronym för mobile originated.

type

Det finns två typer som ett SMS kan ha:, sms och flash. sms är ett vanligt SMS medan flash är ett meddelande som visas en gång på enheten och sedan raderas. Standard-typen är sms.

datacoding

Specifierar det största setet datacoding som är tillåtet i batchen

priority

I fall det är ett viktigt att ditt meddelande levereas snabbt och ohindrat från andra i meddelande-kön kan du sätta en högre prioritet på ditt meddelande.

Observera att om du sätter en högre prioritet så ökar priset per SMS med 10 öre om du använder ett svenskt konto, eller € 0.01 om du använder ett internationellt konto.

Prioritet 1 är standard värdet och även det lägsta tillgängliga värdet, medan prioritet 2 är det högsta tillgänglia värdet. Om prioritet sätts så är 1 och 2 är de enda tillåtna värdena.

templated

Om templating användes i batchen eller inte.

priceSummary

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

priceSummary.currency
Vilken valuta total ochaverage are anges i.

priceSummary.average
Genomsnittspriset för ett enskilt meddelande i batchen. Observera att ett meddelande skiljer sig från SMS eftersom ett meddelande kan kräva flera SMS.

messageSummary

Detta är en dictionary där nyckeln är en statuskod och värdet är en count över hur många meddelanden (och deras motsvarande SMS-segment) som har den statuskod som senast lagts till. För mer information om våra statuskoder för meddelanden, se avsnittet om statuskoder.

deliveryWindows

Om det finns ett behov av att planera ett utskick i framtiden finns det möjlighet att göra det med våra leveransfönster. Dessa är de aktuella leveranstidfönstren för specifierad batch.

status

Aktuell status för batchen. Härleds från riktningen och den senaste statusen för batchens meddelanden. Tillgängliga statusar är följande:

Namn	statuskod	Kommentar
Planned	101	Batchen är schemalagd att skickas i framtiden.
Ongoing	111	Batchen håller på att bearbetas och skickas ut
Sent	112	Batchen har skickats ut
Incoming	201	Batchen innehåller inkommande meddelanden
Canceled	203	Batchen har avbrutits och kommer inte att skickas

deliveryReportUrl

Om detta tillhandahålls kommer rapporter med statusuppdateringar att skickas till denna URL genom metoden POST. Dessa rapporter är separerade för varje mottagare i ett meddelande och för varje status-uppdatering. Om du vill läsa mer om dessa rapporter kan du göra det i avsnittet för Leveransrapporter.

reference

Detta är en egenskap som tillåter användaren att sätta ett eget ID eller referens om lagring av standard-genererade ID´n ogillas.

Restrictions

• Får bestå av maximum 40 tecken
• Kan inte representeras av en tom sträng eller whitespace.

null standardvärdet.

tags

En array av taggar som används för att kategorisera eller sortera bland dina bastcher. När du listar dina batcher kan du filtrera efter dessa.