Difference between revisions of "NATS5 REST API Message GET messages"
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_message_section = true |
}} | }} | ||
== '''GET /message/messages''' == | == '''GET /message/messages''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get a messages for this account | * Get a messages for this account | ||
| 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: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/message/messages</nowiki><br/> | URL: <nowiki>http://domain/api/message/messages</nowiki><br/> | ||
| + | Query String: <nowiki>order=sent_by&start=0&count=50&direction=2&type=received</nowiki><br/> | ||
Response: | Response: | ||
| Line 53: | Line 55: | ||
"messages": [ | "messages": [ | ||
{ | { | ||
| − | "messageid": " | + | "messageid": "3", |
| − | "send_date": " | + | "send_date": "1565382565", |
"sent_by": "1", | "sent_by": "1", | ||
"recip_id": "1", | "recip_id": "1", | ||
| Line 65: | Line 67: | ||
"added_by": "1", | "added_by": "1", | ||
"loginid": "1", | "loginid": "1", | ||
| − | "added": " | + | "added": "1565382565", |
| − | "send_datetime": "2019- | + | "send_datetime": "2019-08-09 16:29:25", |
"added_by_nice": "productsupport", | "added_by_nice": "productsupport", | ||
"loginid_nice": "productsupport" | "loginid_nice": "productsupport" | ||
| Line 90: | Line 92: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'order' => 'sent_by', | |
| + | 'start' => 0, | ||
| + | 'count' => 50, | ||
| + | 'direction' => 2, | ||
| + | 'type' => 'received', | ||
); | ); | ||
| Line 133: | Line 139: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_message_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 /message/messages
Description
- Get a messages for this account
Resource URL
- http://domain/api/message/messages
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- order
- type: string
- optional (default value: date)
- direction
- type: trinary_digit (0, 1, or 2)
- optional
- type
- type: string
- optional (default value: received)
- deleted
- type: trinary_digit (0, 1, or 2)
- optional
- search
- type: string
- optional
- count
- type: digit
- optional
- start
- type: digit
- optional
Example Request
Method: GET
URL: http://domain/api/message/messages
Query String: order=sent_by&start=0&count=50&direction=2&type=received
Response:
{
"success": true,
"messages": [
{
"messageid": "3",
"send_date": "1565382565",
"sent_by": "1",
"recip_id": "1",
"subject": "testSubject",
"viewed": "0",
"deleted": "0",
"msg_grp": "1",
"sent_username": "productsupport",
"recip_username": "productsupport",
"added_by": "1",
"loginid": "1",
"added": "1565382565",
"send_datetime": "2019-08-09 16:29:25",
"added_by_nice": "productsupport",
"loginid_nice": "productsupport"
}
],
"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(
'order' => 'sent_by',
'start' => 0,
'count' => 50,
'direction' => 2,
'type' => 'received',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/message/messages',
'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);
?>
