POST api/Chat/GetGuestSessions

Gets filtered chat sessions.

Request Information

URI Parameters

None.

Body Parameters

Filter parameters

Name	Description	Type	Additional information
PageIndex	The requested page index	integer	None.
PageSize	The requested page size	integer	None.
OperatorProviderKeys	Filter by Operators	Collection of string	None.
CategoryItemIds	Filter by Category items	Collection of integer	None.
ChatProfileKeys	Filter by Chat profiles	Collection of globally unique identifier	None.
GuestIpAddress	Filter by Guest IP address	string	None.
Rating	Filter by Rating	decimal number	None.
SessionId	Filter by Session Id	string	None.
SessionState	Filter by State	ChatSessionState	None.
SessionSource	Filter by Source	ChatSessionSource	None.
GuestId	Filter by Guest Id	string	None.
CreatedDateFromUtc	Filter by the date of creation - from.	date	None.
CreatedDateUntilUtc	Filter by the date of creation - until.	date	None.

Request Formats

application/json, text/json

Sample:

{
  "PageIndex": 1,
  "PageSize": 2,
  "OperatorProviderKeys": [
    "sample string 1",
    "sample string 2"
  ],
  "CategoryItemIds": [
    1,
    2
  ],
  "ChatProfileKeys": [
    "f5141619-e7ae-4376-b2c3-0068ae6ed233",
    "624576bb-ad8d-4082-92d9-110f55c8ddc2"
  ],
  "GuestIpAddress": "sample string 3",
  "Rating": 1.1,
  "SessionId": "sample string 4",
  "SessionState": 0,
  "SessionSource": 0,
  "GuestId": "sample string 5",
  "CreatedDateFromUtc": "2025-06-08T01:24:03.9861387+02:00",
  "CreatedDateUntilUtc": "2025-06-08T01:24:03.9861387+02:00"
}

application/xml, text/xml

Sample:

<ChatSessionsFilterPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <CategoryItemIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CategoryItemIds>
  <ChatProfileKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>f5141619-e7ae-4376-b2c3-0068ae6ed233</d2p1:guid>
    <d2p1:guid>624576bb-ad8d-4082-92d9-110f55c8ddc2</d2p1:guid>
  </ChatProfileKeys>
  <CreatedDateFromUtc>2025-06-08T01:24:03.9861387+02:00</CreatedDateFromUtc>
  <CreatedDateUntilUtc>2025-06-08T01:24:03.9861387+02:00</CreatedDateUntilUtc>
  <GuestId>sample string 5</GuestId>
  <GuestIpAddress>sample string 3</GuestIpAddress>
  <OperatorProviderKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </OperatorProviderKeys>
  <PageIndex>1</PageIndex>
  <PageSize>2</PageSize>
  <Rating>1.1</Rating>
  <SessionId>sample string 4</SessionId>
  <SessionSource>Common</SessionSource>
  <SessionState>Missed</SessionState>
</ChatSessionsFilterPost>

Response Information

Resource Description

HttpStatusCode 200 OK or 400 BadRequest with Message.

GetChatSessionsResult

Name	Description	Type	Additional information
PagedChatSessions	A page with chat sessions	ChatSession	None.

Response Formats

application/json, text/json

Sample:

