List SMS Messages
This request returns a list of the SMS messages that belong to an SMS control.
When an SMS control is sent, an SMS message is created for each individual recipient and linked to the SMS control. This request can be used to retrieve those messages, including the status of each individual message.
The server has to support SMS messages in order for this request to succeed. See the system capabilities resource for more information.
Note: the SMS messages are only created once the SMS control is sent. For an SMS control with the status concept,
or one that is still waiting for its sendOnDate, this request returns an empty list.
Resource
GET /sms/<OID>/messages[?parameters]
Where OID is the object ID of the SMS control.
Parameters
This request supports the same parameters as Search Communication, such as order, before, after, from and until.
Paging
Paging works the same as for Search Communication. See that page for a full description of paging in descending and ascending order.
Payload
None
Response
Context
| Authorization |
User |
Errors
Example
Request
GET https://xelion.nl/api/v1/master/sms/2121029/messages?limit=3
Response
{
"data": [
{
"object": {
"subject": "Bird lives",
"date": "2026-01-01 09:00:02",
"status": "Scheduled",
"incoming": false,
"participants": [
{
"commonName": "John Smith",
"role": "rtFrom",
"address": "+31612345678",
"addressable": {
"commonName": "John Smith",
"oid": "1556377",
"objectType": "Person"
},
"oid": "2121052",
"objectType": "Addressee"
},
{
"commonName": "Thelonious Monk",
"role": "rtTo",
"address": "+31612345671",
"addressable": {
"commonName": "Thelonious Monk",
"oid": "1558047",
"objectType": "Person"
},
"oid": "2121053",
"objectType": "Addressee"
}
],
"phoneLine": {
"commonName": "John Smith",
"oid": "1651226",
"objectType": "XCCPhoneLine"
},
"smsHttpStatusReport": {
"received": "2026-01-01 10:00:05",
"toNumber": "+31612345671",
"statusCode": "2",
"errorCode": "Delivered",
"errorDescription": "",
"oid": "2121060",
"objectType": "SMSHttpStatusReport"
},
"commonName": "Bird lives",
"oid": "2121051",
"objectType": "SMSMessage"
},
"links": [
{
"rel": "self",
"href": "https://xelion.nl/api/v1/master/communications/2121051",
"method": "GET"
}
]
},
{
"object": {
"subject": "Bird lives",
"date": "2026-01-01 09:00:01",
"status": "Scheduled",
"incoming": false,
"participants": [
{
"commonName": "John Smith",
"role": "rtFrom",
"address": "+31612345678",
"addressable": {
"commonName": "John Smith",
"oid": "1556377",
"objectType": "Person"
},
"oid": "2121048",
"objectType": "Addressee"
},
{
"commonName": "Dizzy Gillespie",
"role": "rtTo",
"address": "+31612345670",
"addressable": {
"commonName": "Dizzy Gillespie",
"oid": "1558012",
"objectType": "Person"
},
"oid": "2121049",
"objectType": "Addressee"
}
],
"phoneLine": {
"commonName": "John Smith",
"oid": "1651226",
"objectType": "XCCPhoneLine"
},
"smsHttpStatusReport": {
"received": "2026-01-01 10:00:04",
"toNumber": "+31612345670",
"statusCode": "3",
"errorCode": "Failed",
"errorDescription": "Message not delivered because the recipient was unreachable",
"oid": "2121059",
"objectType": "SMSHttpStatusReport"
},
"commonName": "Bird lives",
"oid": "2121047",
"objectType": "SMSMessage"
},
"links": [
{
"rel": "self",
"href": "https://xelion.nl/api/v1/master/communications/2121047",
"method": "GET"
}
]
},
{
"object": {
"subject": "Bird lives",
"date": "2026-01-01 09:00:00",
"status": "Scheduled",
"incoming": false,
"participants": [
{
"commonName": "John Smith",
"role": "rtFrom",
"address": "+31612345678",
"addressable": {
"commonName": "John Smith",
"oid": "1556377",
"objectType": "Person"
},
"oid": "2121044",
"objectType": "Addressee"
},
{
"commonName": "Charlie Parker",
"role": "rtTo",
"address": "+31612345679",
"addressable": {
"commonName": "Charlie Parker",
"oid": "1557797",
"objectType": "Person"
},
"oid": "2121045",
"objectType": "Addressee"
}
],
"phoneLine": {
"commonName": "John Smith",
"oid": "1651226",
"objectType": "XCCPhoneLine"
},
"smsHttpStatusReport": {
"received": "2026-01-01 10:00:03",
"toNumber": "+31612345679",
"statusCode": "2",
"errorCode": "Delivered",
"errorDescription": "",
"oid": "2121058",
"objectType": "SMSHttpStatusReport"
},
"commonName": "Bird lives",
"oid": "2121043",
"objectType": "SMSMessage"
},
"links": [
{
"rel": "self",
"href": "https://xelion.nl/api/v1/master/communications/2121043",
"method": "GET"
}
]
}
],
"meta": {
"links": [
{
"rel": "refresh",
"href": "https://xelion.nl/api/v1/master/sms/2121029/messages",
"method": "GET"
},
{
"rel": "next",
"href": "https://xelion.nl/api/v1/master/sms/2121029/messages?after=2121051",
"method": "GET"
},
{
"rel": "previous",
"href": "https://xelion.nl/api/v1/master/sms/2121029/messages?before=2121043",
"method": "GET"
}
],
"paging": {
"previousId": "2121043",
"nextId": "2121051"
}
}
}