POST Agents/Chat/GetChatTopicUserAgentList

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Chat/GetChatTopicUserAgentList

Get list of users assigned to a chat topic

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/Chat/GetChatTopicUserAgentList?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

ChatTopicId

Property Name Type Description
ChatTopicId Integer

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
TopicId int32 The reference to the associated chat topic.
User Associate The associate that is the user agent.
CanListen bool True of a user can listen in on this topic
CanRespond bool True if the user can respond to chats in this topic
CanManage bool True if the user is a manager for this topic
CanNotify bool True if the user should receive notifications for this topic

Sample request

POST /api/v1/Agents/Chat/GetChatTopicUserAgentList
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "ChatTopicId": 835
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "TopicId": 426,
    "User": null,
    "CanListen": false,
    "CanRespond": true,
    "CanManage": true,
    "CanNotify": false
  },
  {
    "TopicId": 426,
    "User": null,
    "CanListen": false,
    "CanRespond": true,
    "CanManage": true,
    "CanNotify": false
  }
]