fields

Object

Object containing the search groups that are logically combined with an AND operator.

fields[].groups

Array

An array of fields that are grouped together with an AND operator.

fields[].groups[].fields

Array

This parameter contains the object of search fields with search parameters/values.

fields[].groups[].fields[].fieldID

String

This parameter represents how to compare search values like anywhere or start or end or entire.

fields[].groups[].fields[].searchString

String

This parameter represents the field name to compare with search values.

fields[].groups[].fields[].where

String

This parameter represents search value.

pageNum

Boolean

This parameter represents current page no.

perPage

Boolean

This parameter represents how many records we want in one page.

_pageAction

String

This parameter represents the action name which is performed from the page.

_pageName

String

This parameter represents the page name.

{
  "fields": {
    "groups": [
      {
        "fields": [
          {
            "fieldID": "status",
            "searchString": "Unassigned",
            "where": "anywhere"
          },
          {
            "fieldID": "status",
            "searchString": "Queued",
            "where": "anywhere"
          },
          {
            "fieldID": "status",
            "searchString": "Pending",
            "where": "anywhere"
          }
        ]
      }
    ]
  },
  "pageNum": 0,
  "perPage": 2500,
  "_pageAction": "ManagemessageTopics",
  "_pageName": "manage#/messagestree"
}

Interaction

Array

This returns a list of objects with all interaction details.

Interaction[].id

String

This returns the id of interaction.

Interaction[].subject

String

This returns the subject of interaction.

Interaction[].subjectBare

String

The subject without the reference number prepended.

Interaction[].date

String

This returns the date of interaction.

Interaction[].topicID

String

This has the value of topic id in which interaction belongs to.

Interaction[].topicName

String

This has the value of the topic name in which interaction belongs to.

Interaction[].rating

String

The user rating for the article on a scale of 1 to 5.

Interaction[].viewCount

String

This has a total view count of interaction.

Interaction[].costumerID

String

This returns the id of the customer.

Interaction[].costumerName

String

This returns the name of the customer.

Interaction[].fromAddress

String

Email address who has initiated the interaction.

Interaction[].agentName

String

This has an email address who has initiated the interaction.

Interaction[].assignedToID

String

This has the value of an agent who has been assigned to this interaction.

Interaction[].type

String

This is a type of interaction like Agent Email or Note or Ticket.

Interaction[].tags

String

Tags are used to label interactions for special display. For example, open quote tickets contain a tag to mark for display in the Open Quotes pages.

Interaction[].status

String

This is the status value of interaction according to interaction type.

Interaction[].segmentName

String

This has all the attachments which are added in interaction.

Interaction[].properties

Array

This returns all properties and their values if property value set in interaction.

responsesAll

Array

This returns a question's row and details data.

responsesAll[].id

String

This is Interaction id.

responsesAll[].segmentID

String

This has the value of the segment id in which the question belongs to.

responsesAll[].name

String

This represents the name of the property .

responsesAll[].description

String

Description about the response.

responsesAll[].bodyHtml

String

The body of the interaction created.

responsesAgent

Array

List of all default responses saved by Agent.

{
  "Interaction": [
    {
      "id": "45550",
      "subject": "[ref#: 45550-45550] Can I pay with any credit card?",
      "subjectBare": "Can I pay with any credit card?",
      "date": "2021-10-28T20:31:22.3770000Z",
      "topicID": "40",
      "topicName": "Televisions",
      "rating": "0.0",
      "viewCount": "0",
      "customerID": "156",
      "customerName": "John Bastion",
      "fromAddress": "customer8@1to1service.com",
      "agentName": "Service Manager",
      "assignedToID": "2",
      "type": "Ask A Question",
      "tags": [],
      "status": "Queued",
      "segmentName": "e-shop",
      "Properties": []
    }
  ],
  "responsesAll": [
    {
      "1": [],
      "2": [
        {
          "id": "99",
          "segmentID": "2",
          "name": "__Template",
          "description": "",
          "bodyHtml": ""
        }
      ],
      "9": [],
      "13": []
    }
  ],
  "responsesAgent": []
}