Lista Meddelanden

Förutsättningar

När du listar meddelanden är det alltid i kontexten av en batch. Ett meddelande kan inte existera utanför en batch, därför är alltid ett meddelande placerat hierarkiskt underordnat en batch.

Quick start

Använd exemplet nedan och byt ut “API_NYCKEL” mot en bearer token som du skapar i användarportalen, samt {batchId} mot ett faktiskt batch-id.

curl -X GET "https://api.ip1sms.com/v2/batches/{batchId}/messages" \
-H "Authorization: Bearer API_NYCKEL" \
-H "Content-Type: application/json" \

Anrop

Lista en samling av meddelanden

Denna endpoint förser dig med alla meddelanden i en batch med senaste tillhörande leveransrapporter. Sorterade efter skapad datum, kronologisk ordning.

Endpoint: /v2/batches/{batchId}/messages

Metod: GET

Exempel på anrop

https://api.ip1sms.com/batches/5bc86b6e85c7209830f96936/messages

Lista ett enskilt meddelande

Denna endpoint förser dig med ett enskillt meddelande, med full historik över meddelandets leveransrapporter.

Endpoint: /v2/batches/{batchId}/messages/{messageId}

Metod: GET

Exempel på anrop

https://api.ip1sms.com/batches/5bc86b6e85c7209830f96936/messages/5bcf4324ee47dee41a9dbb13

Fält för anrop

FältnamnOblogatorisktTypBeskrivning och VillkorExempel
batchIdJaString Den övergripande batchens id

5bc86b6e85c7209830f96936
messageIdJa, vid listning av specifikt meddelandeString Ett unikt id för ett specifikt meddelande.

5bcf4324ee47dee41a9dbb13

Respons

Exempel på responsdata

Nedan hittar du ett exempel på respons fråne tt lyckat anrop till endpointen /v2/batches/{batchId}/messages/{messageId}, alltså ett GET anrop för att lista ett specifikt meddelande. Se under rubriken Fält för responsdata för en detaljerad beskrivning av samtliga fält i responsen.

{
    "id": "5bcf4324ee47dee41a9dbb13",
    "batchId": "5bc86b6e85c7209830f96936",
    "owner": "ip1-XXXXX",
    "sender": "iP1",
    "recipient": "456189040623",
    "body": "Hi my name is earl",
    "direction": "mt",
    "segments": 1,
    "type":"SMS",
    "datacoding": "ucs",
    "priority": 1,
    "price": 0.0416,
    "currency": "EUR",
    "statuses": [
        {
            "created": "2018-10-23T17:43:21Z",
            "code": 201,
            "duration": 0
        }
    ],
    "modified": "2018-10-23T17:43:19Z",
    "reference": "A client reference",
    "mcc": "431",
    "mnc": "20"
}

Fält för responsdata

FältnamnTypBeskrivning och VillkorExempel
idString Ett unikt id för ett detta specifika meddelande.

"id": "5bcf4324ee47dee41a9dbb13"
batchIdString Den övergripande batchens id

"batchId": "5bc86b6e85c7209830f96936"
ownerString SMS-kontots ID, ägare för det specifika meddelandet.

"owner": "ip1-XXXXX"
senderString Avsändaren för meddelandet

"sender": "iP1"
recipientString Mottagarens mobilnummer

"recipient": "456189040623"
bodyString Själva meddelandet

"body": "Hi my name is earl"
directionString Talar om ifall meddelandet skickades eller togs emot av vårt system.
  • MT En akronym för Mobile Terminated, ett meddelande som skickades till en mobil enhet.
  • MO En akronym för Mobile Originated, ett meddelande som skickades från en mobil enhet.

 "direction": "MT"
segmentsString I de fall meddelandet består av fler tecken än teckengränsen för ett SMS kommer meddelandet att delas upp i flera SMS, även kallat konkatenerade SMS. Den här egenskapen indikerar om hur många SMS som behövs för att kunna skicka meddelandet

"segments": 1
datacodingString Anger det minsta datakodningsschema som behövs för att skicka meddelandet i fråga. Om meddelandetexten innehåller tecken utanför den angivna datakodningen skickas inte meddelandet, vilket den senaste statuskoden ska visa. Detta kan skilja sig från batchens datakodning.

"datacoding": "ucs"
priorityStringMeddelandets prioritet. Prioritet 1 är standardvärdet och samtidigt den lägsta prioritet som tillhandahålls. Prioritet 2 är den högsta prioriteten.

 "priority": 1
priceStringHela meddelandets pris. Vill du veta priset för ett enskilt SMS i ett meddelande, kan du dela meddelandets pris med antalet segment.

 "price": 0.0416
currencyStringVilken valuta som meddelandets pris använder.

  "currency": "EUR",
statusesArrayEn lista bestående av statusuppdateringar. Vid hämtning av ett enskilt meddelande så får man en lista av meddelandets samtliga statusar. Vid hämtning av lista för flera meddelanden listas enbart varje meddelandes senaste status.

 "statuses": [
    {
        "created": "2018-10-23T17:43:21Z",
        "code": 201,
        "duration": 0
    }
],
modifiedStringNär SMS:et senast uppdaterades

"modified": "2018-10-23T17:43:19Z",
referenceStringDetta är en egenskap som tillåter användaren att sätta ett eget ID eller referens om lagring av standard-genererade ID´n ogillas.

"reference": "A client reference",
mccStringLands-delen av bladoperatören kan specificeras här om den tillhandahålls av uppströms-bäraren. MCC är en akronym för Mobile Country Code

"mcc": "431",
mncStringNätverks-delen av bladoperatören kan specificeras här om den tillhandahålls av uppströms-bäraren. MNC är en akronym för Mobile Network Code

"mnc": "20"