getMessagesInFolder
- Home
- Messaging
- UgcMessage
- getMessagesInFolder
getMessagesInFolder
Get messages in folder.
Parameters
| Name | Description |
| userID required | A single user id. |
| folderID optional | The folder identifier. |
| status optional | The status to update the message to. |
| page optional | The requested page of results. |
| perPage optional | The number of results to pull per page. |
| output optional | The response output format. Accepts JSON and XML. |
Request Syntax
| https://services.onesite.com/rest/ugcMessage?action=getMessagesInFolder&userID=229751571&status=new,read&page=1&perPage=1&devkey=[devkey] |
JSON Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
{ "service":"ugcMessage", "action":"getMessagesInFolder", "extra":{ "folder_name":"Inbox" }, "item":{ "259656231":{ "message_id":"259656231", "author_id":"229928503", "subject":"Testing", "body":"Hey%2C+how%27s+it+going%3F", "status":"new", "date_sent":"1550169113" } }, "code":1, "message":"Success", "total":"5", "page":1, "per_page":1 } |
Service Information
| Service | ugcMessage |
| Method | getMessagesInFolder |
| Type | REST |
| Response Types | JSON, XML |