https://<alamdomeen>.sendsmaily.net/api/list.php


Päring tuleb esitada POST meetodiga.


Parameetrid

Parameetrite väärtused peavad olema URL kodeeritud.


Parameeter

Väärtus

id

Olemasoleva nimekirja ID, kui soovitakse selle andmeid uuendada.

name

Nimekirja nimetus. Kohustuslik

filter_type

Nimekirja tingimuste arvestamine. Võimalikud väärtused: ALL - kontakti andmed peavad vastama kõikidele filter_data väärtuses seatud tingimustele ja ANY - kontakti andmed peavad vastama vähemalt ühele tingimusele. Kohustuslik.

filter_data

Nimekirja tingimused. Kohustuslik.


Nimekirja tingimuste välja struktuur

Tegu peab olema jadaga, mille sees on jadad andmevälja ja tehete jadaga. Päringu andmevälja filter_data väärtuse struktuur lihtustatud kujul:

 

array(
  array(andmeväli, array(tehe, väärtus)),
  array(andmeväli, array(tehe, väärtus)),
)

 

Näiteks:

  

array(
  array("email", array("EndsWith", "@smaily.com")),
  array("created_at", array("Equal", "2015-12-09 10:00:00")),
)

   

Võimalikud tehted - Equal, NotEqual, BeginsWith, Contains, DoesNotContain, EndsWith, LessThan, LessThanEqual, GreaterThanEqual, GreaterThan


Näited


Nimekirja lisamine

 

$username = 'YOUR_USERNAME';
$password = 'YOUR_PASSWORD';
$location = 'https://<alamdomeen>.sendsmaily.net/api/list.php';
$data = array(
  'name' => 'This be the name',
  'filter_type' => 'A',
  'filter_data' => array(
    array('email', array('EndsWith', '@domeen.ee'))
  ),
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $location);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($query));

$result = curl_exec($ch);
curl_close($ch);

 

Eduka päringu tulemuseks on näiteks:


{
  'code': 101,
  'message': 'OK',
  'id': 3,
}


Nimekirja muutmine

 

$username = 'YOUR_USERNAME';
$password = 'YOUR_PASSWORD';
$location = 'https://<alamdomeen>.sendsmaily.net/api/list.php';
$data = array(
  'id' => 3,
  'name' => 'This be the name',
  'filter_type' => 'A',
  'filter_data' => array(
    array('email', array('BeginsWith', 'info@'))
  ),
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $location);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));

$result = curl_exec($ch);
curl_close($ch);

 

Eduka päringu tulemuseks on näiteks:

 

{
  'code': 101,
  'message': 'OK',
  'id': 3,
}

 

Vaata ka võimalikke vastuseid.