{
  "PagedChatSessions": {
    "PageIndex": 1,
    "PageSize": 2,
    "TotalItems": 3,
    "TotalPages": 4,
    "Items": [
      {
        "SessionId": "sample string 1",
        "CreationDateUtc": "2025-06-08T01:24:03.9861387+02:00",
        "Messages": [
          {
            "Type": 0,
            "Date": "2025-06-08T01:24:04.0017602+02:00",
            "SenderProviderKey": "sample string 2",
            "SenderFullName": "sample string 3",
            "Text": "sample string 4"
          },
          {
            "Type": 0,
            "Date": "2025-06-08T01:24:04.0017602+02:00",
            "SenderProviderKey": "sample string 2",
            "SenderFullName": "sample string 3",
            "Text": "sample string 4"
          }
        ],
        "State": 0,
        "ChatLength": 1,
        "ConversationLength": 1,
        "GuestWaitingLength": 1,
        "GuestId": "sample string 3",
        "ChatProfile": {
          "Key": "f003506e-dc50-4e4c-939b-6d244d38ea51",
          "Name": "sample string 2"
        },
        "Form": {
          "Name": "sample string 1",
          "Email": "sample string 2",
          "Phone": "sample string 3",
          "CustomValues": [
            "sample string 1",
            "sample string 2"
          ]
        },
        "Connection": {
          "Ip": "sample string 1",
          "City": "sample string 2",
          "Region": "sample string 3",
          "Country": "sample string 4",
          "Longitude": 1.1,
          "Latitude": 1.1,
          "Postal": "sample string 5",
          "Browser": "sample string 6",
          "Os": "sample string 7"
        },
        "ChatHostInfos": [
          {
            "HostUrl": "sample string 1",
            "HostDocumentTitle": "sample string 2"
          },
          {
            "HostUrl": "sample string 1",
            "HostDocumentTitle": "sample string 2"
          }
        ],
        "Operators": [
          {
            "UserProviderKey": "sample string 1",
            "FullName": "sample string 2"
          },
          {
            "UserProviderKey": "sample string 1",
            "FullName": "sample string 2"
          }
        ],
        "UserProviderKey": "sample string 4",
        "CategoryItems": [
          {
            "Id": 1,
            "Name": "sample string 2"
          },
          {
            "Id": 1,
            "Name": "sample string 2"
          }
        ],
        "HostCustomData": {}
      },
      {
        "SessionId": "sample string 1",
        "CreationDateUtc": "2025-06-08T01:24:03.9861387+02:00",
        "Messages": [
          {
            "Type": 0,
            "Date": "2025-06-08T01:24:04.0017602+02:00",
            "SenderProviderKey": "sample string 2",
            "SenderFullName": "sample string 3",
            "Text": "sample string 4"
          },
          {
            "Type": 0,
            "Date": "2025-06-08T01:24:04.0017602+02:00",
            "SenderProviderKey": "sample string 2",
            "SenderFullName": "sample string 3",
            "Text": "sample string 4"
          }
        ],
        "State": 0,
        "ChatLength": 1,
        "ConversationLength": 1,
        "GuestWaitingLength": 1,
        "GuestId": "sample string 3",
        "ChatProfile": {
          "Key": "f003506e-dc50-4e4c-939b-6d244d38ea51",
          "Name": "sample string 2"
        },
        "Form": {
          "Name": "sample string 1",
          "Email": "sample string 2",
          "Phone": "sample string 3",
          "CustomValues": [
            "sample string 1",
            "sample string 2"
          ]
        },
        "Connection": {
          "Ip": "sample string 1",
          "City": "sample string 2",
          "Region": "sample string 3",
          "Country": "sample string 4",
          "Longitude": 1.1,
          "Latitude": 1.1,
          "Postal": "sample string 5",
          "Browser": "sample string 6",
          "Os": "sample string 7"
        },
        "ChatHostInfos": [
          {
            "HostUrl": "sample string 1",
            "HostDocumentTitle": "sample string 2"
          },
          {
            "HostUrl": "sample string 1",
            "HostDocumentTitle": "sample string 2"
          }
        ],
        "Operators": [
          {
            "UserProviderKey": "sample string 1",
            "FullName": "sample string 2"
          },
          {
            "UserProviderKey": "sample string 1",
            "FullName": "sample string 2"
          }
        ],
        "UserProviderKey": "sample string 4",
        "CategoryItems": [
          {
            "Id": 1,
            "Name": "sample string 2"
          },
          {
            "Id": 1,
            "Name": "sample string 2"
          }
        ],
        "HostCustomData": {}
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GetChatSessionsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedChatSessions>
    <Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
      <d3p1:ChatSession>
        <d3p1:CategoryItems>
          <d3p1:CategoryItemData>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Name>sample string 2</d3p1:Name>
          </d3p1:CategoryItemData>
          <d3p1:CategoryItemData>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Name>sample string 2</d3p1:Name>
          </d3p1:CategoryItemData>
        </d3p1:CategoryItems>
        <d3p1:ChatHostInfos>
          <d3p1:ChatHostInfo>
            <d3p1:HostDocumentTitle>sample string 2</d3p1:HostDocumentTitle>
            <d3p1:HostUrl>sample string 1</d3p1:HostUrl>
          </d3p1:ChatHostInfo>
          <d3p1:ChatHostInfo>
            <d3p1:HostDocumentTitle>sample string 2</d3p1:HostDocumentTitle>
            <d3p1:HostUrl>sample string 1</d3p1:HostUrl>
          </d3p1:ChatHostInfo>
        </d3p1:ChatHostInfos>
        <d3p1:ChatLength>1</d3p1:ChatLength>
        <d3p1:ChatProfile>
          <d3p1:Key>f003506e-dc50-4e4c-939b-6d244d38ea51</d3p1:Key>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:ChatProfile>
        <d3p1:Connection>
          <d3p1:Browser>sample string 6</d3p1:Browser>
          <d3p1:City>sample string 2</d3p1:City>
          <d3p1:Country>sample string 4</d3p1:Country>
          <d3p1:Ip>sample string 1</d3p1:Ip>
          <d3p1:Latitude>1.1</d3p1:Latitude>
          <d3p1:Longitude>1.1</d3p1:Longitude>
          <d3p1:Os>sample string 7</d3p1:Os>
          <d3p1:Postal>sample string 5</d3p1:Postal>
          <d3p1:Region>sample string 3</d3p1:Region>
        </d3p1:Connection>
        <d3p1:ConversationLength>1</d3p1:ConversationLength>
        <d3p1:CreationDateUtc>2025-06-08T01:24:03.9861387+02:00</d3p1:CreationDateUtc>
        <d3p1:Form>
          <d3p1:CustomValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d3p1:CustomValues>
          <d3p1:Email>sample string 2</d3p1:Email>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Phone>sample string 3</d3p1:Phone>
        </d3p1:Form>
        <d3p1:GuestId>sample string 3</d3p1:GuestId>
        <d3p1:GuestWaitingLength>1</d3p1:GuestWaitingLength>
        <d3p1:HostCustomData />
        <d3p1:Messages>
          <d3p1:ChatMessage>
            <d3p1:Date>2025-06-08T01:24:04.0017602+02:00</d3p1:Date>
            <d3p1:SenderFullName>sample string 3</d3p1:SenderFullName>
            <d3p1:SenderProviderKey>sample string 2</d3p1:SenderProviderKey>
            <d3p1:Text>sample string 4</d3p1:Text>
            <d3p1:Type>Common</d3p1:Type>
          </d3p1:ChatMessage>
          <d3p1:ChatMessage>
            <d3p1:Date>2025-06-08T01:24:04.0017602+02:00</d3p1:Date>
            <d3p1:SenderFullName>sample string 3</d3p1:SenderFullName>
            <d3p1:SenderProviderKey>sample string 2</d3p1:SenderProviderKey>
            <d3p1:Text>sample string 4</d3p1:Text>
            <d3p1:Type>Common</d3p1:Type>
          </d3p1:ChatMessage>
        </d3p1:Messages>
        <d3p1:Operators>
          <d3p1:ChatUser>
            <d3p1:FullName>sample string 2</d3p1:FullName>
            <d3p1:UserProviderKey>sample string 1</d3p1:UserProviderKey>
          </d3p1:ChatUser>
          <d3p1:ChatUser>
            <d3p1:FullName>sample string 2</d3p1:FullName>
            <d3p1:UserProviderKey>sample string 1</d3p1:UserProviderKey>
          </d3p1:ChatUser>
        </d3p1:Operators>
        <d3p1:SessionId>sample string 1</d3p1:SessionId>
        <d3p1:State>Missed</d3p1:State>
        <d3p1:UserProviderKey>sample string 4</d3p1:UserProviderKey>
      </d3p1:ChatSession>
      <d3p1:ChatSession>
        <d3p1:CategoryItems>
          <d3p1:CategoryItemData>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Name>sample string 2</d3p1:Name>
          </d3p1:CategoryItemData>
          <d3p1:CategoryItemData>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Name>sample string 2</d3p1:Name>
          </d3p1:CategoryItemData>
        </d3p1:CategoryItems>
        <d3p1:ChatHostInfos>
          <d3p1:ChatHostInfo>
            <d3p1:HostDocumentTitle>sample string 2</d3p1:HostDocumentTitle>
            <d3p1:HostUrl>sample string 1</d3p1:HostUrl>
          </d3p1:ChatHostInfo>
          <d3p1:ChatHostInfo>
            <d3p1:HostDocumentTitle>sample string 2</d3p1:HostDocumentTitle>
            <d3p1:HostUrl>sample string 1</d3p1:HostUrl>
          </d3p1:ChatHostInfo>
        </d3p1:ChatHostInfos>
        <d3p1:ChatLength>1</d3p1:ChatLength>
        <d3p1:ChatProfile>
          <d3p1:Key>f003506e-dc50-4e4c-939b-6d244d38ea51</d3p1:Key>
          <d3p1:Name>sample string 2</d3p1:Name>
        </d3p1:ChatProfile>
        <d3p1:Connection>
          <d3p1:Browser>sample string 6</d3p1:Browser>
          <d3p1:City>sample string 2</d3p1:City>
          <d3p1:Country>sample string 4</d3p1:Country>
          <d3p1:Ip>sample string 1</d3p1:Ip>
          <d3p1:Latitude>1.1</d3p1:Latitude>
          <d3p1:Longitude>1.1</d3p1:Longitude>
          <d3p1:Os>sample string 7</d3p1:Os>
          <d3p1:Postal>sample string 5</d3p1:Postal>
          <d3p1:Region>sample string 3</d3p1:Region>
        </d3p1:Connection>
        <d3p1:ConversationLength>1</d3p1:ConversationLength>
        <d3p1:CreationDateUtc>2025-06-08T01:24:03.9861387+02:00</d3p1:CreationDateUtc>
        <d3p1:Form>
          <d3p1:CustomValues xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d3p1:CustomValues>
          <d3p1:Email>sample string 2</d3p1:Email>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Phone>sample string 3</d3p1:Phone>
        </d3p1:Form>
        <d3p1:GuestId>sample string 3</d3p1:GuestId>
        <d3p1:GuestWaitingLength>1</d3p1:GuestWaitingLength>
        <d3p1:HostCustomData />
        <d3p1:Messages>
          <d3p1:ChatMessage>
            <d3p1:Date>2025-06-08T01:24:04.0017602+02:00</d3p1:Date>
            <d3p1:SenderFullName>sample string 3</d3p1:SenderFullName>
            <d3p1:SenderProviderKey>sample string 2</d3p1:SenderProviderKey>
            <d3p1:Text>sample string 4</d3p1:Text>
            <d3p1:Type>Common</d3p1:Type>
          </d3p1:ChatMessage>
          <d3p1:ChatMessage>
            <d3p1:Date>2025-06-08T01:24:04.0017602+02:00</d3p1:Date>
            <d3p1:SenderFullName>sample string 3</d3p1:SenderFullName>
            <d3p1:SenderProviderKey>sample string 2</d3p1:SenderProviderKey>
            <d3p1:Text>sample string 4</d3p1:Text>
            <d3p1:Type>Common</d3p1:Type>
          </d3p1:ChatMessage>
        </d3p1:Messages>
        <d3p1:Operators>
          <d3p1:ChatUser>
            <d3p1:FullName>sample string 2</d3p1:FullName>
            <d3p1:UserProviderKey>sample string 1</d3p1:UserProviderKey>
          </d3p1:ChatUser>
          <d3p1:ChatUser>
            <d3p1:FullName>sample string 2</d3p1:FullName>
            <d3p1:UserProviderKey>sample string 1</d3p1:UserProviderKey>
          </d3p1:ChatUser>
        </d3p1:Operators>
        <d3p1:SessionId>sample string 1</d3p1:SessionId>
        <d3p1:State>Missed</d3p1:State>
        <d3p1:UserProviderKey>sample string 4</d3p1:UserProviderKey>
      </d3p1:ChatSession>
    </Items>
    <PageIndex>1</PageIndex>
    <PageSize>2</PageSize>
    <TotalItems>3</TotalItems>
    <TotalPages>4</TotalPages>
  </PagedChatSessions>
</GetChatSessionsResult>