SMS

Search SMS

Search for your SMS messages.

get/sms

Request

Base URL
https://api.callr.com/v2.0
URL
https://api.callr.com/v2.0/sms
Auth
- API key in header x-api-key
- or HTTP basic

Query parameters

direction'inbound' | 'outbound' required

The direction. Inbound is a call or an SMS received by the Callr platform. Outbound is a call or an SMS initiated by the Callr platform.

Example:inbound

outbound for the SMS you sent, inbound for the SMS you received

string

A phone number in ITU-T E.164 format https://en.wikipedia.org/wiki/E.164, prefixed by "+"

Example:+33199001234

SMS sender

tostring

A phone number in ITU-T E.164 format https://en.wikipedia.org/wiki/E.164, prefixed by "+"

Example:+33199001234

SMS to

containsstring

SMS text body contains

trafficType'marketing' | 'alerting'

Traffic type of an SMS message. Carriers require this to be set to either marketing or alerting.

Example:marketing

SMS traffic type

The status of the SMS.

created = The SMS has been created. error = The SMS has an error. expired = The SMS has expired. failed = The SMS has failed. pending = The SMS is waiting to be sent on our side. delivered = The SMS has been delivered to the recipient. remote-queued = The SMS is queued on the remote side. sent = The SMS has been sent.

Example:sent

createdAfterstring date-time required

RFC 3339, section 5.6

Example:2024-04-24T17:42:28Z

Return the SMS created after this date

createdBeforestring date-time required

RFC 3339, section 5.6

Example:2024-04-24T17:42:28Z

Return the SMS created before this date

sort'created' | 'updated'

Sort by one field

order'asc' | 'desc'

Sort order (ascending or descending)

offsetinteger

Offset index (zero-based)

Search offset index (zero-based)

limitinteger

Limit search results

Example:20

Number of items to return

Response

Search results

offsetinteger required

Offset index (zero-based)

totalinteger required

hasMoreboolean required

Whether there are more results available

Example response

{
  "total": 20,
  "hits": [
    {
      "direction": "inbound",
      "sid": "callrsid",
      "from": "+33199001234",
      "to": "+33199001234",
      "body": {
        "text": "Hello world!"
      },
      "trafficType": "marketing",
      "status": "sent",
      "created": "2024-04-24T17:42:28Z",
      "delivered": "2024-04-24T17:42:28Z",
      "updated": "2024-04-24T17:42:28Z",
      "sent": "2024-04-24T17:42:28Z",
      "parts": 10,
      "network": "20801",
      "encoding": "gsm",
      "cost": "5.50",
      "paymentType": "prepaid",
      "statusHistory": [
        {
          "after": "sent",
          "before": "sent",
          "at": "2024-04-24T17:42:28Z"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.