I. Messages
This is only applicable for token authentication when mimicking a user.
| Action | Method | URI |
|---|---|---|
| List Messages | GET | /message |
| Get Message | GET | /message/member/{id} |
| Send Message | POST | /message |
Listing Messages
These query parameters are available for listing Message objects.
limitNumber of records to return20Message Parameters* Exactly one of message[to_user_id] or message[to_exhibitor_id] must be provided.** Message content must be well-formed XHTML.
| Parameter | Details | Default |
|---|---|---|
| page | Page number of records | 1 |
| box | inbox message in the inbox sent sent messages |
inbox |
| Parameter | Example | Details |
| message[to_user_id] | 59 | Required*, User ID of recipient |
| message[to_exhibitor_id] | 49 | Required*, Exhibitor ID of recipient |
| message[body] | <p>message</p> | Required, XHTML** |
| message[subject] | Gold Sponsor | Required |
JSON Response Example
{
"id": 827745843,
"sent_at": {
"n": 0,
"json_class": "Time",
"s": 1311236926
},
"subject": "Internet access",
"content": "Hi Kim Sung, yes, you'll have a ethernet connection available at the podium.",
"from": {
"id": 3,
"type": "user",
"display_name": "Charlie"
},
"to": [{
"id": 12,
"type": "user",
"display_name": "Kim Sung"
}],
"type": "message"
}
XML Response Example
<?xml version="1.0" encoding="UTF-8"?>
<message>
<id type="integer">827745843</id>
<sent-at type="datetime">2011-07-21T08:28:46Z</sent-at>
<subject>Internet access</subject>
<content>Hi Kim Sung, yes, you'll have a ethernet connection available at the podium.</content>
<from>
<type>user</type>
<id type="integer">3</id>
<display-name>Charlie</display-name>
</from>
<to type="array">
<to>
<type>user</type>
<id type="integer">12</id>
<display-name>Kim Sung</display-name>
</to>
</to>
</message>
Leave a Comment