topicID

String

This parameter represents the id of the topic.

interactionID

String

This parameter represents the id of interaction.

segmentID

String

This parameter represents the id of segment.

customerID

String

This parameter represents the id of the customer.

{
    "topicID": "",
    "interactionID": "45191",
    "segmentID": "2",
    "customerID": "478"
}

errors

Array

An array of strings. Returns the error message if an error is encountered, otherwise a blank array if there is no error.

errorsDetails

Array

An array of strings. Provides detailed information about the error encountered, otherwise returns a blank array if no error is encountered.

interactionProperties

Array

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

caseProperties

Array

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

caseProperties[].name

String

This represents the name of the property.

caseProperties[].properties

Array

Array of Property details.see property data structure.

caseProperties[].logins

Number

This property has a list of objects with login details including name and type of property value.

caseProperties[].canModifyLogins

Boolean

This property represents rights of modification in logins.

quotedBody

String

attachments

Array

This has all the attachments which are added in interaction.

mailboxes

Array

This  has a list of saved mailboxes.

mailboxes[].Id

String

This returns the id of interaction.

mailboxes[].name

String

This represents the name of the property.

mailboxes[].replyTo

String

Email address of mailbox.

addresses

Array

All email addresses of users.

responsesAgent

Array

List of all default responses saved by Agent.

responsesAgent[].id

String

This returns the id of interaction.

responsesAgent[].name

String

This represents the name of the property.

responsesAgent[].description

String

Description about response.

responsesAgent[].bodyHtml

String

This is body content of message with html format

responsesSegment

Array

List of all default responses saved under segment.

responsesSegment[].id

String

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

responsesSegment[].name

String

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

responsesSegment[].description

String

Description about response.

responsesSegment[].bodyHtml

String

This is body content of message with html format

notifications

Array

List of all default notifications.

notifications[].id

String

This returns the id of interaction.

notifications[].name

String

This represents the name of the property.

notifications[].segmentID

String

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

notifications[].isSecuredNotification

Boolean

List of all default notifications.

{
  "errors": [],
  "errorDetails": [],
  "interactionProperties": [],
  "caseProperties": [
    {
      "name": "e-shop",
      "properties": [
        {
          "propertyID": "129",
          "name": "Date and Time Field",
          "isDate": false,
          "isDatetime": true,
          "isInteger": false,
          "isNumber": false,
          "allowMultiple": false,
          "hasDescriptions": false,
          "isMultiLine": false,
          "isReadOnly": false,
          "isRequired": false,
          "values": [],
          "valueChoices": [],
          "descriptionChoices": []
        }
      ],
      "logins": null,
      "canModifyLogins": false
    }
  ],
  "quotedBody": "<div>On 11/19/2021 3:36:41 AM, &quot;Customer Service&quot; &lt;demo-cc@1to1service.com&gt; wrote:<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">Quick Agent Email</blockquote></div>",
  "attachments": [],
  "mailboxes": [
    {
      "id": "1",
      "name": "Customer Service",
      "replyTo": "demo-cc@1to1service.com"
    }
  ],
  "addresses": [
    "niraj@1to1service.com",
    "nirajraba212@gmail.com"
  ],
  "responsesSegment": [
    {
      "id": "99",
      "name": "_template",
      "description": "",
      "bodyHtml": "$stock -id'44'$ <br />\r\n<br />\r\n{enter your response here}<br />\r\n<br />\r\n$stock -id'17'$"
    }
  ],
  "responsesAgent": [
    {
      "id": "146",
      "name": "testing stock res",
      "description": "testing stock res",
      "bodyHtml": "testing stock res"
    }
  ],
  "notifications": [
    {
      "id": "1",
      "name": "Account Creation",
      "segmentID": "2",
      "isSecureNotification": false
    }
  ]
}