Konversationer
Hämta inkommande, utgående och sammanfattade SMS för en deltagare.
Konversations-endpoints samlar meddelanden till och från en deltagare. Deltagaren anges normalt som MSISDN.
Endpoints
| Metod | Sökväg | Beskrivning |
|---|---|---|
GET |
/v2/conversations/{participant} |
Alla riktningar. |
GET |
/v2/conversations/{participant}/mt |
Utgående SMS, Mobile Terminated. |
GET |
/v2/conversations/{participant}/mo |
Inkommande SMS, Mobile Originated. |
GET |
/v2/conversations/{participant}/summary |
Aggregerad sammanfattning. |
Den tidigare sidans quickstart angav felaktigt POST; endpointbeskrivningarna och läsbeteendet anger GET, vilket används här.
Hämta meddelanden
curl "https://api.ip1sms.com/v2/conversations/46700000000?start=0&limit=50&order=DESC" \
-H "Authorization: Bearer $IP1_TOKEN" \
-H "Accept: application/json"
Byt till /mt eller /mo när bara en riktning behövs. Resultatet är en paginerad lista med samma dokumentformat som i Meddelanden.
| Parameter | Krävs | Typ | Beskrivning |
|---|---|---|---|
participant |
Ja | string |
Deltagarens MSISDN, exempelvis 46700000000. |
start |
Nej | integer |
Startposition. |
limit |
Nej | integer |
Sidstorlek. |
order |
Nej | string |
ASC eller DESC. |
Sammanfattning
curl "https://api.ip1sms.com/v2/conversations/46700000000/summary" \
-H "Authorization: Bearer $IP1_TOKEN" \
-H "Accept: application/json"
{
"participant": "46700000000",
"totalMessageCount": 387,
"totalSmsCount": 412,
"mobileTerminatedMessages": {
"201": { "messages": 180, "sms": 196 }
},
"mobileOriginatedMessages": {
"201": { "messages": 207, "sms": 216 }
}
}
Fält i sammanfattningen
| Fält | Typ | Beskrivning |
|---|---|---|
participant |
string |
MSISDN eller, där API:et stöder det, alfanumerisk avsändare. |
totalMessageCount |
integer |
Totalt antal meddelanden. |
totalSmsCount |
integer |
Totalt antal SMS-segment. |
mobileTerminatedMessages |
object |
Utgående meddelanden grupperade efter senaste statuskod. |
mobileOriginatedMessages |
object |
Inkommande meddelanden grupperade efter senaste statuskod. |
Konversationsdata kan innehålla personuppgifter och meddelandeinnehåll. Begränsa åtkomsten och lagra inte en lokal kopia längre än verksamheten kräver.
