POST api/Message/GetChatMessageHistory
Request Information
URI Parameters
None.
Body Parameters
CommonMessageModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FamilyMemberId | string |
None. |
|
| PatientUniqueId | string |
None. |
|
| Platform | string |
None. |
|
| AppVersion | string |
None. |
|
| UserId | integer |
None. |
|
| MessageId | integer |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| GroupId | integer |
None. |
|
| GroupName | string |
None. |
|
| MessageText | string |
None. |
|
| MessageType | integer |
None. |
|
| MediaType | string |
None. |
|
| ProfileURL | string |
None. |
|
| GroupURL | string |
None. |
|
| CreatedDate | date |
None. |
|
| IsSender | boolean |
None. |
|
| SenderImage | string |
None. |
|
| MessageImageUrl | string |
None. |
|
| IsDelivered | boolean |
None. |
|
| IsRead | boolean |
None. |
|
| IsArchive | boolean |
None. |
|
| IsUrgent | boolean |
None. |
|
| SenderId | integer |
None. |
|
| IsRecalled | boolean |
None. |
|
| EmailId | string |
None. |
|
| ThumbnailURL | string |
None. |
|
| startIndex | integer |
None. |
|
| endIndex | integer |
None. |
|
| UserName | string |
None. |
|
| Subject | string |
None. |
|
| ReadTimeStamp | date |
None. |
|
| loginUserName | string |
None. |
|
| ChatSubject | string |
None. |
|
| IsActive | boolean |
None. |
|
| IsAck | boolean |
None. |
|
| AckTimeStamp | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"FamilyMemberId": "sample string 1",
"PatientUniqueId": "sample string 2",
"Platform": "sample string 3",
"AppVersion": "sample string 4",
"UserId": 5,
"MessageId": 6,
"FirstName": "sample string 7",
"LastName": "sample string 8",
"GroupId": 9,
"GroupName": "sample string 10",
"MessageText": "sample string 11",
"MessageType": 1,
"MediaType": "sample string 12",
"ProfileURL": "sample string 13",
"GroupURL": "sample string 14",
"CreatedDate": "2026-04-15T19:34:29.2856547+00:00",
"IsSender": true,
"SenderImage": "sample string 16",
"MessageImageUrl": "sample string 17",
"IsDelivered": true,
"IsRead": true,
"IsArchive": true,
"IsUrgent": true,
"SenderId": 18,
"IsRecalled": true,
"EmailId": "sample string 19",
"ThumbnailURL": "sample string 20",
"startIndex": 1,
"endIndex": 1,
"UserName": "sample string 21",
"Subject": "sample string 22",
"ReadTimeStamp": "2026-04-15T19:34:29.2856547+00:00",
"loginUserName": "sample string 24",
"ChatSubject": "sample string 25",
"IsActive": true,
"IsAck": true,
"AckTimeStamp": "2026-04-15T19:34:29.2856547+00:00"
}
text/xml
Sample:
<CommonMessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PrimeHealthCare.Model"> <AckTimeStamp>2026-04-15T19:34:29.2856547+00:00</AckTimeStamp> <AppVersion>sample string 4</AppVersion> <ChatSubject>sample string 25</ChatSubject> <CreatedDate>2026-04-15T19:34:29.2856547+00:00</CreatedDate> <EmailId>sample string 19</EmailId> <FamilyMemberId>sample string 1</FamilyMemberId> <FirstName>sample string 7</FirstName> <GroupId>9</GroupId> <GroupName>sample string 10</GroupName> <GroupURL>sample string 14</GroupURL> <IsAck>true</IsAck> <IsActive>true</IsActive> <IsArchive>true</IsArchive> <IsDelivered>true</IsDelivered> <IsRead>true</IsRead> <IsRecalled>true</IsRecalled> <IsSender>true</IsSender> <IsUrgent>true</IsUrgent> <LastName>sample string 8</LastName> <MediaType>sample string 12</MediaType> <MessageId>6</MessageId> <MessageImageUrl>sample string 17</MessageImageUrl> <MessageText>sample string 11</MessageText> <MessageType>1</MessageType> <PatientUniqueId>sample string 2</PatientUniqueId> <Platform>sample string 3</Platform> <ProfileURL>sample string 13</ProfileURL> <ReadTimeStamp>2026-04-15T19:34:29.2856547+00:00</ReadTimeStamp> <SenderId>18</SenderId> <SenderImage>sample string 16</SenderImage> <Subject>sample string 22</Subject> <ThumbnailURL>sample string 20</ThumbnailURL> <UserId>5</UserId> <UserName>sample string 21</UserName> <endIndex>1</endIndex> <loginUserName>sample string 24</loginUserName> <startIndex>1</startIndex> </CommonMessageModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ChatHistoryresponseData| Name | Description | Type | Additional information |
|---|---|---|---|
| IsIOSAppUpdate | boolean |
None. |
|
| IsIOSForceUpgrade | boolean |
None. |
|
| IsAndroidForceUpgrade | boolean |
None. |
|
| IsAndroidAppUpdate | boolean |
None. |
|
| ChatName | string |
None. |
|
| ChatSubject | string |
None. |
|
| IsActive | boolean |
None. |
|
| statusCode | integer |
None. |
|
| statusMessage | string |
None. |
|
| data | Object |
None. |
|
| QuickMessageLastTime | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsIOSAppUpdate": true,
"IsIOSForceUpgrade": true,
"IsAndroidForceUpgrade": true,
"IsAndroidAppUpdate": true,
"ChatName": "sample string 5",
"ChatSubject": "sample string 6",
"IsActive": true,
"statusCode": 8,
"statusMessage": "sample string 9",
"data": {},
"QuickMessageLastTime": "sample string 11"
}
text/xml
Sample:
<ChatHistoryresponseData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PrimeHealthCare.Model"> <ChatName>sample string 5</ChatName> <ChatSubject>sample string 6</ChatSubject> <IsActive>true</IsActive> <IsAndroidAppUpdate>true</IsAndroidAppUpdate> <IsAndroidForceUpgrade>true</IsAndroidForceUpgrade> <IsIOSAppUpdate>true</IsIOSAppUpdate> <IsIOSForceUpgrade>true</IsIOSForceUpgrade> <QuickMessageLastTime>sample string 11</QuickMessageLastTime> <data /> <statusCode>8</statusCode> <statusMessage>sample string 9</statusMessage> </ChatHistoryresponseData>