GET api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/messages?conversationId={conversationId}&from={from}&to={to}&start={start}&limit={limit}

Get list of messages by provided id of conversation

Request Information

URI Parameters

Name	Type	Additional information
systemPhoneNumber	string	Required
presentationPhoneNumber	string	Required
conversationId	integer	Required
from	integer	Required
to	integer	Required
start	integer	Required
limit	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Message

Name	Type	Additional information
Id	integer	None.
From	Phone	None.
To	Phone	None.
Text	string	None.
SentAt	date	None.
CreatedAt	date	None.
ReadAt	date	None.
LastUpdateDate	date	None.
State	SendingState	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "From": {
      "Id": 1,
      "PhoneNumber": "sample string 2"
    },
    "To": {
      "Id": 1,
      "PhoneNumber": "sample string 2"
    },
    "Text": "sample string 2",
    "SentAt": "2024-11-22T01:25:51.8675089-08:00",
    "CreatedAt": "2024-11-22T01:25:51.8675089-08:00",
    "ReadAt": "2024-11-22T01:25:51.8675089-08:00",
    "LastUpdateDate": "2024-11-22T01:25:51.8675089-08:00",
    "State": 0
  },
  {
    "Id": 1,
    "From": {
      "Id": 1,
      "PhoneNumber": "sample string 2"
    },
    "To": {
      "Id": 1,
      "PhoneNumber": "sample string 2"
    },
    "Text": "sample string 2",
    "SentAt": "2024-11-22T01:25:51.8675089-08:00",
    "CreatedAt": "2024-11-22T01:25:51.8675089-08:00",
    "ReadAt": "2024-11-22T01:25:51.8675089-08:00",
    "LastUpdateDate": "2024-11-22T01:25:51.8675089-08:00",
    "State": 0
  }
]

application/xml, text/xml

Sample:

<ArrayOfMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
  <Message>
    <CreatedAt>2024-11-22T01:25:51.8675089-08:00</CreatedAt>
    <From>
      <Id>1</Id>
      <PhoneNumber>sample string 2</PhoneNumber>
    </From>
    <Id>1</Id>
    <LastUpdateDate>2024-11-22T01:25:51.8675089-08:00</LastUpdateDate>
    <ReadAt>2024-11-22T01:25:51.8675089-08:00</ReadAt>
    <SentAt>2024-11-22T01:25:51.8675089-08:00</SentAt>
    <State>Sending</State>
    <Text>sample string 2</Text>
    <To>
      <Id>1</Id>
      <PhoneNumber>sample string 2</PhoneNumber>
    </To>
  </Message>
  <Message>
    <CreatedAt>2024-11-22T01:25:51.8675089-08:00</CreatedAt>
    <From>
      <Id>1</Id>
      <PhoneNumber>sample string 2</PhoneNumber>
    </From>
    <Id>1</Id>
    <LastUpdateDate>2024-11-22T01:25:51.8675089-08:00</LastUpdateDate>
    <ReadAt>2024-11-22T01:25:51.8675089-08:00</ReadAt>
    <SentAt>2024-11-22T01:25:51.8675089-08:00</SentAt>
    <State>Sending</State>
    <Text>sample string 2</Text>
    <To>
      <Id>1</Id>
      <PhoneNumber>sample string 2</PhoneNumber>
    </To>
  </Message>
</ArrayOfMessage>