Documentation
SMS API Messages

Conversations

Retrieve inbound, outbound and summarized SMS data for a participant.

Conversation endpoints collect messages to and from a participant. The participant is normally specified as an MSISDN.

Endpoints

Method Path Description
GET /v2/conversations/{participant} All directions.
GET /v2/conversations/{participant}/mt Outbound SMS, Mobile Terminated.
GET /v2/conversations/{participant}/mo Inbound SMS, Mobile Originated.
GET /v2/conversations/{participant}/summary Aggregated summary.

The previous page’s quickstart incorrectly specified POST; the endpoint descriptions and read behavior specify GET, which is used here.

Retrieve messages

curl "https://api.ip1sms.com/v2/conversations/46700000000?start=0&limit=50&order=DESC" \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Accept: application/json"

Switch to /mt or /mo when you need only one direction. The result is a paginated list in the same document format as Messages.

Parameter Required Type Description
participant Yes string Participant’s MSISDN, for example 46700000000.
start No integer Starting position.
limit No integer Page size.
order No string ASC or DESC.

Summary

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

Summary fields

Field Type Description
participant string MSISDN or, where supported by the API, an alphanumeric sender.
totalMessageCount integer Total number of messages.
totalSmsCount integer Total number of SMS segments.
mobileTerminatedMessages object Outbound messages grouped by latest status code.
mobileOriginatedMessages object Inbound messages grouped by latest status code.

Conversation data may contain personal data and message content. Restrict access and do not retain a local copy longer than the business requires.

Choose the purposes you consent to. Necessary storage is used only to remember your choice.