Difference between revisions of "NATS5 REST API Mailing GET queue"
From TMM Wiki
Jump to navigationJump to search| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_mailing_section = true |
}} | }} | ||
== '''GET /mailing/queue''' == | == '''GET /mailing/queue''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Search mail queue | * Search mail queue | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 46: | Line 47: | ||
** optional | ** optional | ||
* '''count_only''' | * '''count_only''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| Line 52: | Line 53: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/mailing/queue</nowiki><br/> | URL: <nowiki>http://domain/api/mailing/queue</nowiki><br/> | ||
| + | Query String: <nowiki>deleted=1&start=0&count=100&status=1</nowiki><br/> | ||
Response: | Response: | ||
<pre> | <pre> | ||
{ | { | ||
| − | "total_count": " | + | "total_count": "2", |
"queue": { | "queue": { | ||
"1": { | "1": { | ||
"queueid": "1", | "queueid": "1", | ||
| + | "type": "AFFILIATE", | ||
| + | "priority": "10", | ||
| + | "added_date": "1565382537", | ||
| + | "subject": "[{$project_name}] Account Approved", | ||
| + | "send_to": "test@email.com", | ||
| + | "send_from": "", | ||
| + | "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-08-09 16:28:57", | ||
| + | "status": "In Queue" | ||
| + | }, | ||
| + | "2": { | ||
| + | "queueid": "2", | ||
"type": "AFFILIATE", | "type": "AFFILIATE", | ||
"priority": "98", | "priority": "98", | ||
| − | "added_date": " | + | "added_date": "1565382548", |
"subject": "subject test", | "subject": "subject test", | ||
"send_to": "send@test.com", | "send_to": "send@test.com", | ||
| Line 73: | Line 93: | ||
"send_start_nice": "Never", | "send_start_nice": "Never", | ||
"send_end_nice": "Never", | "send_end_nice": "Never", | ||
| − | "added_date_nice": "2019- | + | "added_date_nice": "2019-08-09 16:29:08", |
"status": "In Queue" | "status": "In Queue" | ||
} | } | ||
| Line 96: | Line 116: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'deleted' => 1, | |
| + | 'start' => 0, | ||
| + | 'count' => 100, | ||
| + | 'status' => 1, | ||
); | ); | ||
| Line 139: | Line 162: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_mailing_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 15:59, 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 (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/mailing/queue
Query String: deleted=1&start=0&count=100&status=1
Response:
{
"total_count": "2",
"queue": {
"1": {
"queueid": "1",
"type": "AFFILIATE",
"priority": "10",
"added_date": "1565382537",
"subject": "[{$project_name}] Account Approved",
"send_to": "test@email.com",
"send_from": "",
"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-08-09 16:28:57",
"status": "In Queue"
},
"2": {
"queueid": "2",
"type": "AFFILIATE",
"priority": "98",
"added_date": "1565382548",
"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-08-09 16:29:08",
"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(
'deleted' => 1,
'start' => 0,
'count' => 100,
'status' => 1,
);
$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);
?>
