GET api/Chat?messageId={messageId}
Get a previous chat message to append to. Processes this chat API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| messageId |
The unique identifier of the message resource. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
ChatMessageDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The unique identifier of this resource. |
string |
None. |
| DateTimeCreated |
The date time created, expressed as a date and time. |
date |
None. |
| MessageStatus |
The message status value. |
string |
None. |
| NegotiatorId |
The unique identifier of the related negotiator resource. |
integer |
None. |
| NegotiatorName |
The negotiator name value. |
string |
None. |
| Comments |
The collection of comments. |
Collection of ChatMessageCommentDataContract |
None. |
| Recipients |
The collection of recipients. |
Collection of ChatMessageUserDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "sample string 1",
"DateTimeCreated": "2026-08-05T00:13:39.2589708Z",
"MessageStatus": "sample string 3",
"NegotiatorId": 4,
"NegotiatorName": "sample string 5",
"Comments": [
{
"ChatMessageUser": {
"UserId": 1,
"UserName": "sample string 2"
},
"Comment": "sample string 1",
"DateTime": "2026-08-05T00:13:39.2589708Z"
},
{
"ChatMessageUser": {
"UserId": 1,
"UserName": "sample string 2"
},
"Comment": "sample string 1",
"DateTime": "2026-08-05T00:13:39.2589708Z"
}
],
"Recipients": [
{
"UserId": 1,
"UserName": "sample string 2"
},
{
"UserId": 1,
"UserName": "sample string 2"
}
]
}