Difference between revisions of "NATS5 REST API Message DELETE message"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Message DELETE message to NATS5 REST API Message DELETE message: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''DELETE /message/message''' == | == '''DELETE /message/message''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Delete message(s) | * Delete message(s) | ||
| 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''']] |
*DELETE | *DELETE | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 25: | Line 26: | ||
** required | ** required | ||
* '''permanent''' | * '''permanent''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| Line 32: | Line 33: | ||
URL: <nowiki>http://domain/api/message/message</nowiki><br/> | URL: <nowiki>http://domain/api/message/message</nowiki><br/> | ||
Form Data:<br/> | Form Data:<br/> | ||
| − | * messageid: | + | * messageid: 3 |
| + | * permanent: 0 | ||
Response: | Response: | ||
| Line 58: | Line 60: | ||
$data = Array( | $data = Array( | ||
| − | 'messageid' => ' | + | 'messageid' => '3', |
| + | 'permanent' => 0, | ||
); | ); | ||
| Line 100: | Line 103: | ||
</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 --> | ||
Revision as of 15:45, 9 August 2019
DELETE /message/message
Description
- Delete message(s)
Resource URL
- http://domain/api/message/message
- Replace domain with the nats domain
- DELETE
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- messageid
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- required
- permanent
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: DELETE
URL: http://domain/api/message/message
Form Data:
- messageid: 3
- permanent: 0
Response:
{
"success": true,
"result": "Message marked deleted"
}
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(
'messageid' => '3',
'permanent' => 0,
);
$request = Array(
'method' => 'DELETE',
'path' => 'v1/message/message',
'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);
?>
