Difference between revisions of "NATS5 REST API Mailing GET queue"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Mailing GET queue to NATS5 REST API Mailing GET queue: Renaming NATS5 API pages) |
|
(No difference)
| |
Revision as of 15:18, 9 August 2019
GET /mailing/queue
Description
- Search mail queue
Resource URL
- http://domain/api/mailing/queue
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- deleted
- type: trinary_digit (0, 1, or 2)
- optional
- status
- type: trinary_digit (0, 1, or 2)
- optional
- type
- type: string
- optional
- subject
- type: string
- optional
- send_to
- type: string
- optional
- orderby
- type: string
- optional
- count
- type: digit
- optional
- start
- type: digit
- optional
- count_only
- type: boolean_digit
- optional
Example Request
Method: GET
URL: http://domain/api/mailing/queue
Response:
{
"total_count": "1",
"queue": {
"1": {
"queueid": "1",
"type": "AFFILIATE",
"priority": "98",
"added_date": "1559929894",
"subject": "subject test",
"send_to": "send@test.com",
"send_from": "change@changeme.com",
"send_start": "0",
"send_end": "0",
"error": "",
"deleted": "0",
"mail_list_id": null,
"send_start_nice": "Never",
"send_end_nice": "Never",
"added_date_nice": "2019-06-07 13:51:34",
"status": "In Queue"
}
},
"success": true
}
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(
// Add API parameters here
);
$request = Array(
'method' => 'GET',
'path' => 'v1/mailing/queue',
'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);
?>
