GET api/Chat?pageSize={pageSize}&pageNumber={pageNumber}&from={from}&to={to}&messageStatus={messageStatus}

Get all chat messages for the negotiatorId. Processes this chat API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

The page size value supplied with the request.

integer

Default value is 20

pageNumber

The page number value supplied with the request.

integer

Default value is 1

from

The from value supplied with the request.

date

None.

to

The to value supplied with the request.

date

None.

messageStatus

The message status value supplied with the request.

string

Default value is active

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

PagedDictionaryDataContractOfStringAndChatMessageDataContract
NameDescriptionTypeAdditional information
TotalCount

The total count value.

integer

None.

CurrentCount

The current count value.

integer

None.

PageSize

The page size value.

integer

None.

PageNumber

The page number value.

integer

None.

Dictionary

The collection of dictionary.

Dictionary of string [key] and ChatMessageDataContract [value]

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 3,
  "PageNumber": 4,
  "Dictionary": {
    "sample string 1": {
      "Id": "sample string 1",
      "DateTimeCreated": "2026-08-05T00:19:50.7692046Z",
      "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:19:50.7692046Z"
        },
        {
          "ChatMessageUser": {
            "UserId": 1,
            "UserName": "sample string 2"
          },
          "Comment": "sample string 1",
          "DateTime": "2026-08-05T00:19:50.7692046Z"
        }
      ],
      "Recipients": [
        {
          "UserId": 1,
          "UserName": "sample string 2"
        },
        {
          "UserId": 1,
          "UserName": "sample string 2"
        }
      ]
    },
    "sample string 2": {
      "Id": "sample string 1",
      "DateTimeCreated": "2026-08-05T00:19:50.7692046Z",
      "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:19:50.7692046Z"
        },
        {
          "ChatMessageUser": {
            "UserId": 1,
            "UserName": "sample string 2"
          },
          "Comment": "sample string 1",
          "DateTime": "2026-08-05T00:19:50.7692046Z"
        }
      ],
      "Recipients": [
        {
          "UserId": 1,
          "UserName": "sample string 2"
        },
        {
          "UserId": 1,
          "UserName": "sample string 2"
        }
      ]
    }
  }
}