NATS5 REST API Mailing GET mailings
From TMM Wiki
Jump to navigationJump to searchGET /mailing/mailings
Description
- Get mailings
Resource URL
- http://domain/api/mailing/mailings
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- status
- type: string
- optional (default value: all)
- orderby
- type: string
- optional (default value: status_added)
- type
- type: string
- optional
- repeating
- type: trinary_digit (0, 1, or 2)
- optional
- subject
- type: string
- optional
Example Request
Method: GET
URL: http://domain/api/mailing/mailings
Query String: status=all&orderby=status_added
Response:
{
"success": true,
"mails": [
{
"added": "1565382548",
"added_nice": "2019-08-09 16:29:08",
"deleted": "0",
"email_once": "0",
"enabled": "0",
"first_send_end": "0",
"first_send_end_nice": "Never",
"first_send_start": "0",
"first_send_start_nice": "Never",
"last_send_end": "0",
"last_send_end_nice": "Never",
"last_send_start": "0",
"last_send_start_nice": "Never",
"mail_type_id": "0",
"mailid": "1",
"only_once": "0",
"send_count": "0",
"send_detail": "",
"send_nice": "Never",
"send_on": "1",
"send_on_nice": "Never",
"send_type": "never",
"status": 0,
"status_nice": "unscheduled",
"subject": "subject test",
"total_send_count": "0",
"type_nice": "Affiliates"
}
],
"total_count": "1"
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = Array(
'status' => 'all',
'orderby' => 'status_added',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/mailing/mailings',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
