Documentation
SMS API Messages

Messages

List messages in a batch and read the complete status history of an individual message.

Each recipient in a batch gets a separate message document. The list shows the latest status; an individual document shows the complete status history.

Endpoints

Method Path Description
GET /v2/batches/{batchId}/messages List all messages in the batch.
GET /v2/batches/{batchId}/messages/{messageId} Read a message and its status history.

List messages

curl "https://api.ip1sms.com/v2/batches/{batchId}/messages" \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Accept: application/json"

The result is chronological and paginated. Each document contains the latest available status.

Read a message

curl "https://api.ip1sms.com/v2/batches/{batchId}/messages/{messageId}" \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Accept: application/json"

The response for a single message contains the complete statuses list.

Example message document

{
  "id": "message_abc123",
  "batchId": "batch_abc123",
  "owner": "ip1-XXXXX",
  "sender": "YourCompany",
  "recipient": "46700000000",
  "body": "Your booking is confirmed.",
  "direction": "MT",
  "segments": 1,
  "type": "sms",
  "datacoding": "ucs",
  "priority": 1,
  "price": 0.0416,
  "currency": "SEK",
  "statuses": [
    {
      "created": "2026-10-05T08:03:21Z",
      "code": 201,
      "duration": 0
    }
  ],
  "modified": "2026-10-05T08:03:21Z",
  "reference": "order-123",
  "mcc": "240",
  "mnc": "01"
}

Fields

Field Type Description
id string Unique message ID.
batchId string Parent batch.
owner string Owning SMS account.
sender string Message sender.
recipient string Recipient’s MSISDN.
body string Final message text for the recipient.
direction string MT for outbound, MO for inbound.
segments integer Number of SMS segments.
type string Message type.
datacoding string Minimum required encoding, gsm or ucs.
priority integer Delivery priority.
price number Total cost of the message’s segments.
currency string Price currency.
statuses object[] Status events with created, code and duration.
modified string Latest update in ISO 8601.
reference string | null Your own reference from the batch.
mcc string | null Mobile Country Code when supplied by the operator.
mnc string | null Mobile Network Code when supplied by the operator.

A message can consist of several billable SMS segments. Do not divide the price without also checking segments. See Status codes to interpret statuses[].code.

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