GET Messages?Page={Page}&PageSize={PageSize}&Search={Search}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Page

integer

None.

PageSize

integer

None.

Search

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of IncomingMessage
NameDescriptionTypeAdditional information
MessageId

integer

None.

DeliveryStatus

integer

None.

MessageStatus

integer

None.

DeliveryDate

date

None.

ComposedId

string

None.

Text

string

None.

Sender

string

None.

Direction

character

None.

Receiver

string

None.

FolderId

integer

None.

CreatedDate

date

None.

OrganizationId

integer

None.

UserId

integer

None.

CPATag

string

None.

CPAAgeLimit

integer

None.

ObjectIdentifier

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "MessageId": 1,
    "DeliveryStatus": 1,
    "MessageStatus": 2,
    "DeliveryDate": "2024-04-25T11:35:53.79+02:00",
    "ComposedId": "sample string 3",
    "Text": "sample string 4",
    "Sender": "sample string 5",
    "Direction": "A",
    "Receiver": "sample string 7",
    "FolderId": 1,
    "CreatedDate": "2024-04-25T11:35:53.79+02:00",
    "OrganizationId": 9,
    "UserId": 1,
    "CPATag": "sample string 10",
    "CPAAgeLimit": 1,
    "ObjectIdentifier": "IncomingMessage"
  },
  {
    "MessageId": 1,
    "DeliveryStatus": 1,
    "MessageStatus": 2,
    "DeliveryDate": "2024-04-25T11:35:53.79+02:00",
    "ComposedId": "sample string 3",
    "Text": "sample string 4",
    "Sender": "sample string 5",
    "Direction": "A",
    "Receiver": "sample string 7",
    "FolderId": 1,
    "CreatedDate": "2024-04-25T11:35:53.79+02:00",
    "OrganizationId": 9,
    "UserId": 1,
    "CPATag": "sample string 10",
    "CPAAgeLimit": 1,
    "ObjectIdentifier": "IncomingMessage"
  }
]

application/xml, text/xml

Sample:
<ArrayOfIncomingMessage xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IncomingMessage>
    <ComposedId>sample string 3</ComposedId>
    <Text>sample string 4</Text>
    <Sender>sample string 5</Sender>
    <Direction>65</Direction>
    <Receiver>sample string 7</Receiver>
    <FolderId>1</FolderId>
    <CreatedDate>2024-04-25T11:35:53.7905835+02:00</CreatedDate>
    <OrganizationId>9</OrganizationId>
    <UserId>1</UserId>
    <CPATag>sample string 10</CPATag>
    <CPAAgeLimit>1</CPAAgeLimit>
    <ObjectIdentifier>IncomingMessage</ObjectIdentifier>
    <MessageId>1</MessageId>
    <DeliveryStatus>1</DeliveryStatus>
    <MessageStatus>2</MessageStatus>
    <DeliveryDate>2024-04-25T11:35:53.7905835+02:00</DeliveryDate>
  </IncomingMessage>
  <IncomingMessage>
    <ComposedId>sample string 3</ComposedId>
    <Text>sample string 4</Text>
    <Sender>sample string 5</Sender>
    <Direction>65</Direction>
    <Receiver>sample string 7</Receiver>
    <FolderId>1</FolderId>
    <CreatedDate>2024-04-25T11:35:53.7905835+02:00</CreatedDate>
    <OrganizationId>9</OrganizationId>
    <UserId>1</UserId>
    <CPATag>sample string 10</CPATag>
    <CPAAgeLimit>1</CPAAgeLimit>
    <ObjectIdentifier>IncomingMessage</ObjectIdentifier>
    <MessageId>1</MessageId>
    <DeliveryStatus>1</DeliveryStatus>
    <MessageStatus>2</MessageStatus>
    <DeliveryDate>2024-04-25T11:35:53.7905835+02:00</DeliveryDate>
  </IncomingMessage>
</ArrayOfIncomingMessage>