GET api/SocialDriver/MessageInbox

Get the message inbox

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

MessageInboxResponse

MessageInboxResponse
NameDescriptionTypeAdditional information
NumberOfMessages

The number of messages

integer

None.

Messages

A list of messages

Collection of InboxMessage

None.

Response Formats

application/json, text/json

Sample:
{
  "NumberOfMessages": 1,
  "Messages": [
    {
      "MessageId": 1,
      "Subject": "sample string 2",
      "MessageBody": "sample string 3",
      "SentDate": "2025-04-27T15:23:06.2905514+00:00",
      "ReadDate": "2025-04-27T15:23:06.2905514+00:00",
      "NotificationType": 0,
      "NotificationPriority": 0,
      "MessageURL": "sample string 6"
    },
    {
      "MessageId": 1,
      "Subject": "sample string 2",
      "MessageBody": "sample string 3",
      "SentDate": "2025-04-27T15:23:06.2905514+00:00",
      "ReadDate": "2025-04-27T15:23:06.2905514+00:00",
      "NotificationType": 0,
      "NotificationPriority": 0,
      "MessageURL": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:
<MessageInboxResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <NumberOfMessages>1</NumberOfMessages>
  <Messages>
    <InboxMessage>
      <MessageId>1</MessageId>
      <Subject>sample string 2</Subject>
      <MessageBody>sample string 3</MessageBody>
      <SentDate>2025-04-27T15:23:06.2905514+00:00</SentDate>
      <ReadDate>2025-04-27T15:23:06.2905514+00:00</ReadDate>
      <NotificationType>Information</NotificationType>
      <NotificationPriority>Normal</NotificationPriority>
      <MessageURL>sample string 6</MessageURL>
    </InboxMessage>
    <InboxMessage>
      <MessageId>1</MessageId>
      <Subject>sample string 2</Subject>
      <MessageBody>sample string 3</MessageBody>
      <SentDate>2025-04-27T15:23:06.2905514+00:00</SentDate>
      <ReadDate>2025-04-27T15:23:06.2905514+00:00</ReadDate>
      <NotificationType>Information</NotificationType>
      <NotificationPriority>Normal</NotificationPriority>
      <MessageURL>sample string 6</MessageURL>
    </InboxMessage>
  </Messages>
</MessageInboxResponse>