List SMS Addresses
This request returns the SMS addresses of all recipients in a list.
It can be used to see which recipients an SMS sent to the list will reach, and which phone number will be used for each of them.
Lists can contain other lists. The addresses of these nested lists are included recursively, so the response contains every recipient that can be reached through the list. Each recipient is returned only once, even if it appears in multiple (nested) lists, and lists that refer back to each other are only processed once.
Note: if phoneNumber is not included, the recipient does not have a phone number of type Telephone_and_SMS.
An SMS sent to the list will not reach this recipient.
Resource
GET /lists/<OID>/sms_addresses
Where OID is the object ID of the list.
Parameters
None
Paging
This request does not support paging. All addresses are returned in a single response.
Payload
None
Response
Context
| Authorization |
User |
Errors
Example
GET https://xelion.nl/api/v1/master/lists/2310457/sms_addresses
{
"data": [
{
"object": {
"phoneNumber": "+31612340001",
"addressable": {
"commonName": "Sanne de Vries",
"oid": "2298114",
"objectType": "Person"
},
"objectType": "SMSListAddress"
}
},
{
"object": {
"phoneNumber": "+31612340002",
"addressable": {
"commonName": "Bram Jansen",
"oid": "2298237",
"objectType": "Person"
},
"objectType": "SMSListAddress"
}
},
{
"object": {
"addressable": {
"commonName": "Fleur Visser",
"oid": "2298350",
"objectType": "Person"
},
"objectType": "SMSListAddress"
}
},
{
"object": {
"phoneNumber": "+31612340004",
"addressable": {
"commonName": "Daan Bakker",
"oid": "2305671",
"objectType": "Person"
},
"objectType": "SMSListAddress"
}
},
{
"object": {
"phoneNumber": "+31612340005",
"addressable": {
"commonName": "Noor Smits",
"oid": "2305789",
"objectType": "Person"
},
"objectType": "SMSListAddress"
}
}
],
"meta": {
"links": [
{
"rel": "refresh",
"href": "https://xelion.nl/api/v1/master/lists/2310457/sms_addresses",
"method": "GET"
}
]
}
}