Get SMS
This request returns the information of an SMS control.
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/<OID>
Where OID is the object ID of the SMS control.
Parameters
Payload
None
Response
Context
| Authorization |
User |
Errors
Example
Request
GET https://xelion.nl/api/v1/master/sms/2121029
Response
{
"object": {
"fromAddressee": {
"commonName": "John Smith",
"role": "rtFrom",
"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": "",
"listAddresses": [
{
"phoneNumber": "+31612345670",
"addressable": {
"commonName": "Dizzy Gillespie",
"oid": "1558012",
"objectType": "Person"
},
"oid": "2121033",
"objectType": "SMSListAddress"
},
{
"phoneNumber": "+31612345671",
"addressable": {
"commonName": "Thelonious Monk",
"oid": "1558047",
"objectType": "Person"
},
"oid": "2121034",
"objectType": "SMSListAddress"
}
],
"oid": "2121032",
"objectType": "RelSMSControlReferable"
}
],
"substitutionVars": [
{
"valueName": "introduction",
"valueDescription": "This is the introduction",
"value": "G'day mate",
"oid": "2545479",
"objectType": "SMSVariable"
}
],
"messageText": "Bird lives!",
"status": "scheduled",
"smsObjectType": "control",
"smsHttpReplyTo": "John Smith",
"phoneLine": {
"permissions": "ReadWriteRemove",
"commonName": "John Smith",
"oid": "1651226",
"objectType": "XCCPhoneLine"
},
"permissions": "ReadWriteRemove",
"commonName": "Bird lives",
"oid": "2121029",
"objectType": "SMSControl"
},
"links": [
{
"rel": "self",
"href": "https://xelion.nl/api/v1/master/sms/2121029",
"method": "GET"
}
]
}