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


Erinevalt teistest päringutest tuleb antud pöördumine esitada POST meetodiga.


Parameetrid

Esitatud parameetrite väärtused peavad olema URL kodeeritud.


Parameeter

Väärtus

subject

Kirja subjekt. Kohustuslik. Vabatekst.

from

Saatja aadress. Kohustulik. Peab olema eelnevalt lisatud Cherry kasutajaprofiili vaatesse Smaily liideses.

from_name

Saatja aadressi nime osa. Mitte kohustuslik. Kui väärtus päringu esitamisel määramata, siis kasutatakse vaikeväärtusena Smaily liideses kasutajaprofiili all määratud saatja aadressi nime osa.

reply_to

Vastuse aadress. Kirja Reply-To päis. Välja või väärtuse puudumisel kasutatakse from välja väärtust.

html

Viide HTML sisule, mis peab asuma väljast poolt ligipääsetaval veebiaadressil.

html_raw

Kirjapõhja sisu HTML kood. Kui “html” välja kasutamine pole võimalik.

list

Nimekiri või -kirjad kontaktidest, millele antud sisuga kiri saadetakse. Sisaldab Smaily’s olevate nimekirjade ID-sid. Kohustuslik. Vt. “Päring kasutaja loodud nimekirjade laadimiseks” peatükki.

due

Kuupäev, millal kiri välja peab minema. Väärtus peab olema vormindatud “YYYY-MM-DD HH:MM:SS” kujul. Väärtuse puudumisel kasutatakse praegust kuupäeva ja kellaaega, millele lisatakse 5 minutit nn. grace period’i, mille jooksul on võimalik postitus Smaily liidesest tühistada.


Välja “html” väärtus peab viitama reaalselt eksisteerivatele lehele, kui aadressilt HTMLi alla laadimine peaks andma tagasi muu teate, kui HTTP/1.1 200, siis lõpetatakse päringu edasine käsitlemine ja tagastatakse veateade “209 Could not load content from remote URL - ...”.


NB! Kui esitatakse päring turvatud ühendusega (HTTPS) aadressi pihta, siis peab sellel olema ka kehtiv sertifikaat. Self-signed sertifikaadid ei tööta.


Kui päringus on korraga esitatud nii “html_raw” kui ka “html” väli, siis arvestatakse (ja kontrollitakse) ainult “html_raw” välja väärtust.


Näidispäringud:


Postituse käivitamine - ajastamisega

Kasutades ajatamist ja mitmele nimekirjale postitamist.


$username = 'YOUR_USERNAME';
$password = 'YOUR_PASSWORD';
$location = 'https://<alamdomeen>.sendsmaily.net/api/campaign.php';
$query = array(
  'subject' => 'Head pakkumised - 8. aprill 2014',
  'from' => 'pakkumine@domeen.ee',
  'html' => 'http://domeen.ee/path/to/html/content.html',
  'list' => array(1, 2),
  'due' => '2014-04-10 07:00:00',
);

// Postitatud andmed ($query) peaks jõudma sellisele kujule.
// Antud näites muretseb selle eest “http_build_query” funktsioon.
// subject=Cherry+pakkumised+-+8.+aprill+2014&from=pakkumine%40domeen.ee&html=http%3A%2F%2Fdomeen.ee%2Fpath%2Fto%2Fhtml%2Fcontent.html&list%5B0%5D=1&list%5B1%5D=2&due=2014-04-10+07%3A00%3A00

$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_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($query));
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");

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

 

Eduka päringu vastuseks on:


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


Vaata ka võimalikke vastuseid.


Postituse käivitamine - kohe

Käivitamine koheseks saatmiseks ainult ühele nimekirjale.   


$username = 'YOUR_USERNAME';
$password = 'YOUR_PASSWORD';
$location = 'https://<alamdomeen>.sendsmaily.net/api/campaign.php';
$query = array(
  'subject' => 'Head pakkumised - 8. aprill 2014',
  'from' => 'pakkumine@domeen.ee',
  'from_name' => 'domeen.ee pakkumised',
  'html' => 'http://domeen.ee/path/to/html/content.html',
  'list' => 3,
);

// Postitatud andmed ($query) peaks jõudma sellisele kujule.
// Antud näites muretseb selle eest “http_build_query” funktsioon.
// subject=Cherry+pakkumised+-+8.+aprill+2014&from=pakkumine%40domeen.ee&from_name=domeen.ee+pakkumised&html=http%3A%2F%2Fdomeen.ee%2Fpath%2Fto%2Fhtml%2Fcontent.html&list=3

$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_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($query));
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");

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


Eduka päringu vastuseks on:


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

 

Vaata ka võimalikke vastuseid.


Postituse käivitamine - kohe, kasutades HTML koodi välja

Käivitamine koheseks saatmiseks ainult ühele nimekirjale. Kusjuures kirjapõhja sisu antakse ette HTML koodina. 


$username = 'YOUR_USERNAME';
$password = 'YOUR_PASSWORD';
$location = 'https://<alamdomeen>.sendsmaily.net/api/campaign.php';
$query = array(
  'subject' => 'Head pakkumised - 8. aprill 2014',
  'from' => 'pakkumine@domeen.ee',
  'from_name' => 'domeen.ee pakkumised',
  'html_raw' => '<html><body>...</body></html>',
  'list' => 3,
);

// Postitatud andmed ($query) peaks jõudma sellisele kujule.
// Antud näites muretseb selle eest “http_build_query” funktsioon.
// subject=Cherry+pakkumised+-+8.+aprill+2014&from=pakkumine%40domeen.ee&from_name=domeen.ee+pakkumised&html_raw=%3Chtml%3E%3Cbody%3E...%3C%2Fbody%3E%3C%2Fhtml%3E&list=3

$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_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($query));
curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");

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

 

Eduka päringu vastuseks on:


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

 

Vaata ka võimalikke vastuseid.