POST api/v1/systems/{systemPhoneNumber}/presentationPhoneNumber/{presentationPhoneNumber}/conversations/search
Get list of conversations between two numbers
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| systemPhoneNumber | string |
Required |
|
| presentationPhoneNumber | string |
Required |
Body Parameters
SearchConversationRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Text | string |
None. |
|
| PhoneNumbers | Collection of string |
None. |
|
| From | integer |
None. |
|
| To | integer |
None. |
|
| Start | integer |
None. |
|
| Limit | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Text": "sample string 1",
"PhoneNumbers": [
"sample string 1",
"sample string 2"
],
"From": 2,
"To": 3,
"Start": 4,
"Limit": 5
}
application/xml, text/xml
Sample:
<SearchConversationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities.Request.Weblink">
<From xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities.Request">2</From>
<Limit xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities.Request">5</Limit>
<Start xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities.Request">4</Start>
<To xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities.Request">3</To>
<PhoneNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</PhoneNumbers>
<Text>sample string 1</Text>
</SearchConversationRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Collection of Conversation| Name | Description | 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:47:39.8752509-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:47:39.8752509-08:00",
"CreatedAt": "2024-11-22T01:47:39.8752509-08:00",
"ReadAt": "2024-11-22T01:47:39.8752509-08:00",
"LastUpdateDate": "2024-11-22T01:47:39.8752509-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:47:39.8752509-08:00",
"CreatedAt": "2024-11-22T01:47:39.8752509-08:00",
"ReadAt": "2024-11-22T01:47:39.8752509-08:00",
"LastUpdateDate": "2024-11-22T01:47:39.8752509-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:47:39.8752509-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:47:39.8752509-08:00",
"CreatedAt": "2024-11-22T01:47:39.8752509-08:00",
"ReadAt": "2024-11-22T01:47:39.8752509-08:00",
"LastUpdateDate": "2024-11-22T01:47:39.8752509-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:47:39.8752509-08:00",
"CreatedAt": "2024-11-22T01:47:39.8752509-08:00",
"ReadAt": "2024-11-22T01:47:39.8752509-08:00",
"LastUpdateDate": "2024-11-22T01:47:39.8752509-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:47:39.8752509-08:00</LastSyncDate>
<Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
<d3p1:Message>
<d3p1:CreatedAt>2024-11-22T01:47:39.8752509-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:47:39.8752509-08:00</d3p1:LastUpdateDate>
<d3p1:ReadAt>2024-11-22T01:47:39.8752509-08:00</d3p1:ReadAt>
<d3p1:SentAt>2024-11-22T01:47:39.8752509-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:47:39.8752509-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:47:39.8752509-08:00</d3p1:LastUpdateDate>
<d3p1:ReadAt>2024-11-22T01:47:39.8752509-08:00</d3p1:ReadAt>
<d3p1:SentAt>2024-11-22T01:47:39.8752509-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:47:39.8752509-08:00</LastSyncDate>
<Messages xmlns:d3p1="http://schemas.datacontract.org/2004/07/FreedomVoice.Entities">
<d3p1:Message>
<d3p1:CreatedAt>2024-11-22T01:47:39.8752509-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:47:39.8752509-08:00</d3p1:LastUpdateDate>
<d3p1:ReadAt>2024-11-22T01:47:39.8752509-08:00</d3p1:ReadAt>
<d3p1:SentAt>2024-11-22T01:47:39.8752509-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:47:39.8752509-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:47:39.8752509-08:00</d3p1:LastUpdateDate>
<d3p1:ReadAt>2024-11-22T01:47:39.8752509-08:00</d3p1:ReadAt>
<d3p1:SentAt>2024-11-22T01:47:39.8752509-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>