GET api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/conversation?toPhone={toPhone}

Get conversation by the current number and the collocutor number

Request Information

URI Parameters

Name	Type	Additional information
systemPhoneNumber	string	Required
presentationPhoneNumber	string	Required
toPhone	string	Required

Body Parameters

None.

Response Information

Resource Description

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-22T00:58:18.9599209-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-22T00:58:18.9599209-08:00",
      "CreatedAt": "2024-11-22T00:58:18.9599209-08:00",
      "ReadAt": "2024-11-22T00:58:18.9599209-08:00",
      "LastUpdateDate": "2024-11-22T00:58:18.9599209-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-22T00:58:18.9599209-08:00",
      "CreatedAt": "2024-11-22T00:58:18.9599209-08:00",
      "ReadAt": "2024-11-22T00:58:18.9599209-08:00",
      "LastUpdateDate": "2024-11-22T00:58:18.9599209-08:00",
      "State": 0
    }
  ],
  "IsRemoved": true
}

application/xml, text/xml

Sample:

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