POST api/Message/ComposeGroupMessage

Request Information

URI Parameters

None.

Body Parameters

SocketModel
NameDescriptionTypeAdditional information
MediaURL

string

None.

Caption

string

None.

SenderName

string

None.

PatientId

string

None.

FamilyMemberId

string

None.

IsTyping

boolean

None.

CaseId

integer

None.

UserId

integer

None.

SenderUserId

integer

None.

GroupId

integer

None.

MessageText

string

None.

StatusCode

integer

None.

StatusMessage

string

None.

ProfileURL

string

None.

ThumbnailURL

string

None.

CreatedDate

date

None.

UserName

string

None.

GroupName

string

None.

MessageType

integer

None.

IsSender

boolean

None.

IsRead

boolean

None.

MessageId

integer

None.

IsUrgent

boolean

None.

IsRecalled

boolean

None.

ParticipantIds

string

None.

ParticipantGroupIds

string

None.

LocalGroupIds

string

None.

GlobalGroupIds

string

None.

Subject

string

None.

MediaType

string

None.

GroupURL

string

None.

GroupIds

string

None.

userToken

string

None.

LocalMsgId

string

None.

ParticipantsName

string

None.

TimeLineMessageIds

string

None.

IsActive

boolean

None.

HasReqAck

boolean

None.

IsAck

boolean

None.

TotalUsersCount

integer

None.

AckUsersCount

integer

None.

IsDeleted

boolean

None.

HasCallAccess

boolean

None.

ExtNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "MediaURL": "sample string 1",
  "Caption": "sample string 2",
  "SenderName": "sample string 3",
  "PatientId": "sample string 4",
  "FamilyMemberId": "sample string 5",
  "IsTyping": true,
  "CaseId": 7,
  "UserId": 8,
  "SenderUserId": 1,
  "GroupId": 9,
  "MessageText": "sample string 10",
  "StatusCode": 11,
  "StatusMessage": "sample string 12",
  "ProfileURL": "sample string 13",
  "ThumbnailURL": "sample string 14",
  "CreatedDate": "2026-04-15T19:34:30.802427+00:00",
  "UserName": "sample string 15",
  "GroupName": "sample string 16",
  "MessageType": 17,
  "IsSender": true,
  "IsRead": true,
  "MessageId": 1,
  "IsUrgent": true,
  "IsRecalled": true,
  "ParticipantIds": "sample string 20",
  "ParticipantGroupIds": "sample string 21",
  "LocalGroupIds": "sample string 22",
  "GlobalGroupIds": "sample string 23",
  "Subject": "sample string 24",
  "MediaType": "sample string 25",
  "GroupURL": "sample string 26",
  "GroupIds": "sample string 27",
  "userToken": "sample string 28",
  "LocalMsgId": "sample string 29",
  "ParticipantsName": "sample string 30",
  "TimeLineMessageIds": "sample string 31",
  "IsActive": true,
  "HasReqAck": true,
  "IsAck": true,
  "TotalUsersCount": 35,
  "AckUsersCount": 36,
  "IsDeleted": true,
  "HasCallAccess": true,
  "ExtNumber": "sample string 39"
}

text/xml

Sample:
<SocketModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PrimeHealthCare.Model">
  <AckUsersCount>36</AckUsersCount>
  <Caption>sample string 2</Caption>
  <CaseId>7</CaseId>
  <CreatedDate>2026-04-15T19:34:30.802427+00:00</CreatedDate>
  <ExtNumber>sample string 39</ExtNumber>
  <FamilyMemberId>sample string 5</FamilyMemberId>
  <GlobalGroupIds>sample string 23</GlobalGroupIds>
  <GroupId>9</GroupId>
  <GroupIds>sample string 27</GroupIds>
  <GroupName>sample string 16</GroupName>
  <GroupURL>sample string 26</GroupURL>
  <HasCallAccess>true</HasCallAccess>
  <HasReqAck>true</HasReqAck>
  <IsAck>true</IsAck>
  <IsActive>true</IsActive>
  <IsDeleted>true</IsDeleted>
  <IsRead>true</IsRead>
  <IsRecalled>true</IsRecalled>
  <IsSender>true</IsSender>
  <IsTyping>true</IsTyping>
  <IsUrgent>true</IsUrgent>
  <LocalGroupIds>sample string 22</LocalGroupIds>
  <LocalMsgId>sample string 29</LocalMsgId>
  <MediaType>sample string 25</MediaType>
  <MediaURL>sample string 1</MediaURL>
  <MessageId>1</MessageId>
  <MessageText>sample string 10</MessageText>
  <MessageType>17</MessageType>
  <ParticipantGroupIds>sample string 21</ParticipantGroupIds>
  <ParticipantIds>sample string 20</ParticipantIds>
  <ParticipantsName>sample string 30</ParticipantsName>
  <PatientId>sample string 4</PatientId>
  <ProfileURL>sample string 13</ProfileURL>
  <SenderName>sample string 3</SenderName>
  <SenderUserId>1</SenderUserId>
  <StatusCode>11</StatusCode>
  <StatusMessage>sample string 12</StatusMessage>
  <Subject>sample string 24</Subject>
  <ThumbnailURL>sample string 14</ThumbnailURL>
  <TimeLineMessageIds>sample string 31</TimeLineMessageIds>
  <TotalUsersCount>35</TotalUsersCount>
  <UserId>8</UserId>
  <UserName>sample string 15</UserName>
  <userToken>sample string 28</userToken>
</SocketModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

responseData
NameDescriptionTypeAdditional information
statusCode

integer

None.

statusMessage

string

None.

data

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "statusCode": 1,
  "statusMessage": "sample string 2",
  "data": {}
}

text/xml

Sample:
<responseData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PrimeHealthCare.Model">
  <data />
  <statusCode>1</statusCode>
  <statusMessage>sample string 2</statusMessage>
</responseData>