List SMS
This request returns a paginated list of SMS controls.
Results are ordered descending by send date and OID, so the most recent SMS control appears first.
The server has to support SMS messages in order for this request to succeed. See the system capabilities resource for more information.
Resource
GET /sms[?parameters]
Parameters
| Name | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
String |
Filter results. Supported filters:
|
||||||||||||||
|
[id] |
Paging: return results before the specified cursor ID. |
||||||||||||||
|
[id] |
Paging: return results after the specified cursor ID. |
||||||||||||||
|
Integer |
Maximum number of results to return. Default: 20. |
Paging
Paging uses a compound cursor based on epoch seconds and OID (epoch_oid). Results are always ordered descending by send date and OID.
Next page (older results)
Make the initial call:
GET /sms?limit=20
The response includes a meta.paging.nextId value. Pass this as the after parameter to fetch the next (older) page:
GET /sms?limit=20&after={nextId}
Previous page (newer results)
Use the meta.paging.previousId value and pass it as the before parameter:
GET /sms?limit=20&before={previousId}
If the number of returned results is less than the limit, there are no more older results.
Payload
None
Response
Context
| Authorization |
User |
Errors
Example
GET https://xelion.nl/api/v1/master/sms?limit=2&where=status=sent
{
"data": [
{
"object": {
"fromAddressee": {
"commonName": "John Smith",
"address": "+31612345678",
"addressable": {
"commonName": "John Smith",
"oid": "1556377",
"objectType": "Person"
},
"addresseeLabel": "John Smith",
"oid": "2121030",
"objectType": "Addressee"
},
"sendOnDate": "2026-01-01 10:00:00",
"subject": "Bird lives",
"wantConfirmation": false,
"toAddressees": [
{
"referable": {
"commonName": "Charlie Parker",
"oid": "1557797",
"objectType": "Person"
},
"phoneNumber": "+31612345679",
"oid": "2121031",
"objectType": "RelSMSControlReferable"
},
{
"referable": {
"commonName": "Customers",
"oid": "1602214",
"objectType": "X1List"
},
"phoneNumber": "",
"oid": "2121032",
"objectType": "RelSMSControlReferable"
}
],
"messageText": "Bird lives!",
"status": "sent",
"smsObjectType": "control",
"smsHttpReplyTo": "John Smith",
"phoneLine": {
"commonName": "John Smith",
"oid": "1651226",
"objectType": "XCCPhoneLine"
},
"commonName": "Bird lives",
"oid": "2121029",
"objectType": "SMSControl"
}
},
{
"object": {
"fromAddressee": {
"commonName": "John Smith",
"address": "+31612345678",
"addressable": {
"commonName": "John Smith",
"oid": "1556377",
"objectType": "Person"
},
"addresseeLabel": "John Smith",
"oid": "2120988",
"objectType": "Addressee"
},
"sendOnDate": "2025-12-15 09:30:00",
"subject": "Bird still lives",
"wantConfirmation": false,
"toAddressees": [
{
"referable": {
"commonName": "Dizzy Gillespie",
"oid": "1558012",
"objectType": "Person"
},
"phoneNumber": "+31612345670",
"oid": "2120989",
"objectType": "RelSMSControlReferable"
}
],
"messageText": "Bird still lives!",
"status": "sent",
"smsObjectType": "control",
"smsHttpReplyTo": "John Smith",
"phoneLine": {
"commonName": "John Smith",
"oid": "1651226",
"objectType": "XCCPhoneLine"
},
"commonName": "Bird still lives",
"oid": "2120987",
"objectType": "SMSControl"
}
}
],
"meta": {
"links": [
{
"rel": "refresh",
"href": "https://xelion.nl/api/v1/master/sms",
"method": "GET"
},
{
"rel": "next",
"href": "https://xelion.nl/api/v1/master/sms?after=1765787400_2120987",
"method": "GET"
},
{
"rel": "previous",
"href": "https://xelion.nl/api/v1/master/sms?before=1767258000_2121029",
"method": "GET"
}
],
"paging": {
"previousId": "1767258000_2121029",
"nextId": "1765787400_2120987"
}
}
}