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

Get list of conversations between two numbers

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

Collection of Conversation

Name	Type	Additional information
Id	integer	None.
SystemPhoneNumber	Phone	None.
ToPhone	Phone	None.
LastSyncDate	date	None.
Messages	Collection of Message	None.
IsRemoved	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "SystemPhoneNumber": {
      "Id": 1,
      "PhoneNumber": "sample string 2"
    },
    "ToPhone": {
      "Id": 1,
      "PhoneNumber": "sample string 2"
    },
    "LastSyncDate": "2024-11-22T01:16:37.4616972-08:00",
    "Messages": [
      {
        "Id": 1,
        "From": {
          "Id": 1,
          "PhoneNumber": "sample string 2"
        },
        "To": {
          "Id": 1,
          "PhoneNumber": "sample string 2"
        },
        "Text": "sample string 2",
        "SentAt": "2024-11-22T01:16:37.4616972-08:00",
        "CreatedAt": "2024-11-22T01:16:37.4616972-08:00",
        "ReadAt": "2024-11-22T01:16:37.4616972-08:00",
        "LastUpdateDate": "2024-11-22T01:16:37.4616972-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:16:37.4616972-08:00",
        "CreatedAt": "2024-11-22T01:16:37.4616972-08:00",
        "ReadAt": "2024-11-22T01:16:37.4616972-08:00",
        "LastUpdateDate": "2024-11-22T01:16:37.4616972-08:00",
        "State": 0
      }
    ],
    "IsRemoved": true
  },
  {
    "Id": 1,
    "SystemPhoneNumber": {
      "Id": 1,
      "PhoneNumber": "sample string 2"
    },
    "ToPhone": {
      "Id": 1,
      "PhoneNumber": "sample string 2"
    },
    "LastSyncDate": "2024-11-22T01:16:37.4616972-08:00",
    "Messages": [
      {
        "Id": 1,
        "From": {
          "Id": 1,
          "PhoneNumber": "sample string 2"
        },
        "To": {
          "Id": 1,
          "PhoneNumber": "sample string 2"
        },
        "Text": "sample string 2",
        "SentAt": "2024-11-22T01:16:37.4616972-08:00",
        "CreatedAt": "2024-11-22T01:16:37.4616972-08:00",
        "ReadAt": "2024-11-22T01:16:37.4616972-08:00",
        "LastUpdateDate": "2024-11-22T01:16:37.4616972-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:16:37.4616972-08:00",
        "CreatedAt": "2024-11-22T01:16:37.4616972-08:00",
        "ReadAt": "2024-11-22T01:16:37.4616972-08:00",
        "LastUpdateDate": "2024-11-22T01:16:37.4616972-08:00",
        "State": 0
      }
    ],
    "IsRemoved": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfConversation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities.Response">
  <Conversation>
    <Id>1</Id>
    <IsRemoved>true</IsRemoved>
    <LastSyncDate>2024-11-22T01:16:37.4616972-08:00</LastSyncDate>
    <Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
      <d3p1:Message>
        <d3p1:CreatedAt>2024-11-22T01:16:37.4616972-08:00</d3p1:CreatedAt>
        <d3p1:From>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:From>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:LastUpdateDate>2024-11-22T01:16:37.4616972-08:00</d3p1:LastUpdateDate>
        <d3p1:ReadAt>2024-11-22T01:16:37.4616972-08:00</d3p1:ReadAt>
        <d3p1:SentAt>2024-11-22T01:16:37.4616972-08:00</d3p1:SentAt>
        <d3p1:State>Sending</d3p1:State>
        <d3p1:Text>sample string 2</d3p1:Text>
        <d3p1:To>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:To>
      </d3p1:Message>
      <d3p1:Message>
        <d3p1:CreatedAt>2024-11-22T01:16:37.4616972-08:00</d3p1:CreatedAt>
        <d3p1:From>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:From>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:LastUpdateDate>2024-11-22T01:16:37.4616972-08:00</d3p1:LastUpdateDate>
        <d3p1:ReadAt>2024-11-22T01:16:37.4616972-08:00</d3p1:ReadAt>
        <d3p1:SentAt>2024-11-22T01:16:37.4616972-08:00</d3p1:SentAt>
        <d3p1:State>Sending</d3p1:State>
        <d3p1:Text>sample string 2</d3p1:Text>
        <d3p1:To>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:To>
      </d3p1:Message>
    </Messages>
    <SystemPhoneNumber xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
      <d3p1:Id>1</d3p1:Id>
      <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
    </SystemPhoneNumber>
    <ToPhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
      <d3p1:Id>1</d3p1:Id>
      <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
    </ToPhone>
  </Conversation>
  <Conversation>
    <Id>1</Id>
    <IsRemoved>true</IsRemoved>
    <LastSyncDate>2024-11-22T01:16:37.4616972-08:00</LastSyncDate>
    <Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
      <d3p1:Message>
        <d3p1:CreatedAt>2024-11-22T01:16:37.4616972-08:00</d3p1:CreatedAt>
        <d3p1:From>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:From>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:LastUpdateDate>2024-11-22T01:16:37.4616972-08:00</d3p1:LastUpdateDate>
        <d3p1:ReadAt>2024-11-22T01:16:37.4616972-08:00</d3p1:ReadAt>
        <d3p1:SentAt>2024-11-22T01:16:37.4616972-08:00</d3p1:SentAt>
        <d3p1:State>Sending</d3p1:State>
        <d3p1:Text>sample string 2</d3p1:Text>
        <d3p1:To>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:To>
      </d3p1:Message>
      <d3p1:Message>
        <d3p1:CreatedAt>2024-11-22T01:16:37.4616972-08:00</d3p1:CreatedAt>
        <d3p1:From>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:From>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:LastUpdateDate>2024-11-22T01:16:37.4616972-08:00</d3p1:LastUpdateDate>
        <d3p1:ReadAt>2024-11-22T01:16:37.4616972-08:00</d3p1:ReadAt>
        <d3p1:SentAt>2024-11-22T01:16:37.4616972-08:00</d3p1:SentAt>
        <d3p1:State>Sending</d3p1:State>
        <d3p1:Text>sample string 2</d3p1:Text>
        <d3p1:To>
          <d3p1:Id>1</d3p1:Id>
          <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
        </d3p1:To>
      </d3p1:Message>
    </Messages>
    <SystemPhoneNumber xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
      <d3p1:Id>1</d3p1:Id>
      <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
    </SystemPhoneNumber>
    <ToPhone xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
      <d3p1:Id>1</d3p1:Id>
      <d3p1:PhoneNumber>sample string 2</d3p1:PhoneNumber>
    </ToPhone>
  </Conversation>
</ArrayOfConversation>