- Overview
- to get started
- Cloud content
- Cloud Data
- User Subscription
- User Session
- User Profile
- Email services
- Utilities
api description
purpose
message_list returns the list of message identifiers for a signed user. It is an associative array composed of two elements:
- "total" is the total number of of messages owned by the current signed user.
-
"list" is the array of message descriptors owned by the current user. As this list may be very long, the result may be a subset, returned in page mode (See optional parameters).Each message descriptor is an array composed of the following elements:
- message ID
- message subject
- ... Other undocumented elements
message_list requires valid session parameters: uuid, usid, udid and eost. See signin for further details.
http method: POST
call cost: 1 point
See the pricing section for more details.
mandatory parameter(s)
parameter | values / comments |
---|---|
api | "message_list" |
key | E.g. "c54e7837e0cd0ced286cb5995327d1ab54e35987179b2". It is an application key generated by AuverCloud Studio. |
uuid | Unique User ID. |
usid | Unique Session ID. |
udid | Unique Device ID. |
eost | End of Session Time. |
optional parameters(s)
parameter | values / comments |
---|---|
pagelen | Maximum length of the returned list. Default value: 100. Maximum value: 500. |
pagenum | Page number. Default value: 0 (first page). |
call sample
This example is the code used in the test case below. It assumes that jQuery and the JavaScript AuverCloud runtime client are loaded in order to use the arc.api() method. See the API client section for more details.
errors
No specific errors.
See also the Common errors section.
test bed
send
request
request
clear
response
response