Get list
This method allows you to retrieve the contacts of a list.
GET
/list/:id
Query Parameters
|
id
required
|
The list id |
| search | With this param, you can filter on destination, info1, info2, info3 or info4 |
| start | You can define the start record for pagination. Default 0 |
| length | You can define the number of records to retrieve per request. Default 100. Maximum 1000 |
Examples
GET /list/50433 HTTP/1.1
Host: api.smsfactor.com
Accept: application/json
Authorization: Bearer your.token
Result Format
{
"status": 1,
"message": "OK",
"list": [
{
"id": "5a0331bffc5886074551ce97",
"destination": "33612345678",
"info1": "Louis",
"info2": "de Broglie",
"info3": "1892",
"info4": "Dieppe"
},
{
"id": "5a0331bffc5886074551ce98",
"destination": "33612345677",
"info1": "Richard",
"info2": "Feynman",
"info3": "1918",
"info4": "New-York"
},
{
"id": "5a0331bffc5886074551ce99",
"destination": "33612345676",
"info1": "Hiroo",
"info2": "Onoda"
},
{
"id": "5a0331bffc5886074551cf00",
"destination": "33612345675",
"info1": "Grace",
"info2": "Hopper"
},
{
"id": "5a0331bffc5886074551cf01",
"destination": "33612345674",
"info1": "Hedy",
"info2": "Lamarr",
"info3": "Extase",
"info4": "1933"
}
],
"name": "Liste API",
"contacts": "5",
"totalRecords": 5,
"totalDisplayRecords": 5
}
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>1</status>
<message>OK</message>
<list>
<id>5a0331bffc5886074551ce97</id>
<destination>33612345678</destination>
<info1>Louis</info1>
<info2>de Broglie</info2>
<info3>1892</info3>
<info4>Dieppe</info4>
</list>
<list>
<id>5a0331bffc5886074551ce98</id>
<destination>33612345677</destination>
<info1>Richard</info1>
<info2>Feynman</info2>
<info3>1918</info3>
<info4>New-York</info4>
</list>
<list>
<id>5a0331bffc5886074551ce99</id>
<destination>33612345676</destination>
<info1>Hiroo</info1>
<info2>Onoda</info2>
</list>
<list>
<id>5a0331bffc5886074551cf00</id>
<destination>33612345675</destination>
<info1>Grace</info1>
<info2>Hopper</info2>
</list>
<list>
<id>5a0331bffc5886074551cf01</id>
<destination>33612345674</destination>
<info1>Hedy</info1>
<info2>Lamarr</info2>
<info3>Extase</info3>
<info4>1933</info4>
</list>
<name>Liste API</name>
<contacts>5</contacts>
<totalRecords>5</totalRecords>
<totalDisplayRecords>5</totalDisplayRecords>
</response>