Konversationer

Läs meddelanden till och/eller från en tillhandahållen deltagare.

Quick start

Använd exemplet nedan och byt ut “API_NYCKEL” mot en bearer token som du skapar i användarportalen samt byt ut {participant} mot ett nummer i formatet MSISDN (46712345678)

curl -X POST "https://api.ip1sms.com/v2/conversations/{participant}" \
-H "Authorization: Bearer API_NYCKEL" \
-H "Content-Type: application/json" \

Anrop

Hämta alla meddelanden

Denna endpoint låter dig hämta samtliga meddelanden i en konversation, oavsett riktning, baserat på mottagaren eller avsändarens nummer.

Endpoint: /v2/conversations/{participant}

Metod: GET

Exempel på anrop

https://api.ip1sms.com/v2/conversations/46712345678

Hämta alla utgående meddelanden

Denna endpoint låter dig hämta utgående meddelanden i en konversation baserat på en angiven deltagare. mt är en akronym för mobile terminated.

Endpoint: /v2/conversations/{participant}/mt

Metod: GET

Exempel på anrop

https://api.ip1sms.com/v2/conversations/46712345678/mt

Hämta alla inkommande meddelanden

Denna endpoint låter dig hämta inkommande meddelanden i en konversation baserat på angiven deltagare. mo är en akronym för mobile originated.

Endpoint: /v2/conversations/{participant}/mo

Metod: GET

Exempel på anrop

https://api.ip1sms.com/v2/conversations/46712345678/mo

Hämta en sammanfattning över meddelanden

Förutom att läsa meddelanden till och ett specifikt MSISDN (Mobilnummer) tillhandahåller vi också en endpoint som ger dig en aggregerad summering för meddelanden separerat mellan mt och mo

Endpoint /v2/conversations/{participant}/summary

Metod: GET

Exempel på anrop

https://api.ip1sms.com/v2/conversations/46712345678/summary

Fält för anropsdata

FältnamnObligatoriskTypBeskrivning och VillkorExempel
participantJaString En deltagares nummer i formatet MSISDN (46712345678).

46712345678

Respons

Responsdata för ett anrop till /v2/conversations/{participant}/mt, /v2/conversations/{participant}/mo samt /v2/conversations/{participant} returnerar en paginerad lista likt respons-datan för listning av meddelanden.

Exempel på responsdata (Meddelanden)

{
    "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 (Meddelanden)

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 innehållandes den senaste statusen för varje meddelande.

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

Exempel på responsdata (Sammanfattning)

{
    "participant": "46734487112",
    "totalMessageCount": 387,
    "totalSmsCount": 774,
    "mobileTerminatedMessages": {
        "101": {
            "messages": 43,
            "sms": 86
        },
        "102": {
            "messages": 3,
            "sms": 6
        },
        "201": {
            "messages": 142,
            "sms": 284
        }
    },
    "mobileOriginatedMessages": {
        "201": {
            "messages": 199,
            "sms": 398
        }
    }
}

Fält för responsdata (Sammanfattning)

FältnamnTypBeskrivning och VillkorExempel
participantString En deltagare är antingen ett MSISDN (Mobilnummer) eller en alfanumerisk avsändare (Textavsändare). Detta fält talar vilken typ av deltagare det handlar om.

"participant": "46734487112"
totalMessageCountInteger Den totala mängden meddelanden kopplade till deltagaren.

"totalMessageCount": 387
totalSmsCountString Den totala mängden SMS-segment kopplade till deltagaren.

"totalSmsCount": 774,
mobileTerminatedMessagesNestat objekt En summering av meddelanden som skickats till deltagaren. Summeringen består av en dictionary där nyckelen är en statuskod och värdet är en count över hur många meddelanden (och meddelandets respektive SMS-segment) som har specifierad statuskod och som den senast tillagda statusen.

  "mobileTerminatedMessages": {
      "101": {
          "messages": 43,
          "sms": 86
      },
      "102": {
          "messages": 3,
          "sms": 6
      },
      "201": {
          "messages": 142,
          "sms": 284
      }
  },
mobileOriginatedMessagesNestat objekt En summering av meddelanden som skickats från deltagaren. Summeringen består av en dictionary där nyckelen är en statuskod och värdet är en count över hur många meddelanden (och meddelandets respektive SMS-segment) som har specifierad statuskod och som den senast tillagda statusen.

  "mobileOriginatedMessages": {
      "201": {
          "messages": 199,
          "sms": 398
      }
  }