GET api/v1/Chat/Agents/{AgentID}/Users

Retrieves the array of agent contacts for the currently logged in agent.

Request Information

Parameters

NameDescriptionAdditional information
AgentID 
No documentation available.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample: 
[
  {
    "ContactID": 1,
    "AgentID": 2,
    "AddressBookID": 3,
    "AgentName": "sample string 4",
    "ContactType": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "JobTitle": "sample string 8",
    "ContactNumber": "sample string 9",
    "Online": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  },
  {
    "ContactID": 1,
    "AgentID": 2,
    "AddressBookID": 3,
    "AgentName": "sample string 4",
    "ContactType": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "JobTitle": "sample string 8",
    "ContactNumber": "sample string 9",
    "Online": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  },
  {
    "ContactID": 1,
    "AgentID": 2,
    "AddressBookID": 3,
    "AgentName": "sample string 4",
    "ContactType": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "JobTitle": "sample string 8",
    "ContactNumber": "sample string 9",
    "Online": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfAgentChatContactDTO>
  <AgentChatContactDTO>
    <ContactID>1</ContactID>
    <AgentID>2</AgentID>
    <AddressBookID>3</AddressBookID>
    <AgentName>sample string 4</AgentName>
    <ContactType>sample string 5</ContactType>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <JobTitle>sample string 8</JobTitle>
    <ContactNumber>sample string 9</ContactNumber>
    <Online>sample string 1</Online>
    <Online>sample string 2</Online>
    <Online>sample string 3</Online>
  </AgentChatContactDTO>
  <AgentChatContactDTO>
    <ContactID>1</ContactID>
    <AgentID>2</AgentID>
    <AddressBookID>3</AddressBookID>
    <AgentName>sample string 4</AgentName>
    <ContactType>sample string 5</ContactType>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <JobTitle>sample string 8</JobTitle>
    <ContactNumber>sample string 9</ContactNumber>
    <Online>sample string 1</Online>
    <Online>sample string 2</Online>
    <Online>sample string 3</Online>
  </AgentChatContactDTO>
  <AgentChatContactDTO>
    <ContactID>1</ContactID>
    <AgentID>2</AgentID>
    <AddressBookID>3</AddressBookID>
    <AgentName>sample string 4</AgentName>
    <ContactType>sample string 5</ContactType>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <JobTitle>sample string 8</JobTitle>
    <ContactNumber>sample string 9</ContactNumber>
    <Online>sample string 1</Online>
    <Online>sample string 2</Online>
    <Online>sample string 3</Online>
  </AgentChatContactDTO>
</ArrayOfAgentChatContactDTO>